Skip to main content

POST - Create new check list

Create new check list

Request​

  • Method: POST
  • Endpoint: /check-lists
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: create-new-check-list

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: yes Content-Type: application/json Schema: CheckListRequest

Schema
{
  "$ref": "#/components/schemas/CheckListRequest"
}

Example: example-1​

{
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

Responses​

201 OK​

Content-Type: application/json Schema: CheckListResponse

Schema
{
  "$ref": "#/components/schemas/CheckListResponse"
}

Example: example-1

{
  "id": "2e04ee59-c0af-4621-adea-f854d4b8572b",
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

400 Bad request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "validation failed",
  "code": "validation.failed",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "must not be null",
      "code": "validation.notnull.failed",
      "identifier": "tags"
    }
  ]
}

401 Unauthorized​

406 Not Acceptable​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "mismatch in the types of content",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

500 Internal Server Error​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}