> For the complete documentation index, see [llms.txt](https://docs.nodeum.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/metadata.md).

# 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"}}}}},"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"}}}}},"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"}}}}}}
```

## 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"}}}}},"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"}}}}},"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"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/metadata.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.