Boarding Tasks

List of valid attributes:

Attribute	Description	Specifics
assignee_id	ID of the user assigned	UUID of the user or blank
description	Description of the task	Type string
discarded_at	Date of removal	Null or timestamp, cannot be set
name	Name of the task	Type string, 50 characters max
boarding_id	ID of the on- or offboarding the task belongs to	UUID of boarding, cannot be blank and cannot be set
boarding_stage_id	ID of the on- or offboarding stage the task belongs to	UUID of the stage, Can’t be blank
status	Status of the task	Must be either todo, in_progress or done

The following relationships can be included in requests:

Relationship	Type
assignee	belongs to
boarding_stage	belongs to

Create

Example request:

{
  "data": {
    "type": "boarding_task",
    "data": {
      "attributes": {
        "name": "Task Name",
        "boarding_stage_id": "459e0b1e-caa0-4960-be61-dad0dbcd969e",
        "status": "todo"
      }
    }
  }
}

Example response:

{
  "data": {
    "id": "52370ab1-7d08-4a03-b0ac-4ba63c8f209d",
    "type": "boarding_task",
    "attributes": {
      ...
    }
  }
}

This endpoint adds a new task to an on- or offboarding.

HTTP Request

POST /api/v1/boardings/:boarding_id/boarding_tasks

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding to which the new task will be added

Update

Example request:

{
  "data": {
    "type": "boarding_task",
    "attributes": {
      "name": "Updated Task"
    }
  }
}

Example response:

{
  "data": {
    "id": "2474c2c0-3623-412a-9f06-3b9944983407",
    "type": "boarding_task",
    "attributes": {
      ...
    }
  }
}

This endpoint updates a task in an on- or offboarding.

HTTP Request

PUT /api/v1/boardings/:boarding_id/boarding_tasks/:boarding_task_id

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding the task belongs to
boarding_task_id	ID of the task to be updated

List

This endpoint returns JSON structured like this:

{
  "data": [
    {
      "id": "4dc62052-5134-4d0f-a236-78b16c7575bf",
      "data": {
        "type": "boarding_task",
        "attributes": {
          ...
        }
      },
      "meta": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns boarding tasks for an on- or offboarding.

HTTP Request

GET /api/v1/boardings/:boarding_id/boarding_tasks

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding from which to return tasks

Delete

Example response:

{
  "data": {
    "id": "2ce7ed10-90d4-45da-b284-67966f488e2d",
    "type": "boarding_task",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes an on- or offboarding task.

HTTP Request

DELETE /api/v1/boardings/:boarding_id/boarding_tasks/:boarding_task_id

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding from which to delete the task
boarding_task_id	The ID of the on- or offboarding task to delete

Show

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "boarding_task",
    "attributes": {
      ...
    }
  }
}

This endpoint returns a single task of an on- or offboarding.

HTTP Request

GET /api/v1/boardings/:boarding_id/boarding_tasks/:boarding_task_id

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding from which to show a task
boarding_task_id	The ID of the on- or offboarding task to show