This Help Center is a preview of a future release. The final Help Center will be available on the Validation date.
Item APIs
Companies that own or link to Agile Process Teams use these APIs to add, update, and complete items. An Item is a lightweight object instance in Process Orchestration for Empowered Teams, that allows businesses to leverage a simplified object without predefined application functionality, enabling them to model subtypes tailored to their specific needs. Companies can use Items for internal collaboration on tasks which are not time-bound, such as optimizing an inventory management system.
Add Item
Owners and Partners use this API to add a new item to the Owner's company network, including any initial comments or file attachments. The response returns a generated identifier for the new item.


Example
mutation ItemNew {
item {
new(
input: {
item: {
payload: {
subType: ""
id: ""
currentBaseState: "Draft"
data: {
comments: [
{
commentText: "comment",
attachments: [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/item/2651a7ca-b580-4dda-9ca5-345ab34eefb1\",\"fileStatus\":\"UPLOADED\"}"
]
}]
itemTitle: "test item"
}
}
objectAction: "CREATE"
}
}
) {
businessObjectTypeName
businessObjectIdentifier
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"new": {
"businessObjectTypeName": "item",
"businessObjectIdentifier": "eff8a3a9-c96c-4126-9954-3985f3cafe68",
"updated": null,
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "ItemMutationOps"
}
}
}
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 Item
Owners and Partners use this API to modify an existing item with new, updated, or corrected information (e.g. adding a comment, updating the assignee company details, fixing a typo) and to update the workflow state (e.g. manually transitioning the base state from To Do
to In Progress
to indicate that the work assigned in the item has started).


Example
mutation ItemEdit {
item {
edit(
input: {
item: {
payload: {
id: "04718cfd-8b81-47ff-a07d-fbab7d6bf628"
currentBaseState: "Done"
data: {
comments: [
{
commentText: "Added by partner"
commentedDateTime: 1734600920096
attachments: [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"\",\"fileStatus\":\"EMPTY\"}"
]
commentAuthorId: "a3ef9f60-0276-11ed-ad1d-0242ac110011"
commentIdentifier: "2fa26034-6bd0-4d52-a3a0-c60ac6ed40c4"
}
]
followers: [
{ followerId: "a3ef9f60-0276-11ed-ad1d-0242ac110011" }
]
itemTitle: "Added by partner - test"
}
}
objectAction: "UPDATE"
}
}
) {
businessObjectTypeName
businessObjectIdentifier
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"edit": {
"businessObjectTypeName": "item",
"businessObjectIdentifier": "04718cfd-8b81-47ff-a07d-fbab7d6bf628",
"updated": [
{
"id": "04718cfd-8b81-47ff-a07d-fbab7d6bf628",
"objectTypeName": "item",
"dataVersion": 8,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "ItemMutationOps"
}
}
}
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 Item
Owners and Partners can use this API to search for an item in the existing list of items. Provide a list of sort fields, page size, and paging info to search for an item.


Example
query ItemSearch {
item {
search(
input: {
queryString: "(indexLuceneSubType:\"\" OR indexLuceneSubType:null)"
sortFields: []
pageSize: 10
pagingInfo: ""
}
) {
pagingInfo
documents {
id
currentBaseState
currentSubState
lastUpdatedDateTime
lastUpdatedDateTimeFormatted
data {
currentState
displayIdentifier
itemTitle
initiatingCompany {
businessName
__typename
}
__typename
}
__typename
}
facets {
indexName
path
matchedDocsCount
childFacetsCount
childFacets {
facetedName
matchedDocsCount
__typename
}
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"search": {
"pagingInfo": "eyJwYWdlSW5kZXgiOjEsInBhZ2luZ0luZm9LZXkiOm51bGx9",
"documents": [
{
"id": "febb1586-c664-445a-a215-e1f8df187250",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734599270015,
"lastUpdatedDateTimeFormatted": "12/19/24, 9:07 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-26",
"itemTitle": "title",
"initiatingCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "90823410-5a37-4564-b474-f5dc08c79884",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734607115359,
"lastUpdatedDateTimeFormatted": "12/19/24, 11:18 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-30",
"itemTitle": "test item",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "2b07befd-51ab-465a-aa1a-6fb2335b43ba",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734606372563,
"lastUpdatedDateTimeFormatted": "12/19/24, 11:06 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-28",
"itemTitle": "test item",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "453dc8d2-5857-45d0-909b-6ef869006464",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734761144110,
"lastUpdatedDateTimeFormatted": "12/21/24, 6:05 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-36",
"itemTitle": "test-1",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "8eaa15f8-477c-4b33-bb1b-33fae6f3daca",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734713163198,
"lastUpdatedDateTimeFormatted": "12/20/24, 4:46 PM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-34",
"itemTitle": "Add Item",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "afebea19-d00a-4765-b3c7-13947169bd69",
"currentBaseState": "ToDo",
"currentSubState": null,
"lastUpdatedDateTime": 1734600966879,
"lastUpdatedDateTimeFormatted": "12/19/24, 9:36 AM (GMT)",
"data": {
"currentState": "ToDo",
"displayIdentifier": "ITEM-22",
"itemTitle": "Add new Item",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "8e0b9882-81ac-473a-93f5-2bd3e6860120",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734688023492,
"lastUpdatedDateTimeFormatted": "12/20/24, 9:47 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-31",
"itemTitle": "s",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "6113a337-6121-4970-ac90-3699b134b759",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734689516275,
"lastUpdatedDateTimeFormatted": "12/20/24, 10:11 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-33",
"itemTitle": "t",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "19e6b53e-06b5-4d67-963d-3e95b3587b60",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734688573710,
"lastUpdatedDateTimeFormatted": "12/20/24, 9:56 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-32",
"itemTitle": "test",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": null,
"__typename": "ItemData"
},
"__typename": "Item"
},
{
"id": "2747390a-c340-4f29-a4c2-753cd39200c9",
"currentBaseState": "Draft",
"currentSubState": null,
"lastUpdatedDateTime": 1734691148514,
"lastUpdatedDateTimeFormatted": "12/20/24, 10:39 AM (GMT)",
"data": {
"currentState": "Draft",
"displayIdentifier": "ITEM-24",
"itemTitle": "Audit for the ArtWork Received",
"initiatingCompany": {
"businessName": "QAOwnerCorp202409240834253301",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"assigneeCompany": {
"businessName": "qaownercorp202409240834253301-Loc2",
"__typename": "BusinessCompanyLocationTypeDefinition"
},
"__typename": "ItemData"
},
"__typename": "Item"
}
],
"facets": [],
"__typename": "ItemSearchResult"
},
"__typename": "ItemQueryOps"
}
}
}
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 Item
Owners and Partners use this API to delete an item that is no longer required. Provide the item identifier in the input field and the current base state to delete an item.


Example
mutation ItemEdit {
item {
edit(
input: {
item: {
payload: {
id: "04718cfd-8b81-47ff-a07d-fbab7d6bf628"
currentBaseState: "Done"
data: {
comments: [
{
commentText: "Added by partner"
commentedDateTime: 1734600920096
attachments: [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"\",\"fileStatus\":\"EMPTY\"}"
]
commentAuthorId: "a3ef9f60-0276-11ed-ad1d-0242ac110011"
commentIdentifier: "2fa26034-6bd0-4d52-a3a0-c60ac6ed40c4"
}
]
followers: [
{ followerId: "a3ef9f60-0276-11ed-ad1d-0242ac110011" }
]
itemTitle: "Added by partner - test"
}
}
objectAction: "UPDATE"
}
}
) {
businessObjectTypeName
businessObjectIdentifier
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"delete": {
"businessObjectTypeName": "item",
"businessObjectIdentifier": "90823410-5a37-4564-b474-f5dc08c79884",
"businessObjectDataVersion": 1,
"mutateMessage": "Item ITEM-30 has been deleted ",
"isAsync": null,
"updated": null,
"deleted": [
{
"id": "90823410-5a37-4564-b474-f5dc08c79884",
"objectTypeName": "item",
"dataVersion": 1,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "ItemMutationOps"
}
}
}
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 Item
Owners and Partners use this API to start following an item. Provide the item identifier to start following the item.


Example
mutation ItemStartFollow {
item {
startFollow(input: {id: "2335af1c-4193-469d-b9c2-61400032f74e"}) {
businessObjectTypeName
businessObjectIdentifier
businessObjectDataVersion
mutateMessage
isAsync
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"startFollow": {
"businessObjectTypeName": "item",
"businessObjectIdentifier": "2335af1c-4193-469d-b9c2-61400032f74e",
"businessObjectDataVersion": 4,
"mutateMessage": "Successfully followed the Item",
"isAsync": null,
"updated": [
{
"id": "2335af1c-4193-469d-b9c2-61400032f74e",
"objectTypeName": "item",
"dataVersion": 4,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "ItemMutationOps"
}
}
}
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 Item
Owners and Partners use this API to stop following an item. Provide the item identifier to stop following an item.


Example
mutation ItemStopFollow {
item {
stopFollow(input: {id: "2335af1c-4193-469d-b9c2-61400032f74e"}) {
businessObjectTypeName
businessObjectIdentifier
businessObjectDataVersion
mutateMessage
isAsync
updated {
id
objectTypeName
dataVersion
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"stopFollow": {
"businessObjectTypeName": "item",
"businessObjectIdentifier": "2335af1c-4193-469d-b9c2-61400032f74e",
"businessObjectDataVersion": 5,
"mutateMessage": "Successfully unfollowed the Item",
"isAsync": null,
"updated": [
{
"id": "2335af1c-4193-469d-b9c2-61400032f74e",
"objectTypeName": "item",
"dataVersion": 5,
"__typename": "MutateOperationResultEntryTypeDef"
}
],
"__typename": "MutateOperationResultTypeDef"
},
"__typename": "ItemMutationOps"
}
}
}
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 Item
Owners and Partners use this API to view an item. Provide the item identifier to view an item.


Example
query ItemView {
item {
view(input: {id: "04718cfd-8b81-47ff-a07d-fbab7d6bf628"}) {
id
currentBaseState
currentSubState
lastUpdatedDateTime
lastUpdatedDateTimeFormatted
data {
currentState
comments {
commentIdentifier
commentText
attachments
attachmentsFormatted
commentedDateTime
commentedDateTimeFormatted
commentAuthorId
commentAuthorIdFormatted
__typename
}
displayIdentifier
itemTitle
initiatingCompany {
primaryIdentifierType
primaryIdentifierValue
businessName
__typename
}
followers {
followerId
followerIdFormatted
__typename
}
__typename
}
__typename
}
__typename
}
}

Example
{
"data": {
"item": {
"view": {
"id": "04718cfd-8b81-47ff-a07d-fbab7d6bf628",
"currentBaseState": "Done",
"currentSubState": null,
"lastUpdatedDateTime": 1735814924326,
"lastUpdatedDateTimeFormatted": "1/2/25, 10:48 AM (GMT)",
"data": {
"currentState": "Done",
"comments": [
{
"commentIdentifier": "2fa26034-6bd0-4d52-a3a0-c60ac6ed40c4",
"commentText": "Added by partner",
"attachments": [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"\",\"fileStatus\":\"EMPTY\"}"
],
"attachmentsFormatted": [
"missing file"
],
"commentedDateTime": 1734600920096,
"commentedDateTimeFormatted": "Dec 19, 2024, 9:35:20 AM (GMT)",
"commentAuthorId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"commentAuthorIdFormatted": "Kaushal Lavate",
"__typename": "CommentTypeDefinition"
},
{
"commentIdentifier": "6e654588-dcde-4361-aaf0-3b77539d0e90",
"commentText": "Only comment Text",
"attachments": null,
"attachmentsFormatted": null,
"commentedDateTime": 1734601742830,
"commentedDateTimeFormatted": "Dec 19, 2024, 9:49:02 AM (GMT)",
"commentAuthorId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"commentAuthorIdFormatted": "Kaushal Lavate",
"__typename": "CommentTypeDefinition"
},
{
"commentIdentifier": "a8fc2d9d-f207-4636-88d7-b800eb08ce0f",
"commentText": "Both comment and attachment",
"attachments": [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/item/7a3891b3-500a-470e-9a78-6d92ccafa342\",\"fileStatus\":\"UPLOADED\"}"
],
"attachmentsFormatted": [
"Original_File.txt (10 bytes)"
],
"commentedDateTime": 1734601742830,
"commentedDateTimeFormatted": "Dec 19, 2024, 9:49:02 AM (GMT)",
"commentAuthorId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"commentAuthorIdFormatted": "Kaushal Lavate",
"__typename": "CommentTypeDefinition"
},
{
"commentIdentifier": "bdbdef23-5846-4b22-8681-7bf05a9de91b",
"commentText": "multiple attachment",
"attachments": [
"{\"fileName\":\"Original_File\",\"fileExtension\":\"txt\",\"mimeType\":\"text/plain\",\"fileSize\":10,\"s3FileReference\":\"attachments/item/2651a7ca-b580-4dda-9ca5-345ab34eefb1\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"Test document 1\",\"fileExtension\":\"png\",\"mimeType\":\"image/png\",\"fileSize\":43561,\"s3FileReference\":\"attachments/item/80bbeb25-c918-4939-b9ed-97a77af37795\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"Sample-SQL-File-10-Rows\",\"fileExtension\":\"sql\",\"mimeType\":\"\",\"fileSize\":1593,\"s3FileReference\":\"attachments/item/43e1a1fc-c00d-48db-9291-9f49ab695a4b\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"sample\",\"fileExtension\":\"pdf\",\"mimeType\":\"application/pdf\",\"fileSize\":18810,\"s3FileReference\":\"attachments/item/7ffd0439-7bc7-41be-90e1-cffd4ceb0583\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"SampleAudio_0\",\"fileExtension\":\"mp3\",\"mimeType\":\"audio/mpeg\",\"fileSize\":725240,\"s3FileReference\":\"attachments/item/3217df4c-a2d5-4a06-b472-ad183a5beffd\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"SampleDOCFile_5000kb\",\"fileExtension\":\"doc\",\"mimeType\":\"application/msword\",\"fileSize\":5120512,\"s3FileReference\":\"attachments/item/3b44e992-98be-43bd-b1ae-7b9540c34a27\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"SampleVideo_1280x720_30mb\",\"fileExtension\":\"mp4\",\"mimeType\":\"video/mp4\",\"fileSize\":31491130,\"s3FileReference\":\"attachments/item/80f407a9-fdb9-4183-8f57-022889c786d6\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"SampleXLSFile_6800kb\",\"fileExtension\":\"xls\",\"mimeType\":\"application/vnd.ms-excel\",\"fileSize\":6971392,\"s3FileReference\":\"attachments/item/903222f7-9aa1-4685-9a22-1d3c432e3c8e\",\"fileStatus\":\"UPLOADED\"}",
"{\"fileName\":\"SampleZIPFile_10mbmb\",\"fileExtension\":\"zip\",\"mimeType\":\"application/zip\",\"fileSize\":10503575,\"s3FileReference\":\"attachments/item/15a66dbe-2e9d-43bb-b4c3-fdbc3304b8f5\",\"fileStatus\":\"UPLOADED\"}"
],
"attachmentsFormatted": [
"Original_File.txt (10 bytes)",
"Test document 1.png (42 KB)",
"Sample-SQL-File-10-Rows.sql (1 KB)",
"sample.pdf (18 KB)",
"SampleAudio_0.mp3 (708 KB)",
"SampleDOCFile_5000kb.doc (4 MB)",
"SampleVideo_1280x720_30mb.mp4 (30 MB)",
"SampleXLSFile_6800kb.xls (6 MB)",
"SampleZIPFile_10mbmb.zip (10 MB)"
],
"commentedDateTime": 1734602320847,
"commentedDateTimeFormatted": "Dec 19, 2024, 9:58:40 AM (GMT)",
"commentAuthorId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"commentAuthorIdFormatted": "Kaushal Lavate",
"__typename": "CommentTypeDefinition"
}
],
"displayIdentifier": "ITEM-27",
"itemTitle": "Added by partner - test",
"initiatingCompany": {
"primaryIdentifierType": "GLN",
"primaryIdentifierValue": "2054051864409",
"businessName": "QAPartnerCorp1202409240834280621",
"__typename": "InitiatingCompanyLocationTypeDefinition"
},
"followers": [
{
"followerId": "a3ef9f60-0276-11ed-ad1d-0242ac110011",
"followerIdFormatted": "Kaushal Lavate",
"__typename": "ItemFollowerTypeDefinition"
},
{
"followerId": "c55ff5ff-66d0-4c31-b2e4-5947a7e21955",
"followerIdFormatted": "Patricia Reynolds",
"__typename": "ItemFollowerTypeDefinition"
}
],
"__typename": "ItemData"
},
"__typename": "Item"
},
"__typename": "ItemQueryOps"
}
}
}
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.