Metadata | Nodeum Docs

List task metadata definitions

get

API Key Scope: task_metadata_definitions / index

Authorizations

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 metadata

application/json

get

/task_metadata_definitions

GET /api/v2/task_metadata_definitions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task metadata

{
  "count": 1,
  "task_metadata_definitions": [
    {
      "id": 1,
      "key": "my_metadata",
      "name": "My Metadata",
      "mandatory": 1,
      "type": "input_text",
      "comment": "text",
      "apply_active_archive": 1,
      "apply_offline_archive": 1,
      "apply_data_migration": 1,
      "apply_data_exchange": 1,
      "apply_maintenance": 1
    }
  ]
}

Displays a specific task metadata definition.

get

API Key Scope: task_metadata_definitions / show

Authorizations

Path parameters

metadata_definition_idstringRequired

Numeric ID or key of a metadata definition

Responses

200

A specific task metadata

application/json

Responseall of

404

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

application/json

get

/task_metadata_definitions/{metadata_definition_id}

GET /api/v2/task_metadata_definitions/{metadata_definition_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "key": "my_metadata",
  "name": "My Metadata",
  "mandatory": 1,
  "type": "input_text",
  "comment": "text",
  "apply_active_archive": 1,
  "apply_offline_archive": 1,
  "apply_data_migration": 1,
  "apply_data_exchange": 1,
  "apply_maintenance": 1
}

List file metadata definitions

get

API Key Scope: file_metadata_definitions / index

Authorizations

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

Responses

200

List of file metadata

application/json

get

/file_metadata_definitions

GET /api/v2/file_metadata_definitions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of file metadata

{
  "count": 1,
  "file_metadata_definitions": [
    {
      "id": 1,
      "key": "my_metadata",
      "name": "My Metadata",
      "mandatory": 1,
      "type": "input_text",
      "comment": "text"
    }
  ]
}

Displays a specific task metadata definition.

get

API Key Scope: file_metadata_definitions / show

Authorizations

Path parameters

metadata_definition_idstringRequired

Numeric ID or key of a metadata definition

Responses

200

A specific file metadata

application/json

Responseall of

404

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

application/json

get

/file_metadata_definitions/{metadata_definition_id}

GET /api/v2/file_metadata_definitions/{metadata_definition_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "key": "my_metadata",
  "name": "My Metadata",
  "mandatory": 1,
  "type": "input_text",
  "comment": "text"
}