Submit Job

Submits a job for optimization.

/submitJob post

post

Submits a job to be queued if necessary and then released for optimization.

Secured by x-api-key

ASO requires API keys for authorizing endpoint requests.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Content-Type: required(string)
Informs the server of the mediatype of the entity-body to be sent in the request.
Example:
```
application/vnd.sciquest.com.quay+json
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.quay+json
```

Body

Media type: application/vnd.sciquest.com.quay+json

Type: object

Properties

consumer: required(one of ASO, JCS, USDA)
Consumer name.
Example:
```
JCS
```
customerId: required(integer)
Customer identifier.
Example:
```
999
```
customerName: required(string)
Customer name. (Max length: 100)
Example:
```
QA
```
eventId: required(integer)
Event identifier.
Example:
```
999999
```
inputFilename: required(string)
Fully qualified location of input file on ASO filesystem. (Max length: 100)
Example:
```
/dgsq/drm/JCS_Input/tester.txt.gz
```
notificationHostname: (string)
ASO Clearsuite notification server hostname or VIP. (Max length: 250)
NOTE: This field is optional and used only within a dev environment to allow a developer to specify their locally configured clearsuite hostname.
Example:
```
aso-csweb.jaggaer.com
```
notificationPort: (integer)
ASO Clearsuite notification server hostname or VIP port.
NOTE: This field is optional and used only within a dev environment to allow a developer to specify their locally configured clearsuite port.
Example:
```
80
```

Example:

{
  "consumer": "JCS",
  "customerId": 999,
  "customerName": "QA",
  "eventId": 999999,
  "inputFilename": "/dgsq/drm/JCS_Input/tester.txt.gz"
}

HTTP status code 200

Success; A 200 (Success) response indicates that the request was processed and that the job was successfully submitted.

Status	Key	Description
SUCCESS	---	Job submitted to Quay without error.
	jobId	Identifier of the submitted job.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "SUCCESS": [
      {
        "jobId": "401"
      }
    ]
  }
}

HTTP status code 422

A 422 (Unprocessable Entity) response indicates that there was a problem validating the job submission to the Quay service for optimization. The reasons for the failure will be detailed in the response and are defined in the table below.

Status	Key	Description
INVALID_ENUM_VALUE	---	Consumer value does not match valid consumer.
	field	Name of the enum field.
	value	Invalid value of the enum field.
MISSING_REQUIRED_FIELD	---	A required field is missing or empty.
	field	Name of the missing/required field.
EXCEEDED_CHARACTER_LIMIT	---	The referenced field contains a value that exceeds it's established character limit.
	field	Name of the field that exceeded the character limit.
	value	Value that was attempted to be put into the field.
	limit	Character limit of the field.
FILE_NOT_FOUND	---	The input file cannot be found on the ASO filesystem.
	field	Name of the field holding the input file location.
	value	Value of input file location.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

badConsumer:

{
  "statuses": {
    "INVALID_ENUM_VALUE": [
      {
        "field": "consumer",
        "value": "ABC"
      }
    ]
  }
}

fileNotFound:

{
  "statuses": {
    "FILE_NOT_FOUND": [
      {
        "field": "inputFilename",
        "value": "/dgsq/drm/JCS_Input/tester.txt"
      }
    ]
  }
}

HTTP status code 429

A 429 (Too Many Requests) response indicates that the request has been rejected because specific customer optimization limits have been eclipsed. The specific customer limit that was triggered will be detailed in the response and are defined in the table below.

Status	Key	Description
EXCEEDED_DAILY_LIMIT	---	This job submission has exceeded this customer's configured daily limit.
	limit	Customer specific daily limit value.
EXCEEDED_ABSOLUTE_LIMIT	---	This job submission has exceeded this customer's configured limit.
	limit	Customer specific limit value.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "EXCEEDED_DAILY_LIMIT": [
      {
        "limit": "5"
      }
    ]
  }
}

Secured by x-api-key

Headers

X-API-Key: required(string)
API key.

HTTP status code 403

Missing or invalid API key.

Cancel Job

Cancels a job.

/cancelJob/{job-id} post

post

Cancels an in-process job.

Secured by x-api-key

ASO requires API keys for authorizing endpoint requests.

URI Parameters

job-id: required(integer)
Quay job ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Content-Type: required(string)
Informs the server of the mediatype of the entity-body to be sent in the request.
Example:
```
application/vnd.sciquest.com.quay+json
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.quay+json
```

HTTP status code 201

A 201 (No Content) response indicates that the request was processed and that the job was successfully cancelled.

HTTP status code 404

No job found with job ID.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "jobId": "99999"
      }
    ]
  }
}

HTTP status code 422

A 422 (Unprocessable Entity) response indicates that there was a problem cancelling the job specified. The reasons for the failure will be detailed in the response and are defined in the table below.

Status	Key	Description
MISSING_REQUIRED_FIELD	---	A required field is missing or empty.
	field	Name of the missing/required field.
COULD_NOT_BE_CANCELLED	---	The job could not be cancelled. It may have already terminated.
	jobId	Job ID of job that could not be cancelled.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "COULD_NOT_BE_CANCELLED": [
      {
        "jobId": "401"
      }
    ]
  }
}

Secured by x-api-key

Headers

X-API-Key: required(string)
API key.

HTTP status code 403

Missing or invalid API key.

Job Status

Retrieve job status by job ID.

/jobStatus/{job-id} get

get

Returns a job's status based on job ID.

Secured by x-api-key

ASO requires API keys for authorizing endpoint requests.

URI Parameters

job-id: required(integer)
Quay job ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.quay+json
```

HTTP status code 200

Success; Returns job status.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: object

Properties

status: required(one of Received, Queued, Requeued, Optimizing, Completed, Failed, Cancelled, Cancelling, Expired, Limited)
Job status.
Example:
```
Optimizing
```

Example:

{
  "status": "Completed"
}

HTTP status code 404

No job found with job ID.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "jobId": "99999"
      }
    ]
  }
}

Secured by x-api-key

Headers

X-API-Key: required(string)
API key.

HTTP status code 403

Missing or invalid API key.

Job

Retrieve job information by job ID.

/job/{job-id} get

get

Returns a job's information based on job ID.

Secured by x-api-key

ASO requires API keys for authorizing endpoint requests.

URI Parameters

job-id: required(integer)
Quay job ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.quay+json
```

HTTP status code 200

Success; Returns job.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: object

Properties

jobId: required(integer)
Quay job ID.
consumer: required(one of ASO, JCS, USDA)
Consumer name.
Example:
```
JCS
```
customerId: required(integer)
Customer identifier.
Example:
```
999
```
customerName: required(string)
Customer name. (Max length: 100)
Example:
```
QA
```
eventId: required(integer)
Event identifier.
Example:
```
999999
```
inputFilename: required(string)
Fully qualified location of input file on ASO filesystem. (Max length: 100)
Example:
```
/dgsq/drm/JCS_Input/tester.txt.gz
```
status: required(one of Received, Queued, Requeued, Optimizing, Completed, Failed, Cancelled, Cancelling, Expired, Limited)
Job status.
Example:
```
Optimizing
```
jobType: required(one of Short, Long)
Type of job.
Example:
```
Short
```
optSetType: required(one of Short, Long)
Type of optimization set.
Example:
```
Long
```
submitTime: required(integer)
Time that job was submitted. 13-digit unix/epoch time.
Example:
```
1584979461000
```
inprocAtSubmit: required(integer)
Number of other jobs in process at the time this job was submitted.
runClient: required(string)
Hostname of quay-client that ran this job.
Example:
```
clearbox-01.exp.dev.combinenet.com
```
workingDirectory: required(string)
Quay working directory on ASO filesystem.
Example:
```
/dgsq/drm/QUAY_Service/2020/2/23/414
```
processStartTime: required(integer)
Time that the job started running. 13-digit unix/epoch time.
Example:
```
1584979460846
```
processStopTime: required(integer)
Time that the job completed 13-digit unix/epoch time.
Example:
```
1584979462117
```
cpuTime: required(integer)
Elapsed job runtime in milliseconds.
Example:
```
1271
```

Example:

{
  "jobId": 414,
  "consumer": "JCS",
  "customerId": 999,
  "customerName": "QA",
  "eventId": 999999,
  "inputFilename": "/dgsq/drm/JCS_Input/tester.txt.gz",
  "status": "Failed",
  "jobType": "Short",
  "optSetType": "Short",
  "submitTime": 1584979461000,
  "inprocAtSubmit": 0,
  "runClient": "clearbox-01.exp.dev.combinenet.com",
  "workingDirectory": "/dgsq/drm/QUAY_Service/2020/2/23/414",
  "processStartTime": 1584979460846,
  "processStopTime": 1584979460892,
  "cpuTime": 46
}

HTTP status code 404

No job found with job ID.

Body

Media type: application/vnd.sciquest.com.quay+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "jobId": "99999"
      }
    ]
  }
}

Quay Service (QuayAPI) version v26.0.0.4

Submit Job

/submitJob post

post /submitJob

Headers

Body

HTTP status code 200

Body

HTTP status code 422

Body

HTTP status code 429

Body

Secured by x-api-key

Headers

HTTP status code 403

Cancel Job

/cancelJob/{job-id} post

post /cancelJob/{job-id}

URI Parameters

Headers

HTTP status code 201

HTTP status code 404

Body

HTTP status code 422

Body

Secured by x-api-key

Headers

HTTP status code 403

Job Status

/jobStatus/{job-id} get

get /jobStatus/{job-id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 404

Body

Secured by x-api-key

Headers

HTTP status code 403

Job

/job/{job-id} get

get /job/{job-id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 404

Body

Secured by x-api-key

Headers

HTTP status code 403