Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.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.  

Info

This API supports operation with the following Providers:

  • ServiceDispatch
  • ServiceScheduling
Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Retrieve a Work Item

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

Delete a Work Item

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

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specific Parameters

ParameterTypeRequired?Description

${WorkItemId}

string

Yes

The unique string ID value for the Work Item.


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default Response
_Default Response

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default Response
_Default Response