Publisher REST API Documentation Generated By Swagger | 9 April 2015

All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Access to the API requires client-id and client secret.

Methods

get: /api/v1/messages

getAllMessages View all messages in the inbox.

Parameters

search (optional)
Query Parameter — The search value.

Return type

array[Message]
get: /api/v1/messages/{messageId}

getMessageById View the details of a specific message in the inbox.

Parameters

messageId (required)
Path Parameter — The id of the message.

Return type

Message
delete: /api/v1/messages/{messageId}

deleteMessage Deletes a specific message from the inbox.

Parameters

messageId (required)
Path Parameter — The id of the message.

Return type

void
get: /api/v1

get View Publisher REST API entry point and exposed available resources.

Parameters

body (optional)
Body Parameter — request

Return type

Api
get: /api/v1/environments

getEnvironments View a list of all relevant environments.

Parameters

Return type

array[Environment]
get: /api/v1/environments/{environmentName}

getEnvironment View the details of a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the environment.

Return type

Environment
get: /api/v1/environments/{environmentName}/exports

getExports View a list of all relevant exports on a specific environment. This list is empty for a studio environment.

Parameters

environmentName (required)
Path Parameter — The name of the database environment.

Return type

array[Export]
get: /api/v1/environments/{environmentName}/exports/{exportId}

getExport View the details of a specific export on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the database environment.
exportId (required)
Path Parameter — The id of the export.

Return type

Export
get: /api/v1/environments/{environmentName}/repositories

getRepositories View a list of repositories on a specific environment. This list is empty for a database environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.

Return type

array[Repository]
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}

getRepository View the details of a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.

Return type

Repository
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches

getBranches View a list of all branches in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.

Return type

array[Branch]
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches/{branchName}

getBranch View the details of a specific branch in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.
branchName (required)
Path Parameter — The name of the branch.

Return type

Branch
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches/{branchName}/revisions

getRevisions View a list of all revisions in a specific branch, in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.
branchName (required)
Path Parameter — The name of the branch.

Return type

array[Revision]
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches/{branchName}/revisions/{revisionId}

getRevision View the details of a specific revision in a specific branch, in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.
branchName (required)
Path Parameter — The name of the branch.
revisionId (required)
Path Parameter — The id of the revision.

Return type

Revision
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches/{branchName}/revisions/{revisionId}/projects

getProjects View a list of all projects with a specific revision, in a specific branch, in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the studio environment.
repositoryName (required)
Path Parameter — The name of the repository.
branchName (required)
Path Parameter — The name of the branch.
revisionId (required)
Path Parameter — The id of the revision.

Return type

array[Project]
get: /api/v1/environments/{environmentName}/repositories/{repositoryName}/branches/{branchName}/revisions/{revisionId}/projects/{projectName}

getProject View the details of a project with a specific revision, in a specific branch, in a specific repository on a specific environment.

Parameters

environmentName (required)
Path Parameter — The name of the environment.
repositoryName (required)
Path Parameter — The name of the repository.
branchName (required)
Path Parameter — The name of the branch.
revisionId (required)
Path Parameter — The id of the revision.
projectName (required)
Path Parameter — The name of the project.

Return type

Project
get: /api/v1/publications

getPublications View a list of all publications.

Parameters

search (optional)
Query Parameter — The search value.

Return type

array[Publication]
put: /api/v1/publications

updatePublications Approve or reject multiple publication in one batch.

Parameters

body (optional)
Body Parameter — The list of publications.

Return type

void
post: /api/v1/publications

createPublication Perform a single publication.

Parameters

body (optional)
Body Parameter — The publication object.

Return type

Publication
get: /api/v1/publications/{publicationId}

findPublicationById View the details of a specific publication.

Parameters

publicationId (required)
Path Parameter — The id of the publication.

Return type

Publication
put: /api/v1/publications/{publicationId}

updatePublication Approve or reject a specific publication.

Parameters

publicationId (required)
Path Parameter — The id of the publication.
body (optional)
Body Parameter — The publication object.

Return type

void

Models

Environment

name
String The name of the environment
requiresApproval
Boolean Flag that indicates if pulbishing on this environment required approval
uncommitedChangesAllowed
Boolean Flag that indicates if uncommited changes of a project can be exported on this environment
links
List

Branch

name
String The name of the branch
repository
String The name of the repository which includes the branch
links
List

Link

rel
String
href
String

Message

message
String The message content
source
String The name of the source environmnet from where the action was performed
version
String The version of the project
destination
String The name of the destination environmnet of the actuin that was performed
tags
List Tag/Tags that are associated to the project export contained in this message
project
String The name of the project
revision
String The revision of the project
actionType
String The type of action that this message was created for
sender
String The username of the sender of the message
receiver
String The username of the receiver of the message
messageDate
Date The date when the message was sent
isRead
Boolean Flag that indicates if the message is read or not read yet
actionResult
String The action result that this message was created for
id
Integer The id of the message
links
List

Repository

name
String The name of this repository
links
List

Void

Api

version
Integer Publisher REST API version
links
List

Publication

links
List
comment
String Publication comment
version
String The project version, if the publication is not performed from studio
status
String The status of the publication
username
String Username of the user that created the publcation action
tags
List Tag/Tags that are associated to the publication project/export
sourceEnvironment
String The source/lcoation environment defined in this publication
project
String The project name, if the publication is not performed from studio
revisionId
String The revision id of the export, if the publication is not performed from studio
action
String The action for which this publication was created
id
Integer The id of the publication
destinationEnvironment
String The destination environment defined in this publication
exportDate
Date The export date
exportId
String The export id
projectId
ProjectId The composed project id, id the publication is performed from studio
isWorkingRevision
Boolean Flag that indicates if the export is a working revision or not

Revision

tags
List Tag/Tags that are associated to this revision
branch
String The name of the branch which includes this revision
repository
String The name of the repository which includes this revision
revisionId
String The id of this revision
isWorkingRevision
Boolean The flag that indicate if this revision is a woking revision
links
List

Project

name
String The name of the project
branch
String The name of the branch which includes the project
repository
String The name of the repository which includes the project
revisionId
String The id of the revision which includes the project
links
List

NewPublication

links
List
comment
String Publication comment
sourceEnvironment
String The source/location environment defined in this publication
action
String The action for which this publication was created
destinationEnvironment
String The destination environment defined in this publication
exportId
String The export id, if the source environment is database
projectId
ProjectId The composed project id, if the source environment is studio

ProjectId

repository
String
branch
String
project
String
revisionId
String

Export

location
String The location/source environment of the export
comment
String Additional comment of this export
version
String The version of the export
username
String The username
tags
List Tag/Tags that are associated to this export
workingRevision
Boolean
project
String The project name
revision
String The revision of the export
exportDate
Date The date of export
id
String The id of the export
links
List