Fetch Task Details
POST/fetchTasks
This method returns a list
of provisioning tasks, that correspond to a particular IT Application (e.g Microsoft Active Directory) modeled in SSM as "Endpoint" of a "Security System".
The Authorization
must have Bearer
followed by Token
.
Mandatory params:
TASKSTATUS
- PENDING/PENDINGCREATE/COMPLETED/COMPLETED_AND_DISCONTINUE/DISCONTINUE,
Optional params:
endpoint
- endpoint key,
endpointname
, endpointdescription
,
securitysystem
- securitysystem key,
loggedinusername
- username of user who wants to fetch the tasks,
upadteuser
,
requestedby
,
username
,
firstname
,
lastname
,
account
- accountname,
entitlement_value
,
entitlement_glossary
,
entitlementowner
- entitlementowner key,
entitlementtypekey
,
requestid
,
parenttaskid
,
taskid
,
taskowneruser
- userkey of owner,
taskownerusername
- username of owner,
taskownerusergroup
- usergroup key,
taskownerusergroupname
- usergroup name,
max
, offset
,
statusint
- List of comma-seperated integer equivalent task status(3 - Complete, 4 - Discontinue and so on)
source
- List of comma-seperated source types(REQUEST/WEBSERVICE/CERTIFICATION and so on)
requestkey
- List of comma-seperated requestkeys
requestaccesskey
- List of comma-seperated requestaccesskey
tasktype
- List of comma-seperated integer equivalent task types(3 - New Account, 5 - Change Password and so on)
getEntitlementObj
- Values: true/false, if true returns the entitlement details associated with the task
getAccountObj
- Values: true/false, if true returns the account details asociated with the task,
taskmetadatalength
- Modifies the charcater limit of provisioning comments and provisioning metadata upto maximum of 10000.
Note - Provisioning comments in the response will be limited to 200 characters. Provisioning metadata in the response will be limited to 400 characters.
Request
- multipart/form-data
Body
Responses
- 200
Fetch Task Details
Response Headers
Access-Control-Allow-Credentials
string
Access-Control-Allow-Origin
string
Cache-Control
string
Date
string
Expires
string
Referrer-Policy
string
Server
string
Set-Cookie
string
Strict-Transport-Security
string
X-Content-Type-Options
string
X-Frame-Options
string
- application/json
- Schema
- Example (from schema)
- Fetch Task Details
Schema
Array [
]
tasks
object[]
{
"errorCode": "0",
"msg": "Successful",
"tasks": [
{
"ACCOUNT": "bsimpson5",
"COMMENTS": "add a comment",
"CREATIONDATE": "2021-01-04 20:27:34",
"ENDDATE": "",
"ENDPOINT": "Active Directory Plus",
"ENDPOINTKEY": "604",
"ENDPOINTNAME": "ActiveDirectoryPlus",
"ENTITLEMENTTYPE": "",
"ENTITLEMENT_VALUEKEY": "",
"OWNERKEY": "admin",
"PARENTTASK": "",
"PROVISIONINGCOMMENTS": "",
"PROVISIONINGMETADATA": "",
"REQUESTACCESSKEY": "",
"REQUESTID": "",
"REQUESTKEY": "",
"SECURITYSYSTEM": "Active Directory Plus",
"STARTDATE": "",
"STATUS": "New",
"TASKID": "10642653",
"TASKTYPE": "Change Password",
"UPDATEDATE": "2021-01-04 20:27:34",
"USER": "bsimpson5",
"upadteuser": "bsimpson5(2021-01-04 20:27:34)"
},
{
"ACCOUNT": "$1V9000-2LO73GT330CI",
"COMMENTS": "add a comment",
"CREATIONDATE": "2021-02-17 04:27:54",
"ENDDATE": "",
"ENDPOINT": "Active Directory Plus",
"ENDPOINTKEY": "604",
"ENDPOINTNAME": "ActiveDirectoryPlus",
"ENTITLEMENTTYPE": "",
"ENTITLEMENT_VALUEKEY": "",
"OWNERKEY": "admin",
"PARENTTASK": "",
"PROVISIONINGCOMMENTS": "",
"PROVISIONINGMETADATA": "",
"REQUESTACCESSKEY": "",
"REQUESTID": "",
"REQUESTKEY": "",
"SECURITYSYSTEM": "Active Directory Plus",
"STARTDATE": "",
"STATUS": "New",
"TASKID": "10642774",
"TASKTYPE": "Change Password",
"UPDATEDATE": "2021-02-17 04:27:54",
"USER": "",
"upadteuser": "admin(2021-02-17 04:27:54)"
}
],
"totalrecords": "2",
"totaltasks": "2"
}
{
"errorCode": "0",
"msg": "Successful",
"tasks": [
{
"ACCOUNT": "bsimpson5",
"COMMENTS": "add a comment",
"CREATIONDATE": "2021-01-04 20:27:34",
"ENDDATE": "",
"ENDPOINT": "Active Directory Plus",
"ENDPOINTKEY": "604",
"ENDPOINTNAME": "ActiveDirectoryPlus",
"ENTITLEMENTTYPE": "",
"ENTITLEMENT_VALUEKEY": "",
"OWNERKEY": "admin",
"PARENTTASK": "",
"PROVISIONINGCOMMENTS": "",
"PROVISIONINGMETADATA": "",
"REQUESTACCESSKEY": "",
"REQUESTID": "",
"REQUESTKEY": "",
"SECURITYSYSTEM": "Active Directory Plus",
"STARTDATE": "",
"STATUS": "New",
"TASKID": "10642653",
"TASKTYPE": "Change Password",
"UPDATEDATE": "2021-01-04 20:27:34",
"USER": "bsimpson5",
"upadteuser": "bsimpson5(2021-01-04 20:27:34)"
},
{
"ACCOUNT": "$1V9000-2LO73GT330CI",
"COMMENTS": "add a comment",
"CREATIONDATE": "2021-02-17 04:27:54",
"ENDDATE": "",
"ENDPOINT": "Active Directory Plus",
"ENDPOINTKEY": "604",
"ENDPOINTNAME": "ActiveDirectoryPlus",
"ENTITLEMENTTYPE": "",
"ENTITLEMENT_VALUEKEY": "",
"OWNERKEY": "admin",
"PARENTTASK": "",
"PROVISIONINGCOMMENTS": "",
"PROVISIONINGMETADATA": "",
"REQUESTACCESSKEY": "",
"REQUESTID": "",
"REQUESTKEY": "",
"SECURITYSYSTEM": "Active Directory Plus",
"STARTDATE": "",
"STATUS": "New",
"TASKID": "10642774",
"TASKTYPE": "Change Password",
"UPDATEDATE": "2021-02-17 04:27:54",
"USER": "",
"upadteuser": "admin(2021-02-17 04:27:54)"
}
],
"totalrecords": "2",
"totaltasks": "2"
}