Skip to main content

ProcessDefinition resource

/ProcessDefinition

Dictionary table

The diagram service model of the object: https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/ProcessDefinition.html

Query Schema

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

Request
GET https://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition
Response 200 OK
{
  "meta": {
    "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition",
    "resourceType": "Schema"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "name": "ProcessDefinition",
  "description": "ProcessDefinition object",
  "attributes": [
    {
      "uniqueness": "none",
      "name": "version",
      "mutability": "readOnly",
      "type": "integer",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "tag",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "name",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "server",
      "name": "id",
      "mutability": "readOnly",
      "type": "integer",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "enabled",
      "mutability": "readOnly",
      "type": "boolean",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "appliesTo",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "type",
      "mutability": "readOnly",
      "type": "complex",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "deployed",
      "mutability": "readOnly",
      "type": "complex",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "author",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    }
  ],
  "id": "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
}

Full JSON example

Visit SCIM ProcessDefinition examples page.