Type = API Reference,; Topic = OPUS Solution Environment, Process Orchestration for Empowered Teams (POET),;Persona = Solution Designer, Orchestration Architect,; Orchestration =; Function = Supply Chain,

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.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

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 ToDo to InProgress to indicate that the work assigned in the item has started).

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

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.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

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.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

Follow Item

Owners and Partners use this API to start following an item. Provide the item identifier to start following the item.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

Unfollow Item

Owners and Partners use this API to stop following an item. Provide the item identifier to stop following an item.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

View Item

Owners and Partners use this API to view an item. Provide the item identifier to view an item.

Enter currentBaseState values in camel case format. For example, use "InProgress" instead of "In Progress".

Tag end