Skip to main content

DELETE - Delete task executions by series id

Delete task executions by series id

Request​

  • Method: DELETE
  • Endpoint: /task-executions/series/{seriesId}
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: delete-task-executions-by-series-id

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters​

NameInRequiredSchemaDescription
seriesIdpathyesstringexisting series id

Responses​

204 No Content​

400 Bad Request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$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"
}

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