ProcessInstance resource data model

/ProcessInstance

Dictionary table

The diagram service model of the object: http://www.soffid.org/doc/console/2.9.0/uml/com/soffid/iam/bpm/api/ProcessInstance.html

QUery Schema

It is allowed to consult all the ProcessInstance definition using the Schema query:

GET http://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessInstance

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/ProcessInstance/832514

Response 200 OK

{
    "dummyProcess": false,
    "variables": {
        "requester": "admin",
        "grants": [],
        "server": "forge.dev.lab",
        "systemName": "SSO",
        "requesterName": "Soffid Administrator",
        "loginName": "bbuades",
        "until": "2020-11-12 16:43:07",
        "account": "bbuades"
    },
    "comments": [],
    "processDefinition": 1944240,
    "meta": {
        "location": "http://<your-domain>/soffid.pat.lab:8080/webservice/scim2/v1/ProcessInstance/832514"Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessInstance",
        "resourceType": "ProcessInstance"Schema"
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "name": "ProcessInstance",
    "description": "ProcessInstance object",
    "attributes": [
        {
            "uniqueness": "server",
            "name": "id",
            "mutability": "readOnly",
            "type": "integer",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "description",
            "mutability": "readOnly",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "start",
            "mutability": "readOnly",
            "type": "complex",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "end",
            "mutability": "readOnly",
            "type": "complex",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "variables",
            "mutability": "readWrite",
            "type": "complex",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "currentTask",
            "mutability": "readOnly",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "comments",
            "mutability": "readWrite",
            "type": "complex",
            "caseExact": true,
            "returned": "default",
            "multiValued": true,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "processDefinition",
            "mutability": "immutable",
            "type": "integer",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "dummyProcess",
            "mutability": "readOnly",
            "type": "boolean",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "transition",
            "mutability": "writeOnly",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": true,
            "required": false
        }
    ],
    "id": "urn:soffid:com.soffid.iam.bpm.api.ProcessInstance"
],
    "start": "2020-11-11 16:43:09",
    "currentTask": "Start",
    "description": "Grant account",
    "id": 832514
}

Response

Full Error

JSON example

For more infomation about response error visitVisit https://bookstack.soffid.com/link/116#bkmrk-error-responseSCIM ProcessInstance examples page.