Reference_files
API Key Scope: reference_files / index
Pass the username and password of a user in the authorization header. This currently gives full access.
List of reference file
GET /api/v2/reference_files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of reference file
[]API Key Scope: reference_files / create
Pass the username and password of a user in the authorization header. This currently gives full access.
Reference file to upload.
Uploaded file
POST /api/v2/reference_files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 16
{
"xml": "binary"
}Uploaded file
No content
API Key Scope: reference_files / show
Pass the username and password of a user in the authorization header. This currently gives full access.
Show an analyzed reference file
GET /api/v2/reference_files/{reference_file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Show an analyzed reference file
No content
API Key Scope: reference_files / update
Pass the username and password of a user in the authorization header. This currently gives full access.
Show an analyzed reference file
PUT /api/v2/reference_files/{reference_file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Show an analyzed reference file
No content
API Key Scope: reference_files / destroy
Pass the username and password of a user in the authorization header. This currently gives full access.
Reference file destroyed.
No content
DELETE /api/v2/reference_files/{reference_file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Reference file destroyed.
No content
API Key Scope: reference_files / scan
Pass the username and password of a user in the authorization header. This currently gives full access.
Show an analyzed reference file
PUT /api/v2/reference_files/{reference_file_id}/scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Show an analyzed reference file
No content
API Key Scope: reference_files / create_task_sources
Pass the username and password of a user in the authorization header. This currently gives full access.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/reference_files/{reference_file_id}/task_sources?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: reference_files / create_task_sources
Pass the username and password of a user in the authorization header. This currently gives full access.
An active job that may be queued, working, completed or failed.
POST /api/v2/reference_files/{reference_file_id}/task_sources HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"task_id": 1,
"container_ids": [
1
],
"pool_id": 1
}An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}Last updated
Was this helpful?