Reference Files

Return list of reference files

get

API Key Scope: reference_files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

List of reference file

application/json

reference_file[]Optional

get/reference_files

HTTPcURLJavaScriptPython

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

200

List of reference file

[]

Upload a reference file to be parsed

post

API Key Scope: reference_files / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

multipart/form-data

xmlstring · binaryRequired

Reference file to upload.

Responses

201

Uploaded file

application/json

anyOptional

post/reference_files

HTTPcURLJavaScriptPython

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"
}

201

Uploaded file

No content

Return a parsed reference file

get

API Key Scope: reference_files / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Responses

200

Show an analyzed reference file

application/json

anyOptional

get/reference_files/{reference_file_id}

HTTPcURLJavaScriptPython

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

200

Show an analyzed reference file

No content

Update the list of parsed file in a reference file

put

API Key Scope: reference_files / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Body

application/json

anyOptional

Responses

200

Show an analyzed reference file

application/json

anyOptional

put/reference_files/{reference_file_id}

HTTPcURLJavaScriptPython

PUT /api/v2/reference_files/{reference_file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200

Show an analyzed reference file

No content

Destroys a reference file.

delete

API Key Scope: reference_files / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Responses

200

Reference file destroyed.

No content

delete/reference_files/{reference_file_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/reference_files/{reference_file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

Reference file destroyed.

No content

Scan a parsed reference file

put

API Key Scope: reference_files / scan

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Body

application/json

anyOptional

Responses

200

Show an analyzed reference file

application/json

anyOptional

put/reference_files/{reference_file_id}/scan

HTTPcURLJavaScriptPython

PUT /api/v2/reference_files/{reference_file_id}/scan HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

200

Show an analyzed reference file

No content

Check result of task sources creation

get

API Key Scope: reference_files / create_task_sources

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Query parameters

job_idstringRequired

ID of active job

Responses

200

An active job that may be queued, working, completed or failed.

application/json

job_idstringRead-onlyOptionalExample: 6f4d759d-48e9-43c8-ab24-640f5ea63922

statusstring · enumRead-onlyOptionalExample: workingPossible values:

progressintegerRead-onlyOptionalExample: 2

totalintegerRead-onlyOptionalExample: 6

202

An active job that may be queued, working, completed or failed.

application/json

get/reference_files/{reference_file_id}/task_sources

HTTPcURLJavaScriptPython

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"
}

Create task sources from a reference file

post

API Key Scope: reference_files / create_task_sources

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

reference_file_idstringRequired

Body

application/json

task_idintegerRequired

container_idsinteger[]Optional

pool_idintegerOptional

Responses

202

An active job that may be queued, working, completed or failed.

application/json

job_idstringRead-onlyOptionalExample: 6f4d759d-48e9-43c8-ab24-640f5ea63922

statusstring · enumRead-onlyOptionalExample: workingPossible values:

progressintegerRead-onlyOptionalExample: 2

totalintegerRead-onlyOptionalExample: 6

post/reference_files/{reference_file_id}/task_sources

HTTPcURLJavaScriptPython

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
}

202

An active job that may be queued, working, completed or failed.

{
  "job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
  "status": "queued"
}