Skip to main content

POST - Set published flag

Set published flag

Request​

  • Method: POST
  • Endpoint: /task-executions/set-published
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: set-published-flag

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: no Content-Type: application/json Schema: TaskExecutionPublishRequest

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

Example: example-1​

{
  "taskIds": [
    "1808db4a-aa4f-4431-940e-21ba9662721b"
  ],
  "published": true
}

Responses​

200 OK​

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

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