REST API - openWorkItem

The table summarizes the REST API - openWorkItem.

Request

Format
PUT <baseurl>/workitem/open
Query parameters
  • id=long (1..n): Unique ID of the work item.
  • version=long (1..n): Version of the work item. If not set, the latest version will be used.

Response

JSON Returns a JSON representation of the content of the openWorkItemResponse element.
XML Returns the content of the openWorkItemResponse element (from the WorkItemManagementService schema)

Example

Request
PUT <baseurl>/workitem/open?id=16&version=2
Response
{

    "workItemBody": {

        "dataModel": {

            "inouts": [

                {

                    "@name": "Message",

                    "@type": "String",

                    "@array": "false",

                    "simpleSpec": {

                        "value": "Hello tibco-admin. Welcome to TIBCO BPM."

                    }

                },

                {

                    "@name": "UserName",

                    "@type": "String",

                    "@array": "false",

                    "simpleSpec": {

                        "value": "tibco-admin"

                    }

                }

            ]

        }

    }

}