Skip to main content
PATCH
/
v2
/
tasks
/
{task_id}
{
  "task": {
    "id": "<string>",
    "title": "<string>",
    "status": "todo",
    "source": {
      "context": {
        "employee_id": "<string>",
        "scope": "employee"
      },
      "requirement_id": "<string>",
      "definition": "<string>",
      "resources": [
        {}
      ],
      "region": {
        "id": "<string>",
        "name": "<string>"
      },
      "default_resolution_name": "manual",
      "resolutions": {
        "hosted": {
          "description": "<string>",
          "method": "<string>",
          "url": "<string>",
          "content_type": "<string>",
          "fields": [
            {
              "name": "<string>",
              "description": "<string>",
              "required": true,
              "type": "<string>"
            }
          ],
          "type": "hosted"
        },
        "manual": {
          "steps": [
            {
              "id": "<string>",
              "title": "<string>",
              "description": "<string>",
              "paths": [
                {
                  "type": "<string>",
                  "value": "<string>",
                  "text": "<string>"
                }
              ],
              "order": 123
            }
          ],
          "type": "manual"
        }
      },
      "category": "hr",
      "type": "requirement",
      "summary": "<string>",
      "period_start_date": "2023-12-25",
      "period_end_date": "2023-12-25",
      "due_date": "2023-12-25",
      "fee": {
        "amount": "<string>",
        "type": "fixed"
      },
      "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"
      ],
      "criteria_met": [
        {
          "type": "requirement-done",
          "reason": "<string>",
          "task_id": "<string>"
        }
      ],
      "unlocks": [
        {
          "requirement_id": "<string>",
          "title": "<string>",
          "definition": "<string>",
          "resources": [
            {}
          ],
          "region": {
            "id": "<string>",
            "name": "<string>"
          },
          "summary": "<string>",
          "tags": [
            "certificate-of-good-standing"
          ],
          "source": "requirement"
        }
      ],
      "automation_status": "started"
    },
    "priority": "medium",
    "is_managed": false
  },
  "unlocked_tasks": [
    {
      "id": "<string>",
      "title": "<string>",
      "status": "todo",
      "source": {
        "context": {
          "employee_id": "<string>",
          "scope": "employee"
        },
        "requirement_id": "<string>",
        "definition": "<string>",
        "resources": [
          {}
        ],
        "region": {
          "id": "<string>",
          "name": "<string>"
        },
        "default_resolution_name": "manual",
        "resolutions": {
          "hosted": {
            "description": "<string>",
            "method": "<string>",
            "url": "<string>",
            "content_type": "<string>",
            "fields": [
              {
                "name": "<string>",
                "description": "<string>",
                "required": true,
                "type": "<string>"
              }
            ],
            "type": "hosted"
          },
          "manual": {
            "steps": [
              {
                "id": "<string>",
                "title": "<string>",
                "description": "<string>",
                "paths": [
                  {
                    "type": "<string>",
                    "value": "<string>",
                    "text": "<string>"
                  }
                ],
                "order": 123
              }
            ],
            "type": "manual"
          }
        },
        "category": "hr",
        "type": "requirement",
        "summary": "<string>",
        "period_start_date": "2023-12-25",
        "period_end_date": "2023-12-25",
        "due_date": "2023-12-25",
        "fee": {
          "amount": "<string>",
          "type": "fixed"
        },
        "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"
        ],
        "criteria_met": [
          {
            "type": "requirement-done",
            "reason": "<string>",
            "task_id": "<string>"
          }
        ],
        "unlocks": [
          {
            "requirement_id": "<string>",
            "title": "<string>",
            "definition": "<string>",
            "resources": [
              {}
            ],
            "region": {
              "id": "<string>",
              "name": "<string>"
            },
            "summary": "<string>",
            "tags": [
              "certificate-of-good-standing"
            ],
            "source": "requirement"
          }
        ],
        "automation_status": "started"
      },
      "priority": "medium",
      "is_managed": false
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

task_id
string
required

Body

application/json
status
enum<string>
required
Available options:
todo,
done

Response

Successful Response

task
PlatformTask · object
required
unlocked_tasks
PlatformTask · object[]
required