# Metadata

## List task metadata definitions

> \*\*API Key Scope\*\*: task\_metadata\_definitions / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_metadata_definitions_index":{"description":"List of task metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_metadata_definition_collection"}}}}},"schemas":{"task_metadata_definition_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_metadata_definitions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_metadata_definition"}}}},"task_metadata_definition":{"allOf":[{"$ref":"#/components/schemas/metadata_definition"},{"type":"object","properties":{"type":{"type":"string","enum":["input_text","text_area","checkbox","radio"]},"apply_active_archive":{"type":"integer"},"apply_offline_archive":{"type":"integer"},"apply_data_migration":{"type":"integer"},"apply_data_exchange":{"type":"integer"},"apply_maintenance":{"type":"integer"}}}]},"metadata_definition":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"key":{"type":"string"},"name":{"type":"string"},"mandatory":{"type":"integer"},"type":{"type":"string","enum":["input_text","text_area","checkbox","radio","multi_text"]},"comment":{"type":"string"}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}}}},"paths":{"/task_metadata_definitions":{"get":{"summary":"List task metadata definitions","description":"**API Key Scope**: task_metadata_definitions / index","tags":["metadata"],"operationId":"index_task_metadata_definitions","responses":{"200":{"$ref":"#/components/responses/task_metadata_definitions_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"}]}}}}
```

## Displays a specific task metadata definition.

> \*\*API Key Scope\*\*: task\_metadata\_definitions / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_metadata_definitions_show":{"description":"A specific task metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_metadata_definition"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"task_metadata_definition":{"allOf":[{"$ref":"#/components/schemas/metadata_definition"},{"type":"object","properties":{"type":{"type":"string","enum":["input_text","text_area","checkbox","radio"]},"apply_active_archive":{"type":"integer"},"apply_offline_archive":{"type":"integer"},"apply_data_migration":{"type":"integer"},"apply_data_exchange":{"type":"integer"},"apply_maintenance":{"type":"integer"}}}]},"metadata_definition":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"key":{"type":"string"},"name":{"type":"string"},"mandatory":{"type":"integer"},"type":{"type":"string","enum":["input_text","text_area","checkbox","radio","multi_text"]},"comment":{"type":"string"}}},"model_error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}},"paths":{"/task_metadata_definitions/{metadata_definition_id}":{"get":{"summary":"Displays a specific task metadata definition.","description":"**API Key Scope**: task_metadata_definitions / show","tags":["metadata"],"operationId":"show_task_metadata_definition","responses":{"200":{"$ref":"#/components/responses/task_metadata_definitions_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## List file metadata definitions

> \*\*API Key Scope\*\*: file\_metadata\_definitions / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"file_metadata_definitions_index":{"description":"List of file metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_metadata_definition_collection"}}}}},"schemas":{"file_metadata_definition_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"file_metadata_definitions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/file_metadata_definition"}}}},"file_metadata_definition":{"allOf":[{"$ref":"#/components/schemas/metadata_definition"}]},"metadata_definition":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"key":{"type":"string"},"name":{"type":"string"},"mandatory":{"type":"integer"},"type":{"type":"string","enum":["input_text","text_area","checkbox","radio","multi_text"]},"comment":{"type":"string"}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}}}},"paths":{"/file_metadata_definitions":{"get":{"summary":"List file metadata definitions","description":"**API Key Scope**: file_metadata_definitions / index","tags":["metadata"],"operationId":"index_file_metadata_definitions","responses":{"200":{"$ref":"#/components/responses/file_metadata_definitions_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"}]}}}}
```

## Displays a specific task metadata definition.

> \*\*API Key Scope\*\*: file\_metadata\_definitions / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"file_metadata_definitions_show":{"description":"A specific file metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_metadata_definition"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"file_metadata_definition":{"allOf":[{"$ref":"#/components/schemas/metadata_definition"}]},"metadata_definition":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"key":{"type":"string"},"name":{"type":"string"},"mandatory":{"type":"integer"},"type":{"type":"string","enum":["input_text","text_area","checkbox","radio","multi_text"]},"comment":{"type":"string"}}},"model_error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}},"paths":{"/file_metadata_definitions/{metadata_definition_id}":{"get":{"summary":"Displays a specific task metadata definition.","description":"**API Key Scope**: file_metadata_definitions / show","tags":["metadata"],"operationId":"show_file_metadata_definition","responses":{"200":{"$ref":"#/components/responses/file_metadata_definitions_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```