ActivitiResource Resource

Resource for integration of Activiti with the CMS. Usage of this resource requires the feature activiti_integration to be activated.

GET /activiti/processqueue

Get the entries in the process queue.

Request Parameters
name type description default multivalued
objtypes query For which object types to load the process queues, or an empty list to retrieve entries for all types (default).   yes
sortby query The field to sort the results by, or an empty string to disable sorting. no
sortorder query Whether to sort ascending or descending (anything other than desc will be interpreted as asc asc no
states query Only entries with one of these states will be returned or an empty list to retrieve entries of all states (default).   yes
Response Body
media type data type description
application/json ProcessQueueResponse (JSON) The list of entries in the process queues.

Example

Request
GET /activiti/processqueue
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "id" : "...",
    "entryId" : 12345,
    "objectId" : 12345,
    "objectType" : "...",
    "processKey" : "...",
    "data" : "...",
    "state" : "...",
    "timestamp" : 12345
  }, {
    "id" : "...",
    "entryId" : 12345,
    "objectId" : 12345,
    "objectType" : "...",
    "processKey" : "...",
    "data" : "...",
    "state" : "...",
    "timestamp" : 12345
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /activiti/status

Get the activiti integration status

Response Body
media type data type description
application/json GenericResponse (JSON) status

Example

Request
GET /activiti/status
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /activiti/task/{id}

Delete all assignments for a given task

Request Parameters
name type description
id path Task ID
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
DELETE /activiti/task/{id}
Accept: application/json
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /activiti/task/{id}

Get the pages assigned to the given task

Request Parameters
name type description
id path Task ID
Response Body
media type data type description
application/json PageTaskListResponse (JSON) Response containing the assigned pages

Example

Request
GET /activiti/task/{id}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "pages" : [ {
    "pageId" : "...",
    "completeOn" : "publish"
  }, {
    "pageId" : "...",
    "completeOn" : "move"
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /activiti/task/{id}

Assign a page to the given task

Request Parameters
name type description
id path Task ID
Request Body
media type data type description
application/json PageTask (JSON) Assigned page and event info
Response Body
media type data type description
application/json GenericResponse (JSON) Generic response

Example

Request
POST /activiti/task/{id}
Content-Type: application/json
Accept: application/json

                
{
  "pageId" : "...",
  "completeOn" : "move"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}