# Reference\_files

## Return list of reference files

> \*\*API Key Scope\*\*: reference\_files / 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":{"reference_files_index":{"description":"List of reference file","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"./refparser.yml#/components/schemas/reference_file"}}}}}}},"paths":{"/reference_files":{"get":{"operationId":"index_reference_files","summary":"Return list of reference files","description":"**API Key Scope**: reference_files / index","tags":["reference_files"],"responses":{"200":{"$ref":"#/components/responses/reference_files_index"}}}}}}
```

## Upload a reference file to be parsed

> \*\*API Key Scope\*\*: reference\_files / create

```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":{"upload":{"description":"Uploaded file","content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/reference_file"}}}}}},"paths":{"/reference_files":{"post":{"operationId":"create_reference_file","summary":"Upload a reference file to be parsed","description":"**API Key Scope**: reference_files / create","tags":["reference_files"],"responses":{"201":{"$ref":"#/components/responses/upload"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["xml"],"properties":{"xml":{"type":"string","description":"Reference file to upload.","format":"binary"}}}}},"required":true}}}}}
```

## Return a parsed reference file

> \*\*API Key Scope\*\*: reference\_files / 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":{"reference_file_show":{"description":"Show an analyzed reference file","content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/analyzed_reference_file"}}}}}},"paths":{"/reference_files/{reference_file_id}":{"get":{"operationId":"show_reference_file","summary":"Return a parsed reference file","description":"**API Key Scope**: reference_files / show","tags":["reference_files"],"responses":{"200":{"$ref":"#/components/responses/reference_file_show"}}}}}}
```

## Update the list of parsed file in a reference file

> \*\*API Key Scope\*\*: reference\_files / update

```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":{"reference_file_show":{"description":"Show an analyzed reference file","content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/analyzed_reference_file"}}}}},"requestBodies":{"reference_file_update_body":{"content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/reference_file_update_request"}}},"required":true}}},"paths":{"/reference_files/{reference_file_id}":{"put":{"operationId":"update_reference_file","summary":"Update the list of parsed file in a reference file","description":"**API Key Scope**: reference_files / update","tags":["reference_files"],"responses":{"200":{"$ref":"#/components/responses/reference_file_show"}},"requestBody":{"$ref":"#/components/requestBodies/reference_file_update_body"}}}}}
```

## Destroys a reference file.

> \*\*API Key Scope\*\*: reference\_files / destroy

```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"}}},"paths":{"/reference_files/{reference_file_id}":{"delete":{"summary":"Destroys a reference file.","operationId":"destroy_reference_file","description":"**API Key Scope**: reference_files / destroy","tags":["reference_files"],"responses":{"200":{"description":"Reference file destroyed."}}}}}}
```

## Scan a parsed reference file

> \*\*API Key Scope\*\*: reference\_files / scan

```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":{"reference_file_show":{"description":"Show an analyzed reference file","content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/analyzed_reference_file"}}}}},"requestBodies":{"reference_file_scan_body":{"content":{"application/json":{"schema":{"$ref":"./refparser.yml#/components/schemas/reference_file_scan_request"}}},"required":true}}},"paths":{"/reference_files/{reference_file_id}/scan":{"put":{"operationId":"scan_reference_file","summary":"Scan a parsed reference file","description":"**API Key Scope**: reference_files / scan","tags":["reference_files"],"responses":{"200":{"$ref":"#/components/responses/reference_file_show"}},"requestBody":{"$ref":"#/components/requestBodies/reference_file_scan_body"}}}}}
```

## Check result of task sources creation

> \*\*API Key Scope\*\*: reference\_files / create\_task\_sources

```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/reference_files/{reference_file_id}/task_sources":{"get":{"operationId":"create_task_sources_from_reference_file_result","summary":"Check result of task sources creation","description":"**API Key Scope**: reference_files / create_task_sources","tags":["reference_files"],"responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```

## Create task sources from a reference file

> \*\*API Key Scope\*\*: reference\_files / create\_task\_sources

```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}},"reference_file_task_sources":{"required":["task_id"],"type":"object","properties":{"task_id":{"type":"integer"},"container_ids":{"type":"array","items":{"type":"integer"}},"pool_id":{"type":"integer"}}}},"requestBodies":{"task_sources_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reference_file_task_sources"}}},"required":true}}},"paths":{"/reference_files/{reference_file_id}/task_sources":{"post":{"operationId":"create_task_sources_from_reference_file","summary":"Create task sources from a reference file","description":"**API Key Scope**: reference_files / create_task_sources","tags":["reference_files"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}},"requestBody":{"$ref":"#/components/requestBodies/task_sources_body"}}}}}
```


---

# Agent Instructions: 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/reference_files.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.