SCIM TaskInstance examples
Operations
List all
List all TaskInstances.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/TaskInstanceResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 6,
"startIndex": 1,
"Resources": [
{
"variables": {
"requester": "admin",
"grants": [
{
"ownersString": "SOFFID_ADMIN ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"SOFFID_ADMIN"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1762656,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Container/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1762352,
"description": "Approve ",
"pooledActors": [
"SOFFID_ADMIN"
],
"priority": 3,
"transitions": [
"Rechazar",
"Aceptar"
],
"dummyTask": false,
"processName": "Modificar permisos",
"processId": 1762544,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/TaskInstance/1762656",
"resourceType": "TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
],
"name": "Approve",
"create": "2021-03-30 19:57:35",
"cancelled": false,
"id": 1762656,
"open": true,
"signalling": true
},
{
"variables": {
"requester": "admin",
"grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/TaskInstance/1861549",
"resourceType": "TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
],
"name": "Approve",
"create": "2021-04-17 21:00:46",
"cancelled": false,
"id": 1861549,
"open": true,
"signalling": true
},
....................
]
}List by filter
List all TaskInstances with a filter expression.
It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/TaskInstance?count=2&filter=processName eq "Permissions request" and name eq ApproveResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,
"startIndex": 1,
"Resources": [
{
"variables": {
"requester": "admin",
"grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/TaskInstance/1861549",
"resourceType": "TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
],
"name": "Approve",
"create": "2021-04-17 21:00:46",
"cancelled": false,
"id": 1861549,
"open": true,
"signalling": true
},
{
"variables": {
"requester": "admin",
"grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393103,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "Active Directory",
"taskInstance": 1638273,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Enterprise Administrators",
"applicationName": "Container/Business process/ad"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"start": "2021-05-10 12:57:31",
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"actorId": "admin",
"processName": "Permissions request",
"processId": 1638261,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/TaskInstance/1638273",
"resourceType": "TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
],
"name": "Approve",
"create": "2021-03-11 16:33:41",
"cancelled": false,
"id": 1638273,
"open": true,
"signalling": true
},
..............
]
}Query by id
Query a GroupUser by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/TaskInstance/1861549Response 200 OK
{
"variables": {
"requester": "admin",
"grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/TaskInstance/1861549",
"resourceType": "TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
],
"name": "Approve",
"create": "2021-04-17 21:00:46",
"cancelled": false,
"id": 1861549,
"open": true,
"signalling": true
}Create
To create a TaskInstance.
Request
POSTJSON
-Response 201 Created
-Update partial
Update only of the attributes with changes, only these atrributes will be updated, the rest will maintain the same value.
Request
PATCH JSON
-Response 200 OK
-Update all
This operation replaces all values in the GroupUser.
- Note that the attribute id is required to confirm that the resource "...TaskInstance/<id>" is the same that the JSON TaskInstance.
- Note that all the attributes not included in the request will be cleared in the TaskInstance 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 -JSON
-Response 200 OK
-Delete
Delete a role.
Please note after this delete, the account has to be created again to use it in the next examples.
Request
DELETE -Response 204 No Content
204 No ContentError response
For more information about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response