ChangeSetResource
A REST Web Service for managing changesets and user sessions.
The following resources are applicable:
- /change-sets
- /change-sets/{branchOne}/diffs/{branchTwo}
- /change-sets/{id}
- /change-sets/{id}/deployments
- /change-sets/{id}/diff/{type}/{resourceUrl}/{name }
- /change-sets/{id}/diffs
- /change-sets/{id}/diffs/env/{envId}
- /change-sets/name/{name}
- /change-sets/sp/{spId}
/change-sets
Mount Point: /change-sets
POST
Creates the given change set for later use.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The unique session ID of the compilation whose messages are required | cookie |
Request Body
element: | changeSet |
media types: | application/xml text/xml application/json |
The change set object to use when creating the new change set. For now we only care about the name and description in this object.
Response Body
element: | changeSet |
media types: | application/xml text/xml application/json |
A change set object, whose name can be used by other RESTful interactions to identify the active change set
GET
Gets the list of currently available change sets.
Response Body
element: | changeSets |
media types: | application/xml text/xml application/json |
The list of change sets visible to this session
/change-sets/{branchOne}/diffs/{branchTwo}
Mount Point: /change-sets/{branchOne}/diffs/{branchTwo}
GET
Gets the list of conflicts between two series of change sets (branches).
The branches are expressed as a hyphen-delimited series of change set ids, for example, 12-7-2-0. The first entry is assumed to be the top-most-deployed entry - the others are assumed to be linked via baseline contiguously, but can be specified in any order. The reason for the special meaning inherent in the first entry is that we need to be able to set a sensible value for the 'active change set' in order to prime the various views we need to access - they all depend on a correct current definition of the special 'active_change_sets' view.
Parameters
name | description | type | default |
---|---|---|---|
branchOne | The first branch to query | path | |
branchTwo | the second branch to query | path |
Response Body
element: | differences |
media types: | application/xml text/xml application/json |
The list of conflicting differences between the two branches.
/change-sets/{id}
Mount Point: /change-sets/{id}
The following operations are supported on this resource:
GET
Get the given change set by ID.
Parameters
name | description | type | default |
---|---|---|---|
id | The ID of the change set to retrieve. | path |
Response Body
element: | changeSet |
media types: | application/xml text/xml application/json |
The named change set.
PUT
Updates the named change set with the provided values.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The unique session ID of the compilation whose messages are required | cookie | |
id | The ID of the change set to updated | path |
Request Body
element: | changeSet |
media types: | application/xml text/xml application/json |
The updated change set information
Response Body
element: | changeSet |
media types: | application/xml text/xml application/json |
The newly modified change set
DELETE
Deletes the named change set.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The session of the user performing the update | cookie | |
id | The id of the change set to delete | path |
Response Body
element: | (custom) |
media types: | application/xml text/xml application/json |
200 on success, 404 on error
/change-sets/{id}/deployments
Mount Point: /change-sets/{id}/deployments
GET
Get the deployment of the given change set by ID.
Parameters
name | description | type | default |
---|---|---|---|
id | The ID of the change set to retrieve | path |
Response Body
element: | deployments |
media types: | application/xml text/xml application/json |
The deployments of the named change set
/change-sets/{id}/diff/{type}/{resourceUrl}/{name }
Mount Point: /change-sets/{id}/diff/{type}/{resourceUrl}/{name }
DELETE
Reverts the change from a specified change set.
Note: we originally wrote this more simply with a difference object in the DELETE payload, but it turns out that DELETE operations should not carry payload, so we must obtain our information purely from the URI. (A consequence is that we need the PMD override for UseObjectForClearerAPI).
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The session of the user performing the update | cookie | |
id | The id of the change set to delete | path | |
type | The type of difference; available values include ControlFlow, EDRField, ExternalConcept, Schema, ServiceData, and Statistic. | path | |
resourceUrl | The ID of the object changed in the difference, for example, 22 | path | |
name | The name of the difference, for example, Flow56 | path |
Response Body
element: | (custom) |
media types: | application/xml text/xml application/json |
The PIDs of flows (if any) that were recompiled as result
/change-sets/{id}/diffs
Mount Point: /change-sets/{id}/diffs
GET
Gets the list of differences for a given change set. When provided with a change set, return the list of control flows either added or compiled as part of that change set.
Parameters
name | description | type | default |
---|---|---|---|
id | The change set to query. | path |
Response Body
element: | differences |
media types: | application/xml text/xml application/json |
The list of differences attached to the change set.
/change-sets/{id}/diffs/env/{envId}
Mount Point: /change-sets/{id}/diffs/env/{envId}
GET
Gets the list of conflicts that would exist if this change set were to be deployed to the top of this environment. This is intended to be used to establish what conflicts might arise from the deployment of a change set on something other than its original design base.
Parameters
name | description | type | default |
---|---|---|---|
id | The change set to query | path | |
envId | The environment we're targeting. | path |
Response Body
element: | differences |
media types: | application/xml text/xml application/json |
The conflicts arising from a deployment of this change set on a baseline other than its design base.
/change-sets/name/{name}
Mount Point: /change-sets/name/{name}
GET
Gets the given change set by Name.
Parameters
name | description | type | default |
---|---|---|---|
name | The Name of the change set to retrieve | path |
Response Body
element: | changeSet |
media types: | application/xml text/xml application/json |
The named change set
/change-sets/sp/{spId}
Mount Point: /change-sets/sp/{spId}
POST
Set current service provider (into SDC session).
Parameters
name | description | type | default |
---|---|---|---|
spId | The service provider to set. | path |