Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 14 Current »

5.0.0

The Work Item REST APIs provide the capability to manage Work Items, once they have been created by using the REST Work Item Appointment Book.     

This API supports operation with the following Providers:

  • ServiceDispatch
  • ServiceScheduling

On this page:

Related pages:

Resource URL Summary

Retrieve a Work Item

GET /up/v5/workItem/${WorkItemId}

Delete a Work Item

DELETE /up/v5/workItem/${WorkItemId}

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specific Parameters

ParameterTypeRequired?Description

${WorkItemId}

string

Yes

The unique string ID value for the Work Item.

API Specifics

Retrieve a Work Item

This REST API requires a valid Work Item ID value in the URL, and will return the corresponding Work Item.

URL

GET /up/v5/workItem/${WorkItemId}

HTTP Request Body

This request does not require a request body. 

HTTP Response

Success

On success, an HTTP response code of 200 will be returned, and the response body will contain a Work Item object.

Error

Otherwise, on error, the API will:

  • Return an HTTP response code of 400, if the request was invalid;
  • Return an HTTP response code of 401, if the request was not authorized; or
  • Return an HTTP response code of 500, if something else went wrong.

Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.

Delete a Work Item

This REST API requires a valid Work Item ID value in the URL, and will delete the corresponding Work Item.+

URL

DELETE /up/v5/workItem/${WorkItemId}

HTTP Request Body

This request does not require a request body. 

HTTP Response

Success

On success, an HTTP response code of 200 will be returned.

Error

Otherwise, on error, the API will:

  • Return an HTTP response code of 400, if the request was invalid;
  • Return an HTTP response code of 401, if the request was not authorized; or
  • Return an HTTP response code of 500, if something else went wrong.

Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.

  • No labels