Skip to main content

PATCH - Batch patch update check lists

Batch patch update check lists

Request​

  • Method: PATCH
  • Endpoint: /check-lists/batch
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: batch-patch-update-check-lists

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: no Content-Type: application/json Schema: Array<CheckListBatchPatchRequest>

Schema
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CheckListBatchPatchRequest"
  }
}

Example: example-1​

[
  {
    "id": "831d17ae-ac46-419a-8ec1-de614e36ce7d",
    "actionIds": [
      "1cea9223-e7d4-4b12-becc-9482afd7999d",
      "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
    ],
    "tags": [
      "kitchen"
    ]
  }
]

Responses​

200 OK​

Content-Type: application/json Schema: Array<CheckListResponse>

Schema
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CheckListResponse"
  }
}

Example: example-1

[
  {
    "id": "be63c536-6cf3-4866-8970-37a956e3f403",
    "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: Array<ErrorResponse>

Schema
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ErrorResponse"
  }
}

Example: example-1

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": [
        "[UUID]"
      ]
    }
  ]
}

401 Unauthorized​

404 Not Found​

Content-Type: application/json Schema: ErrorResponse

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

Example: example-1

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

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"
}