Retrieve A list Of WorkItem.
Retrieve a list of WorkItem.
Request
URI
GET
https://{api_host}/work-item-service/api/workitems/{id}/children
COPY
Path Parameters
string
id
Required
The workitem id.
Query Parameters
integer
page
Optional
Page Number
integer
limit
Optional
Number of entries per page
string
$orderby
Optional
Multiple comma-separated properties sorted in ascending or descending order
integer
$top
Optional
Sets the number of returned entries from the top of the response (total number per page in relation to skip)
integer
$skip
Optional
Sets how many entries you would like to skip
string
$filter
Optional
Boolean expression for whether a particular entry should be included in the response
Responses
200
successful operation
Returns PageWorkItem of type(s) */*
{
"number": 0,
"size": 0,
"last": false,
"numberOfElements": 0,
"totalPages": 0,
"content": [
{
"assignedDate": "string",
"availableActions": [
{
"stateNameId": "string",
"stateName": "string",
"name": "string",
"icon": {
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
},
"id": "string"
}
],
"workItemNumber": 0,
"workItemType": {
"pluralizedName": "string",
"commentsField": "string",
"completeByEmail": false,
"listView": {
"columns": [
{
"filterable": false,
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": false
}
],
"defaultSequence": [
"string"
]
},
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string",
"actions": [
{
"stateNameId": "string",
"stateName": "string",
"name": "string",
"icon": {
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
},
"id": "string"
}
],
"version": 0,
"forms": {}
},
"assignedOrCompletedDate": "string",
"assignees": [
{
"displayName": "string",
"principalId": "string",
"principalType": "string"
}
],
"workItemRequest": {
"itemId": "string",
"itemName": "string",
"itemRequestor": "string",
"itemData": {
"entries": [
{
"key": "string"
}
]
},
"itemCost": "number",
"itemDescription": "string"
},
"version": 0,
"completedDate": "string",
"subTenantId": "string",
"createdDate": "string",
"formUrl": "string",
"tenantId": "string",
"id": "string",
"serviceId": "string",
"completedBy": "string",
"callbackEntityId": "string",
"status": "string"
}
],
"first": false,
"totalElements": 0
}integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
Work Item Operations
POST
Cancel the specified WorkItem.
POST
Complete A WorkItem.
POST
Completes the WorkItem If It Is still active.
POST
Create A new WorkItem for the given service.
PUT
Create A set Of WorkItems
DELETE
Delete the WorkItem corresponding To the given id.
GET
Retrieve A list Of WorkItem.
GET
Retrieve A list Of WorkItem.
POST
Retrieve A set Of form data for the specified workItem and formElement.
GET
Retrieve the details Of the given WorkItem.
GET
Retrieve the WorkItem Form from for the selected WorkItem from the corresponding Service Provider.
POST
Retrieves the metadata Of multiple dynamic elements In single call. It combines the retrieval Of element's ElementState and the list Of permissible values for each element.
PUT
Update the WorkItem which corresponds To the given Id.