Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
application/json
Available options:
todo
, done
{
"task": {
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"type": "<string>",
"context": {
"scope": "<string>",
"employee_id": "<string>"
},
"requirement_id": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
{}
],
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"region": {
"id": "<string>",
"name": "<string>"
},
"fee": {
"type": "<string>",
"amount": "<string>"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"type": "<string>",
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
"<any>"
]
},
"manual": {
"type": "<string>",
"steps": [
"<any>"
]
}
},
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
"<any>"
],
"region": {
"id": "<any>",
"name": "<any>"
},
"tags": [
"<any>"
],
"source": "<string>"
}
],
"category": "hr",
"automation_status": "started"
},
"priority": "high",
"is_managed": true
},
"unlocked_tasks": [
{
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"type": "<string>",
"context": {
"scope": "<string>",
"employee_id": "<string>"
},
"requirement_id": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
{}
],
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"region": {
"id": "<string>",
"name": "<string>"
},
"fee": {
"type": "<string>",
"amount": "<string>"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"type": "<string>",
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
"<any>"
]
},
"manual": {
"type": "<string>",
"steps": [
"<any>"
]
}
},
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
"<any>"
],
"region": {
"id": "<any>",
"name": "<any>"
},
"tags": [
"<any>"
],
"source": "<string>"
}
],
"category": "hr",
"automation_status": "started"
},
"priority": "high",
"is_managed": true
}
]
}
Updates the status of the specified requirement task. Question task’s status cannot be updated. Task status can be updated to todo or done only. After a successful update, the updated task is returned.
{
"task": {
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"type": "<string>",
"context": {
"scope": "<string>",
"employee_id": "<string>"
},
"requirement_id": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
{}
],
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"region": {
"id": "<string>",
"name": "<string>"
},
"fee": {
"type": "<string>",
"amount": "<string>"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"type": "<string>",
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
"<any>"
]
},
"manual": {
"type": "<string>",
"steps": [
"<any>"
]
}
},
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
"<any>"
],
"region": {
"id": "<any>",
"name": "<any>"
},
"tags": [
"<any>"
],
"source": "<string>"
}
],
"category": "hr",
"automation_status": "started"
},
"priority": "high",
"is_managed": true
},
"unlocked_tasks": [
{
"id": "<string>",
"title": "<string>",
"status": "todo",
"source": {
"type": "<string>",
"context": {
"scope": "<string>",
"employee_id": "<string>"
},
"requirement_id": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
{}
],
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"due_date": "2023-12-25",
"region": {
"id": "<string>",
"name": "<string>"
},
"fee": {
"type": "<string>",
"amount": "<string>"
},
"eta": {
"estimation": {
"min": 123,
"max": 123,
"unit": "hour"
},
"earliest_date": "2023-11-07T05:31:56Z",
"latest_date": "2023-11-07T05:31:56Z"
},
"tags": [
"certificate-of-good-standing"
],
"default_resolution_name": "manual",
"resolutions": {
"hosted": {
"type": "<string>",
"description": "<string>",
"method": "<string>",
"url": "<string>",
"content_type": "<string>",
"fields": [
"<any>"
]
},
"manual": {
"type": "<string>",
"steps": [
"<any>"
]
}
},
"criteria_met": [
{
"type": "requirement-done",
"reason": "<string>",
"task_id": "<string>"
}
],
"unlocks": [
{
"requirement_id": "<string>",
"title": "<string>",
"definition": "<string>",
"summary": "<string>",
"resources": [
"<any>"
],
"region": {
"id": "<any>",
"name": "<any>"
},
"tags": [
"<any>"
],
"source": "<string>"
}
],
"category": "hr",
"automation_status": "started"
},
"priority": "high",
"is_managed": true
}
]
}
The access token received from the authorization server in the OAuth 2.0 flow.
todo
, done