Skip to main content

SCIM ProcessDefinition examples

Operations

List all

List all ProcessDefinitions.

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/ProcessDefinition
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 8,
    "startIndex": 1,
    "Resources": [
        {
            "author": "admin",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/ProcessDefinition/1474063",
                "resourceType": "ProcessDefinition"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
            ],
            "name": "User registration",
            "deployed": "2021-02-11 16:42:08",
            "tag": "27",
            "id": 1474063,
            "version": 27,
            "enabled": true
        },
        {
            "author": "admin",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/ProcessDefinition/1857694",
                "resourceType": "ProcessDefinition"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
            ],
            "name": "User request",
            "deployed": "2021-04-15 16:10:11",
            "tag": "19",
            "id": 1857694,
            "version": 19,
            "enabled": true
        },
      .............
    ]
}

List by filter

List all ProcessDefinitions with a filter expression.

It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.

Request

List all ProcessDefinitions with a filter expression.

GET http://<your-domain>/soffid/webservice/scim2/v1/ProcessDefinition?filter=name co request
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "startIndex": 1,
    "Resources": [
        {
            "author": "admin",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/ProcessDefinition/1946303",
                "resourceType": "ProcessDefinition"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
            ],
            "name": "Permissions request",
            "deployed": "2021-04-30 08:48:58",
            "tag": "23",
            "id": 1946303,
            "type": "RoleApproval",
            "version": 23,
            "enabled": true
        },
        {
            "author": "admin",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/ProcessDefinition/1857694",
                "resourceType": "ProcessDefinition"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
            ],
            "name": "User request",
            "deployed": "2021-04-15 16:10:11",
            "tag": "19",
            "id": 1857694,
            "version": 19,
            "enabled": true
        }
    ]
}

Query by id

Query a ProcessDefinition by its id (primary key). 

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/ProcessDefinition/1857694
Response 200 OK
{
    "author": "admin",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/ProcessDefinition/1857694",
        "resourceType": "ProcessDefinition"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
    ],
    "name": "User request",
    "deployed": "2021-04-15 16:10:11",
    "tag": "19",
    "id": 1857694,
    "version": 19,
    "enabled": true
}

Create

ToThis createoperation ais ProcessDefinition.not allowed.

Request

POST -

JSON

-
Response 201 Created
-

Update partial

UpdateThis onlyoperation ofis thenot attributes with changes, only these atrributes will be updated, the rest will maintain the same value.allowed.

Request 
PATCH -

JSON

-
Response 200 OK
-

Update all

This operation replaces all values in the ProcessDefinition.

  • Note that the attribute id is required to confirm that the resource "...ProcessDefinition/<id>" is the same that the JSON ProcessDefinition.
  • Note that all the attributes not included in the request will be cleared in the ProcessDefinition type and their data will be lost.
  • Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information visit Resource data model page
Request
PUT -

JSONallowed.

-
Response 200 OK
-

Delete

DeleteThis aoperation role.is not allowed.

Please note after this delete, the ProcessDefinition has to be created again to use it in the next examples.

Request
DELETE -
Response 204 No Content
204 No Content

Error response

For more information about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response

 

Back to top