API.adoc

ARCH API

Table of Contents

• Overview
  • Version information
  • URI scheme
  • Tags
• Resources
  • Api
    • List available jobs
    • Run a job
  • Api/job
    • Download a job output file
    • List the job’s generated output files
    • Download a job output file preview
    • Get the job’s WASAPI output listing
    • Download a job’s sample visualization data
    • Get a job’s state
• Definitions
  • AvailableJob
  • AvailableJobsCategory
  • DatasetFile
  • InputSpec
  • JobState
  • Object
  • SampleVizData
  • Tuple2[String, String]
  • WasapiResponse
  • WasapiResponseFile

Overview

Version information

Version : 2.0.0

URI scheme

Host : localhost:12341
BasePath : /
Schemes : HTTP

Tags

• api : General API

• api/job : Jobs API

Resources

Api

General API

List available jobs

GET /api/available-jobs

Description

List all available jobs, grouped by category

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string

Responses

HTTP Code	Description	Schema
200	The list of available jobs grouped by category	< AvailableJobsCategory > array

Consumes

• nothing

Produces

• application/json

Run a job

POST /api/runjob/{jobid}

Description

Runs a job on a specified collection of input files.

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	jobid required	The UUID of the job type	string
Query	sample optional	Whether to process only a sample of the input records	boolean
Body	inputSpec required	The job files input specification	InputSpec
Body	params optional	Any job-specific parameters	string

Responses

HTTP Code	Description	Schema
200	The initial job state	JobState

Consumes

• application/json

Produces

• application/json

Api/job

Jobs API

Download a job output file

GET /api/job/{uuid}/download/{file}

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	file required	The job output filename	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The file contents	string

Consumes

• nothing

Produces

• application/x-gzip-compressed

List the job’s generated output files

GET /api/job/{uuid}/files

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The list of output files	< DatasetFile > array

Consumes

• nothing

Produces

• application/json

Download a job output file preview

GET /api/job/{uuid}/preview/{file}

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	file required	The job output filename	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The preview contents	string

Consumes

• nothing

Produces

• application/x-gzip-compressed

Get the job’s WASAPI output listing

GET /api/job/{uuid}/result

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The WASAPI result listing	WasapiResponse

Consumes

• nothing

Produces

• application/json

Download a job’s sample visualization data

GET /api/job/{uuid}/sample_viz_data

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The sample visualization data	SampleVizData

Consumes

• nothing

Produces

• application/json

Get a job’s state

GET /api/job/{uuid}/state

Description

Get the state of a specific job run

Parameters

Type	Name	Description	Schema
Header	X-API-KEY required	An API key that’s authorized to act on behalf of X-API-USER	string
Header	X-API-USER required	The user for which this request is being made	string
Path	uuid required	The job run UUID	string

Responses

HTTP Code	Description	Schema
200	The job state	JobState

Consumes

• nothing

Produces

• application/json

Definitions

AvailableJob

Name	Description	Schema
codeUrl required	A link to the job source code	string
description required		string
infoUrl required	A link to information about the job	string
internal required	Whether the job is internal/non-user-facing use only	boolean
name required		string
publishable required	Whether the job output is publishable to archive.org	boolean
uuid required	Unique job type identifier	string

AvailableJobsCategory

Name	Schema
categoryDescription required	string
categoryName required	string
jobs required	< AvailableJob > array

DatasetFile

Name	Schema
accessToken required	string
creationTime required	string
fileType required	string
filename required	string
lineCount required	integer (int64)
md5Checksum optional	string
mimeType required	string
sizeBytes required	integer (int64)

InputSpec

Name	Schema
collectionId optional	string
inputType optional	string
specs optional	< InputSpec > array
type required	string
uuid optional	string

JobState

Name	Schema
activeStage required	string
activeState required	string
failed required	boolean
finished required	boolean
finishedTime optional	string
id required	string
name required	string
queue optional	string
queuePos optional	integer (int32)
sample required	integer (int32)
startTime optional	string
started required	boolean
state required	string
uuid required	string

Object

SampleVizData

Name	Schema
edges optional	< Tuple2[String, String] > array
nodes required	< Tuple2[String, String] > array

Tuple2[String, String]

Name	Schema
_1 required	Object
_2 required	Object

WasapiResponse

Name	Schema
count required	integer (int32)
files required	< WasapiResponseFile > array
next optional	string
previous optional	string

WasapiResponseFile

Name	Schema
checksums required	< string > array
collection optional	string
filename required	string
filetype required	string
locations required	< string > array
size required	integer (int64)