Resource for integration of Activiti with the CMS. Usage of this resource requires the feature activiti_integration to be activated.
Get the pages assigned to the given task
name | type | description |
---|---|---|
id | path | Task ID |
media type | data type | description |
---|---|---|
application/json | PageTaskListResponse (JSON) | Response containing the assigned pages |
GET /activiti/task/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"pages" : [ {
"pageId" : "...",
"completeOn" : "publish"
}, {
"pageId" : "...",
"completeOn" : "delete"
} ],
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "FAILURE",
"responseMessage" : "...",
"property" : "..."
}
}
Assign a page to the given task
name | type | description |
---|---|---|
id | path | Task ID |
media type | data type | description |
---|---|---|
application/json | PageTask (JSON) | Assigned page and event info |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | Generic response |
POST /activiti/task/{id}
Content-Type: application/json
Accept: application/json
{
"pageId" : "...",
"completeOn" : "move"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"responseMessage" : "...",
"property" : "..."
}
}
Delete all assignments for a given task
name | type | description |
---|---|---|
id | path | Task ID |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | Generic response |
DELETE /activiti/task/{id} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "NOTLICENSED",
"responseMessage" : "...",
"property" : "..."
}
}
Get the entries in the process queue.
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 asc ending or
desc ending (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 |
media type | data type | description |
---|---|---|
application/json | ProcessQueueResponse (JSON) | The list of entries in the process queues. |
GET /activiti/processqueue Accept: application/json
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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}
Get the activiti integration status
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | status |
GET /activiti/status Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "PERMISSION",
"responseMessage" : "...",
"property" : "..."
}
}