HomepageBlog

Task_metadata

Lists all task metadata.

get

API Key Scope: task_metadata / index

Authorizations
Path parameters
task_idstringRequired

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

Query parameters
limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

keystringOptional

Filter on key

valuestringOptional

Filter on value

Responses
200

List of task metadata.

application/json
get
/tasks/{task_id}/task_metadata
GET /api/v2/tasks/{task_id}/task_metadata HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

List of task metadata.

{
  "count": 1,
  "task_metadata": [
    {
      "id": 1,
      "key": "text",
      "value": "text"
    }
  ]
}

Creates a new task metadatum.

post

API Key Scope: task_metadata / create

Authorizations
Path parameters
task_idstringRequired

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

Body
idinteger · int64Read-onlyOptional
keystringOptional
valuestringOptional
Responses
201

A specific task metadatum.

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

{
  "key": "text",
  "value": "text"
}
{
  "id": 1,
  "key": "text",
  "value": "text"
}

Displays a specific task metadatum.

get

API Key Scope: task_metadata / show

Authorizations
Path parameters
task_idstringRequired

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

task_metadatum_idintegerRequired

Numeric ID of task metadatum.

Responses
200

A specific task metadatum.

application/json
get
/tasks/{task_id}/task_metadata/{task_metadatum_id}
GET /api/v2/tasks/{task_id}/task_metadata/{task_metadatum_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

A specific task metadatum.

{
  "id": 1,
  "key": "text",
  "value": "text"
}

Updates a specific task metadatum.

put

API Key Scope: task_metadata / update

Authorizations
Path parameters
task_idstringRequired

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

task_metadatum_idintegerRequired

Numeric ID of task metadatum.

Body
idinteger · int64Read-onlyOptional
keystringOptional
valuestringOptional
Responses
200

A specific task metadatum.

application/json
put
/tasks/{task_id}/task_metadata/{task_metadatum_id}
PUT /api/v2/tasks/{task_id}/task_metadata/{task_metadatum_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}
{
  "id": 1,
  "key": "text",
  "value": "text"
}

Destroys a specific task metadatum.

delete

API Key Scope: task_metadata / destroy

Authorizations
Path parameters
task_idstringRequired

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

task_metadatum_idintegerRequired

Numeric ID of task metadatum.

Responses
204

Task metadatum destroyed.

No content
delete
/tasks/{task_id}/task_metadata/{task_metadatum_id}
DELETE /api/v2/tasks/{task_id}/task_metadata/{task_metadatum_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Task metadatum destroyed.

No content

Last updated

Was this helpful?