Resources

name path methods description
AccessControlFlowsResource
  • /change-sets/{csId}/access-control-flows/{name}
  • /change-sets/{csId}/access-control-flows
  • GET, PUT
  • POST
A RESTful resource for accessing control-flows. Supports operations such as importing and exporting control flows.
ActivityTypeResource
  • /change-sets/{csId}/activity-types
  • /change-sets/{csId}/activity-types/fastkey/{fastkey}
  • GET, POST, PUT
  • GET
A REST Web Service for managing Activity Types.
AppTriggersResource
  • /change-sets/{csId}/app-triggers
  • /change-sets/{csId}/app-triggers/{atId}
  • GET, POST
  • GET
RESTful resource for managing application triggers.
ChangeSetBundleResource
  • /change-set-bundles/{id}/remove-change-set/last
  • /change-set-bundles/{bundle}
  • /change-set-bundles/{id}/remove-change-set
  • /change-set-bundles/{bundleId}/deployment
  • /change-set-bundles
  • /change-set-bundles/{id}/append-change-set/{changesetid}
  • /change-set-bundles/{id}/remove-change-set/{changeSetId}
  • /change-set-bundles/{bundleId}/deployment/pipelines/{pipe}/environments/{env}
  • /change-set-bundles/{id}
  • /change-set-bundles/{id}/append-change-set
  • PUT
  • GET
  • PUT
  • POST, PUT
  • GET, POST
  • PUT
  • PUT
  • DELETE
  • DELETE, PUT
  • PUT
A REST Web Service for managing changesets and user sessions.
ChangeSetResource
  • /change-sets
  • /change-sets/{id}/diffs
  • /change-sets/{id}/diffs/env/{envId}
  • /change-sets/{id}/deployments
  • /change-sets/name/{name}
  • /change-sets/{id}
  • /change-sets/{id}/diff/{type}/{resourceUrl}/{name}
  • /change-sets/sp/{spId}
  • /change-sets/{branchOne}/diffs/{branchTwo}
  • /change-sets/{id}/copy
  • GET, POST
  • GET
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • DELETE
  • POST
  • GET
  • POST, PUT
A REST Web Service for managing changesets and user sessions.
DeploymentsResource
  • /pipelines/{pipe}/environments/{env}/deployments/{csid}
  • /pipelines/{pipe}/environments/{env}/deployments
  • DELETE, GET, PUT
  • GET, POST
A RESTful resource for managing change set deployments. Note: the root-resource path specifies the pipeline ID and environment ID.
EdrResource
  • /edr-service/edrFields/{csId}
  • /edr-service/edrField
  • /edr-service/edrField/{csId}/{parentId}/{id}
  • GET
  • POST, PUT
  • DELETE, GET
A RESTful Web Service for managing edr config data.
EnvironmentsResource
  • /environments/{id}
  • /environments/{id}/latest-deployed
  • /environments
  • /environments/name/{name}
  • DELETE, GET, PUT
  • GET
  • GET, POST
  • GET
A RESTful resource for managing environments.
ExternalConceptsResource
  • /external-concepts/{csId}/{conceptId}
  • /external-concepts/{csId}/{id}
  • /external-concepts/{csId}
  • /external-concepts/{csId}/type/{type}
  • DELETE
  • PUT
  • GET, POST
  • GET
A REST Web Service for managing External Concepts.
PipelineEnvironmentsResource
  • /pipelines/{pipe}/environments
  • /pipelines/{pipe}/environments/{env}/previous/{prevenv}
  • /pipelines/{pipe}/environments/{env}
  • GET
  • POST
  • DELETE, GET, POST
A RESTful resource for managing pipeline environments. Note: the root-resource path specifies the pipeline ID.
PipelinesResource
  • /pipelines/{id}
  • /pipelines/name/{name}
  • /pipelines
  • DELETE, GET, PUT
  • GET
  • GET, POST
A RESTful resource for managing pipelines.
SchemaResource
  • /change-sets/{csId}/schemas/{name}
  • DELETE, GET, POST, PUT
REST Resource for creating schema definitions, such as JSON/XML schemas.
SdcPolicyResource
  • /policy/principal-in-role/{principal}/{role}
  • /policy/permissions
  • DELETE, POST
  • GET
The SDC application policy resource. Wraps the base OCECAS policy resource (which resides in common). Provides RESTful services that rely on access to SDC services and persistence stores not accessible from common.
SdcUserResource
  • /session
  • DELETE, GET, POST, PUT
A REST Web Service for authenticating SDC REST API users. User who wish to perform other SDC REST operations must authenticate themselves by POSTing to the /session URL.

When the /session URL is POSTed to (with an empty body message) and the user has not already been authenticated then the user will be asked for their username and password. WebLogic authenticates the user based on the username and password and sends back a cookie representing the authenticated session. This cookie must be used in all subsequent REST operations to authenticate the user.

To logout of the session send a DELETE to the /session URL.

ServiceConfigurationResource
  • /services/{serviceProvider}/env/{envId}
  • /services/{serviceProvider}/env/{envId}/change-set/{csId}
  • GET
  • GET
A REST resource for presenting a pure view of service configuration to the UI. Able to assemble the required view data from various sources such as service data, change set and control flows. Much of this information is retrieved from service data, but some is obtained from an analysis of control flows, including the resources they access and the linked control flows they invoke (directly or indirectly). We prefer to hide all this considerable complexity from the JavaScript client, while creating the opportunity for the information to be used other clients in the future.
ServiceDataObjectResource
  • /change-sets/{csId}/service-data-objects/{objectType}/{objectGroup}
  • /change-sets/{csId}/service-data-objects/{objectType}/{objectGroup}/{objectName}
  • /change-sets/{csId}/service-data-objects/{objectType}
  • /change-sets/{csId}/service-data-objects/{objectType}/{objectGroup}/{objectName}/buildStatus
  • GET
  • DELETE, GET, POST, PUT
  • GET
  • GET
A REST Web Service for managing service data objects.
ServiceDataResource
  • /change-sets/{csId}/service-data/addToArray
  • /change-sets/{csId}/service-data
  • /change-sets/{csId}/service-data/delete
  • /change-sets/{csId}/service-data/dependencies
  • /change-sets/{csId}/service-data/rename
  • PUT
  • GET, POST, PUT
  • PUT
  • GET
  • PUT
A REST Web Service for managing External Concepts.
StatisticsResource
  • /statistics/records/{csId}/id/{refId}
  • /statistics/records/interval/{start}/{end}/{domain}
  • /statistics/definitions/{csId}/name/{name}
  • /statistics/definitions/{csId}
  • /statistics/records
  • /statistics/records/interval/{start}/{end}
  • /statistics/definitions/{csId}/{refId}
  • /statistics/definitions/{csId}/{id}
  • /statistics/records/name/{name}
  • GET
  • GET
  • GET
  • GET, POST
  • GET
  • GET
  • DELETE, GET
  • PUT
  • GET
A REST Web Service for managing Statistics and Stats Definitions.
TelemetryResource
  • /telemetry/records/name/{name}
  • /telemetry/records
  • /telemetry/records/interval/{start}/{end}/{domain}
  • /telemetry/records/interval/{start}/{end}
  • GET
  • GET
  • GET
  • GET
A REST Web Service for retrieving Telemetry entries.
WSDLResource
  • /wsdl/{csId}
  • POST
A REST Web Service for managing WSDL imports.