API Reference and Endpoints

The self-service REST interface supports the following HTTP or HTTPS methods:

• GET - Reads an existing resource.

• POST - Creates a resource or updates an existing resource.

Authorization

Authorization to the Self-Service Console is granted through an OAuth 2.0 and a token must be acquired through a Grant that specifies the following scope:

• urn::ohi-selfservice-console

For more information on how to register an OAUTH 2.0 client, refer to Create a Confidential Application in Identity Cloud Services.

Resource Identifier

The resource identifier is expressed by a URI with the following format:

<scheme>://<app-deployment-name>/<applicationComponent>/console/<apiName>/<resource path>

Parameter	Description
scheme	The Application protocol, for example, HTTP and HTTPS.
app-deployment-name	The name of the application in which the component is deployed. For example, dev1.
applicationComponent	The name of the application component providing the resource. For example,claims.
apiName	The name of the API. For example, workRequest.
resourcePath	The resource name and a unique Id. For example, /checkpoint/list.

Endpoints

The following self-services endpoints are available:

Method	Endpoint	Description
POST	/workRequest/create/checkpoint	Creates a new checkpoint in which it saves the state of an environment at a specific point.
GET	/checkpoint/list	Returns all the available checkpoints for all components in a given service instance.
GET	/workRequest/cancel/{uuid}	Cancels a work request.
GET	/workRequest/confirm/{uuid}	Confirms and runs an existing work request.
GET	/workRequest/{uuid}	Retrieve the status of the existing work request.
POST	/workRequest/create/clone	Clone the existing environment from a specified checkpoint.
POST	/workRequest/create/reset	Reset the test environment into its default state.
POST	/workRequest/create/restart	Restart the application and administrator server.
POST	/workRequest/create/deletecheckpoint	Delete an existing checkpoint.
GET	workRequest/list	Retrieve a list of work requests