Task_callbacks

Lists all task callbacks.

get

API Key Scope: task_callbacks / index

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

Responses

200

List of task callbacks.

application/json

countintegerRead-onlyOptionalExample: 1

get/tasks/{task_id}/task_callbacks

GET /api/v2/tasks/{task_id}/task_callbacks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task callbacks.

{
  "count": 1,
  "task_callbacks": [
    {
      "id": "text",
      "type": "filter",
      "language": "javascript",
      "script": "text"
    }
  ]
}

Creates a new task callback.

post

API Key Scope: task_callbacks / create

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

Body

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

languagestring · enumOptionalPossible values:

scriptstringOptional

Responses

201

A specific task callback.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

languagestring · enumOptionalPossible values:

scriptstringOptional

422

The received resource was not correctly formatted.

application/json

post/tasks/{task_id}/task_callbacks

POST /api/v2/tasks/{task_id}/task_callbacks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "type": "filter",
  "language": "javascript",
  "script": "text"
}

{
  "id": "text",
  "type": "filter",
  "language": "javascript",
  "script": "text"
}

Displays a specific task callback.

get

API Key Scope: task_callbacks / show

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

task_callback_idstringRequired

ID of task callback.

Responses

200

A specific task callback.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

languagestring · enumOptionalPossible values:

scriptstringOptional

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get/tasks/{task_id}/task_callbacks/{task_callback_id}

GET /api/v2/tasks/{task_id}/task_callbacks/{task_callback_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": "text",
  "type": "filter",
  "language": "javascript",
  "script": "text"
}

Updates a specific task callback.

put

API Key Scope: task_callbacks / update

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

task_callback_idstringRequired

ID of task callback.

Body

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

languagestring · enumOptionalPossible values:

scriptstringOptional

Responses

200

A specific task callback.

application/json

idstring · int64Read-onlyOptional

typestring · enumOptionalPossible values:

languagestring · enumOptionalPossible values:

scriptstringOptional

422

The received resource was not correctly formatted.

application/json

put/tasks/{task_id}/task_callbacks/{task_callback_id}

PUT /api/v2/tasks/{task_id}/task_callbacks/{task_callback_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "type": "filter",
  "language": "javascript",
  "script": "text"
}

{
  "id": "text",
  "type": "filter",
  "language": "javascript",
  "script": "text"
}

Destroys a specific task callback.

delete

API Key Scope: task_callbacks / destroy

Authorizations

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

ID or name of task. Task names are not unique, it's recommended to use ID.

task_callback_idstringRequired

ID of task callback.

Responses

204

Task callback destroyed.

No content

delete/tasks/{task_id}/task_callbacks/{task_callback_id}

DELETE /api/v2/tasks/{task_id}/task_callbacks/{task_callback_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Task callback destroyed.

No content