Work item APIs
Companies that own or link to Agile Process Teams use these APIs to add, update, and complete tasks. Tasks are based on pre-defined task templates, which determine the default values that populate for the task, any sub-tasks that automatically generate, and the extent to which the task can be modified by users.
Tasks are split into one or more sub-tasks, which are smaller, assignable portions of work that are completed as part of of the parent task. Sub-tasks are attached to tasks and managed by separate APIs.
Add Work item
Owners and Partners use this API to add a new work item to the Owner's company network, including any initial comments or file attachments. The response returns a generated identifier for the new work item.
New tasks are assigned the Draft base state by default.
Contact your TraceLink Services representative for more information about using this API.
Add Work item request
Example
Copy
mutation WorkItemNew {
workItem {
new(
input: {
item: {
payload: {
subType: ""
id: ""
currentBaseState: "Draft"
data: {
assigneeCompany: {
primaryIdentifierValue: "2054051864409"
primaryIdentifierType: "GLN"
businessName: "QAPartnerCorp1202409240834280621"
}
comments: [
{
commentText: "comment",
attachments: [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/item/2651a7ca-b580-4dda-9ca5-345ab34eefb1\",\"fileStatus\":\"UPLOADED\"}"
]
}]
workItemTitle: "Added by partner - edit"
dueDate: 1735637460000
}
}
objectAction: "CREATE"
}
}
) {
businessObjectTypeName
businessObjectIdentifier
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"new": {
"businessObjectTypeName": "workItem",
"businessObjectIdentifier": "6dc4a540-f90f-4b1e-9e80-4f113198843e",
"updated": null,
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "WorkItemMutationOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Edit Work item
Owners and Partners use this API to modify an existing work item with new, updated, or corrected information (e.g. adding a description, updating the assignee company details, fixing a typo) and to update the workflow state (e.g. manually transitioning the base state from Draft to ToDo to indicate that the work assigned in the work item has started).
Contact your TraceLink Services representative for more information about using this API.Edit Work item request
Example
Copy
mutation WorkItemEdit {
workItem {
edit(
input: {
workItem: {
payload: {
id: "d972e6ec-5ec7-4d81-ac13-41aa40e60e64"
currentBaseState: "Draft"
data: {
comments: [
{
commentAuthorId: "a3ef9f60-0276-11ed-ad1d-0242ac110011"
attachments: [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/workItem/1eb0ddfc-a11b-4567-a929-55d3ef4d2d1f\",\"fileStatus\":\"UPLOADED\"}"
]
commentText: "Added by partnerwwwww"
commentedDateTime: 1734687180000
commentIdentifier: "ac067728-ce20-437a-8c8e-bb305067eda3"
}
]
assigneeCompany: {
businessName: "QAOwnerCorp202409240834253301"
primaryIdentifierValue: "4700421709532"
primaryIdentifierType: "GLN2"
}
workItemTitle: "Added by partner - edit"
dueDate: 1735637460000
followers: [
{ followerId: "a3ef9f60-0276-11ed-ad1d-0242ac110011" }
]
}
}
objectAction: "UPDATE"
}
}
) {
businessObjectTypeName
businessObjectIdentifier
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"edit": {
"businessObjectTypeName": "workItem",
"businessObjectIdentifier": "6dc4a540-f90f-4b1e-9e80-4f113198843e",
"updated": [
{
"id": "6dc4a540-f90f-4b1e-9e80-4f113198843e",
"objectTypeName": "workItem",
"dataVersion": 2,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "WorkItemMutationOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Search Work item
Owners and Partners can use this API to search for a work item in the existing list of work items. Provide a list of sort fields, page size, and paging info to search for a work item.
Contact your TraceLink Services representative for more information about using this API.Search Work item request
Example
Copy
query WorkItemSearch {
workItem {
search(
input: {queryString: "(indexLuceneSubType:\"\" OR indexLuceneSubType:null)", sortFields: [], pageSize: 10, pagingInfo: ""}
) {
pagingInfo
documents {
id
currentBaseState
currentSubState
lastUpdatedDateTime
lastUpdatedDateTimeFormatted
data {
currentState
displayIdentifier
workItemTitle
dueDate
dueDateFormatted
initiatingCompany {
businessName
__typename
}
assigneeCompany {
businessName
__typename
}
__typename
}
__typename
}
facets {
indexName
path
matchedDocsCount
childFacetsCount
childFacets {
facetedName
matchedDocsCount
__typename
}
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"search": {
"pagingInfo": "eyJwYWdlSW5kZXgiOjEsInBhZ2luZ0luZm9LZXkiOm51bGx9",
"documents": [
{
"id": "0fc9b1fa-6d45-483b-9bfb-b05f588de5d5",
"currentBaseState": "ToDo",
"currentSubState": null,
"lastUpdatedDateTime": 1734594888515,
"lastUpdatedDateTimeFormatted": "12/19/24, 7:54 AM (GMT)",
"data": {
"currentState": "ToDo",
"displayIdentifier": "WI-72",
"workItemTitle": "Adding WI with attachment",
"dueDate": 1735196142963,
"dueDateFormatted": "Dec 26, 2024, 6:55:42 AM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "2c34c499-87f6-400f-893e-98bb65a3a596",
"currentBaseState": "ToDo",
"currentSubState": null,
"lastUpdatedDateTime": 1734537801409,
"lastUpdatedDateTimeFormatted": "12/18/24, 4:03 PM (GMT)",
"data": {
"currentState": "ToDo",
"displayIdentifier": "WI-65",
"workItemTitle": "testsdfsdf erghjhr",
"dueDate": 1734513700020,
"dueDateFormatted": "Dec 18, 2024, 9:21:40 AM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "qaownercorp202409240834253301-Loc1",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "a1b119cb-2726-4b16-aeb9-9e23a775235b",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734606605748,
"lastUpdatedDateTimeFormatted": "12/19/24, 11:10 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-81",
"workItemTitle": "Add by partner",
"dueDate": 1735211393827,
"dueDateFormatted": "Dec 26, 2024, 11:09:53 AM (GMT)",
"initiatingCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "97f74480-3514-4e5a-b182-b301201b82f4",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734606519875,
"lastUpdatedDateTimeFormatted": "12/19/24, 11:08 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-80",
"workItemTitle": "qqqqq",
"dueDate": 1735211296398,
"dueDateFormatted": "Dec 26, 2024, 11:08:16 AM (GMT)",
"initiatingCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "d5adcd70-7af0-49b0-9194-c50b8d1d092d",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734712978400,
"lastUpdatedDateTimeFormatted": "12/20/24, 4:42 PM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-92",
"workItemTitle": "Add WI",
"dueDate": 1735317588380,
"dueDateFormatted": "Dec 27, 2024, 4:39:48 PM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "cbea04c9-37c8-430b-bb6b-cb00b4627c4d",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734690479229,
"lastUpdatedDateTimeFormatted": "12/20/24, 10:27 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-70",
"workItemTitle": "test initiator comp_edit",
"dueDate": 1735128065151,
"dueDateFormatted": "Dec 25, 2024, 12:01:05 PM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "qaownercorp202409240834253301-Loc1",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "717aab2f-6591-469f-ba79-ad3e71d676f9",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734678940207,
"lastUpdatedDateTimeFormatted": "12/20/24, 7:15 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-64",
"workItemTitle": "Test delete 1",
"dueDate": 1735583400000,
"dueDateFormatted": "Dec 30, 2024, 6:30:00 PM (GMT)",
"initiatingCompany": null,
"assigneeCompany": {
"businessName": "QAPartnerCorp2202409240834283621",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "0c7445bf-6c99-400f-8fc8-477efbd7c4cb",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734705172628,
"lastUpdatedDateTimeFormatted": "12/20/24, 2:32 PM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-90",
"workItemTitle": "Title",
"dueDate": 1735655340000,
"dueDateFormatted": "Dec 31, 2024, 2:29:00 PM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "013f2cca-31e4-4431-a285-cb480e5f8ac7",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734705350144,
"lastUpdatedDateTimeFormatted": "12/20/24, 2:35 PM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "WI-91",
"workItemTitle": "Title",
"dueDate": 1735569300000,
"dueDateFormatted": "Dec 30, 2024, 2:35:00 PM (GMT)",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
{
"id": "7ef5967a-7487-4b9a-8300-f131b98806ae",
"currentBaseState": "ToDo",
"currentSubState": null,
"lastUpdatedDateTime": 1734719189143,
"lastUpdatedDateTimeFormatted": "12/20/24, 6:26 PM (GMT)",
"data": {
"currentState": "ToDo",
"displayIdentifier": "WI-71",
"workItemTitle": "testing work item partner",
"dueDate": 1735128225801,
"dueDateFormatted": "Dec 25, 2024, 12:03:45 PM (GMT)",
"initiatingCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
}
],
"facets": [],
"__typename": "WorkItemSearchResult"
},
"__typename": "WorkItemQueryOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Delete Work item
Owners use this API to delete a work item that is no longer required. Provide the work item identifier in the input field and the current base state to delete a work item.
Contact your TraceLink Services representative for more information about using this API.Delete Work item request
Example
Copy
mutation WorkItemDelete {
workItem {
delete(input: {id: "4d2267be-c6d9-414d-9cd1-6646d6fce1fd"}) {
businessObjectTypeName
businessObjectIdentifier
businessObjectDataVersion
mutateMessage
isAsync
updated {
id
objectTypeName
dataVersion
__typename
}
deleted {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"delete": {
"businessObjectTypeName": "workItem",
"businessObjectIdentifier": "6dc4a540-f90f-4b1e-9e80-4f113198843e",
"businessObjectDataVersion": 2,
"mutateMessage": "Work Item WI-97 has been deleted ",
"isAsync": null,
"updated": null,
"deleted": [
{
"id": "6dc4a540-f90f-4b1e-9e80-4f113198843e",
"objectTypeName": "workItem",
"dataVersion": 2,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "WorkItemMutationOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Follow Work item
Owners and Partners use this API to start following a work item. Provide the item identifier to start following the work item.
Contact your TraceLink Services representative for more information about using this API.Follow Work item request
Example
Copy
mutation WorkItemStartFollow {
workItem {
startFollow(input: {id: "2335af1c-4193-469d-b9c2-61400032f74e"}) {
businessObjectTypeName
businessObjectIdentifier
businessObjectDataVersion
mutateMessage
isAsync
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"startFollow": {
"businessObjectTypeName": "workItem",
"businessObjectIdentifier": "d972e6ec-5ec7-4d81-ac13-41aa40e60e64",
"businessObjectDataVersion": 4,
"mutateMessage": "Successfully followed the Work Item",
"isAsync": null,
"updated": [
{
"id": "d972e6ec-5ec7-4d81-ac13-41aa40e60e64",
"objectTypeName": "workItem",
"dataVersion": 4,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "WorkItemMutationOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
Unfollow Work item
Owners and Partners use this API to stop following a work item. Provide the work item identifier to stop following a work item.
Contact your TraceLink Services representative for more information about using this API.Unfollow Work item request
Example
Copy
mutation WorkItemStopFollow {
workItem {
stopFollow(input: {id: "2335af1c-4193-469d-b9c2-61400032f74e"}) {
businessObjectTypeName
businessObjectIdentifier
businessObjectDataVersion
mutateMessage
isAsync
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"stopFollow": {
"businessObjectTypeName": "workItem",
"businessObjectIdentifier": "d972e6ec-5ec7-4d81-ac13-41aa40e60e64",
"businessObjectDataVersion": 3,
"mutateMessage": "Successfully unfollowed the Work Item",
"isAsync": null,
"updated": [
{
"id": "d972e6ec-5ec7-4d81-ac13-41aa40e60e64",
"objectTypeName": "workItem",
"dataVersion": 3,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "WorkItemMutationOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
View Work item
Owners and Partners use this API to view an item. Provide the item identifier to view an item.
Contact your TraceLink Services representative for more information about using this API.View Work item request
Example
Copy
query WorkItemView {
workItem {
view(input: {id: "d972e6ec-5ec7-4d81-ac13-41aa40e60e64"}) {
id
currentBaseState
currentSubState
lastUpdatedDateTime
lastUpdatedDateTimeFormatted
data {
currentState
comments {
commentIdentifier
commentText
attachments
attachmentsFormatted
commentedDateTime
commentedDateTimeFormatted
commentAuthorId
commentAuthorIdFormatted
__typename
}
displayIdentifier
initiatingCompany {
primaryIdentifierType
primaryIdentifierValue
businessName
__typename
}
assigneeCompany {
primaryIdentifierType
primaryIdentifierValue
businessName
__typename
}
workItemTitle
dueDate
dueDateFormatted
followers {
followerId
followerIdFormatted
__typename
}
__typename
}
__typename
}
__typename
}
}Example
Copy
{
"data": {
"workItem": {
"view": {
"id": "d972e6ec-5ec7-4d81-ac13-41aa40e60e64",
"currentBaseState": "ToDo",
"currentSubState": null,
"lastUpdatedDateTime": 1734860500367,
"lastUpdatedDateTimeFormatted": "12/22/24, 9:41 AM (GMT)",
"data": {
"currentState": "ToDo",
"comments": [
{
"commentIdentifier": "ac067728-ce20-437a-8c8e-bb305067eda3",
"commentText": "Added by partner",
"attachments": [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/workItem/1eb0ddfc-a11b-4567-a929-55d3ef4d2d1f\",\"fileStatus\":\"UPLOADED\"}"
],
"attachmentsFormatted": [
"Original_File.txt (10 bytes)"
],
"commentedDateTime": 1734600804941,
"commentedDateTimeFormatted": "Dec 19, 2024, 9:33:24 AM (GMT)",
"commentAuthorId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"commentAuthorIdFormatted": "Kaushal Lavate",
"__typename": "CommentTypeDefinition"
}
],
"displayIdentifier": "WI-79",
"initiatingCompany": {
"primaryIdentifierType": "GLN",
"primaryIdentifierValue": "2054051864409",
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"primaryIdentifierType": "GLN",
"primaryIdentifierValue": "4700421709532",
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"workItemTitle": "Added by partner",
"dueDate": 1735205467366,
"dueDateFormatted": "Dec 26, 2024, 9:31:07 AM (GMT)",
"followers": [
{
"followerId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"followerIdFormatted": "Kaushal Lavate",
"__typename": "WorkItemFollowersTypeDefinition"
},
{
"followerId": "c55ff5ff-66d0-4c31-b2e4-5947a7e21955",
"followerIdFormatted": "Patricia Reynolds",
"__typename": "WorkItemFollowersTypeDefinition"
}
],
"__typename": "WorkItemData"
},
"__typename": "WorkItem"
},
"__typename": "WorkItemQueryOps"
}
}
}Errors
This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.
