REST API - completeWorkItem

The table summarizes the REST API - completeWorkItem.

Request

Format
PUT <baseurl>/workitem/complete/<id>/<version>/<nextpileditem>
Path parameters
  • id : ID of the work item that is to be completed.
  • version: Version of the work item. If not set, the latest version will be used.
  • nextpileditem: (boolean) True, then return the next piled work item.
Body completeWorkItem element (from the WorkItemManagementService schema).

Response

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

Example

Request
PUT <baseurl>/workItem/complete/5/3/false
Request body
<?xml version="1.0" encoding="UTF-8"?>
<workItemPayload xmlns="">
    <dataModel>
      <inouts name=" UserName" type=" STRING ">
        <simpleSpec>
          <value> test</value>
        </simpleSpec>
      </inouts>
    </dataModel>
  </workItemPayload>
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"
                    }
                }
            ]
        }
    }
}