{
"basePath": "/",
"swaggerVersion": "1.1",
"apiVersion": "0.1",
"apis": [
{
"operations": [
{
"errorResponses": [
{
"reason": "is returned if no job-id was specified in the request. In this case, no x-arango-async-id HTTP header will be returned. ",
"code": "400"
},
{
"reason": "is returned if the job was not found or already deleted or fetched from the job result list. In this case, no x-arango-async-id HTTP header will be returned. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "job-id",
"description": "The async job id. "
}
],
"notes": "Returns the result of an async job identified by job-id. If the async job result is present on the server, the result will be removed from the list of result. That means this method can be called for each job-id once.
The method will return the original job result's headers and body, plus the additional HTTP header x-arango-async-job-id. If this header is present, then the job was found and the response contains the original job's result. If the header is not present, the job was not found and the response contains status information from the job amanger.
",
"summary": "Returns the result of an async job",
"httpMethod": "PUT",
"examples": "Not providing a job-id:
unix> curl -X PUT --dump - http://localhost:8529/_api/job/\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"bad parameter\",\"code\":400,\"errorNum\":400}\n\n
Providing a job-id for a non-existing job:
unix> curl -X PUT --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"not found\",\"code\":404,\"errorNum\":404}\n\n
Fetching the result of an HTTP GET job:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409420199\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409420199\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409420199\n\n{\"server\":\"arango\",\"version\":\"1.4.3\"}\n\n
Fetching the result of an HTTP POST job that failed:
unix> curl -X POST --header 'x-arango-async: store' --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\" this name is invalid \"}\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409485735\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409485735\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409485735\n\n{\"error\":true,\"code\":400,\"errorNum\":1208,\"errorMessage\":\"cannot create collection: illegal name\"}\n\n
",
"nickname": "ReturnsTheResultOfAnAsyncJob"
}
],
"path": "/_api/job/{job-id}"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "is returned if the list can be compiled successfully. Note: the list might be empty. ",
"code": "200"
},
{
"reason": "is returned if type is not specified or has an invalid value. ",
"code": "400"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "type",
"description": "The type of jobs to return. The type can be either done or pending. Setting the type to done will make the method return the ids of already completed async jobs for which results can be fetched. Setting the type to pending will return the ids of not yet finished async jobs. "
},
{
"dataType": "Number",
"paramType": "query",
"name": "count",
"description": "The maximum number of ids to return per call. If not specified, a server-defined maximum value will be used. "
}
],
"notes": "Returns the list of ids of async jobs with a specific status (either done or pending). The list can be used by the client to get an overview of the job system status and to retrieve completed job results later.
",
"summary": "Returns the list of job result ids with a specific status",
"httpMethod": "GET",
"examples": "Fetching the list of done jobs:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409551271\n\nunix> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n \"409551271\" \n]\n\n
Fetching the list of pending jobs:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409616807\n\nunix> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ ]\n\n
",
"nickname": "ReturnsTheListOfJobResultIdsWithASpecificStatus"
}
],
"path": "/_api/job/{type}"
},
{
"operations": [
{
"errorResponses": [
{
"reason": "is returned if the deletion operation was carried out successfully. This code will also be returned if no results were deleted. ",
"code": "200"
},
{
"reason": "is returned if type is not specified or has an invalid value. ",
"code": "400"
},
{
"reason": "is returned if type is a job-id but no async job with the specified id was found. ",
"code": "404"
}
],
"parameters": [
{
"dataType": "String",
"paramType": "path",
"required": "true",
"name": "type",
"description": "The type of jobs to delete. type can be: "
},
{
"dataType": "Number",
"paramType": "query",
"name": "stamp",
"description": "A UNIX timestamp specifying the expiration threshold when type is expired. "
}
],
"notes": "Deletes either all job results, expired job results, or the result of a specific job. Clients can use this method to perform an eventual garbage collection of job results.
",
"summary": "Deletes the result of async jobs",
"httpMethod": "DELETE",
"examples": "Deleting all jobs:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409682343\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n
Deleting expired jobs:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409747879\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1385372569\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n
Deleting the result of a specific job:
unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409813415\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/409813415\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n
Deleting the result of a non-existing job:
unix> curl -X DELETE --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"not found\", \n \"code\" : 404, \n \"errorNum\" : 404 \n}\n\n
",
"nickname": "DeletesTheResultOfAsyncJobs"
}
],
"path": "/_api/job/{type}"
}
]
}