Async Status

Retrieve status and status-specific data for an asynchronous file process.

/asyncStatus/{encoded-async-pid} get

get

Returns the status of the asynchronous process associated with the specificed process ID.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

encoded-async-pid: required(string)
Encoded async PID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

HTTP status code 200

Success; Returns an ASO async status entity for the specified encoded async process ID.

When the process reaches a status of completed the response will also contain a resultUrl -- a pre-signed URL used to download the file.

Working With the Result URL (Pre-Signed URL)

The resultUrl that is returned in the response of a completed async process status is used to download the file. The resultUrl will expire when resultUrlExpiresInSeconds reaches 0. Once expired the value returned for resultUrlExpiresInSeconds will be -1.

Pre-Signed URL -- 200 OK

The file streams to the client.

Pre-Signed URL -- 403 Forbidden

If the pre-signed URL has expired, the pre-signed URL will return 403 Forbidden with the following entity-body response:

<Error>
  <Code>AccessDenied</Code>
  <Message>Request has expired</Message>
  <X-Amz-Expires>300</X-Amz-Expires>
  <Expires>2020-09-08T20:05:05Z</Expires>
  <ServerTime>2020-09-09T17:06:17Z</ServerTime>
  <RequestId>XXXXXXXXXXXXXXXX</RequestId>
  <HostId>
    1HRM4RGKorg/xr1zG3f4tE3RyYU23ElyCc9Ih5YwxYcilUcElHWFXtY9OoIeUYiaggboFvRze1k=
  </HostId>
</Error>

Body

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

Type: object

Properties

status: required(one of processing, cancelled, failed, completed)
Example:
```
processing
```
resultUrl: (string)
URL used to download file once async process is in completed state. (Max length: 65k)
NOTE: This field is only visible when status is completed
resultUrlExpiresInSeconds: (integer)
Number of seconds before resultUrl expires.
NOTE: This field is only visible when status is completed
Example:
```
165
```

Examples:

completed:

{
  "status": "completed",
  "resultUrl": "https://s3.us-east-2.amazonaws.com/us-east-2.aso.qa.api.async-downloads/258_22534_50a0a503-a029-4316-894f-3a7fdcf07ab2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210716T154359Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=AKIA5HYMQXHER7KSSZTN%2F20210716%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=7cdbc913ef900e2eef7b5f6bed6a592d056e52d611053976a11e3175d92eb674",
  "resultUrlExpiresInSeconds": 289
}

processing:

{
  "status": "processing"
}

failed:

{
  "status": "failed"
}

cancelled:

{
  "status": "cancelled"
}

HTTP status code 400

Invalid encoded async process ID.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "INVALID_URL_PARAM": [
      {
        "asyncStatus": "MTYyNjQ3MTAxODQwNzoyMjg1MDoxOmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng=="
      }
    ]
  }
}

HTTP status code 403

Request expired; Invalid or unauthorized encoded async process ID.

Body

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

Type: json

Content:

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

Examples:

requestExpired:

{
  "statuses": {
    "REQUEST_EXPIRED": [
      {
        "expiresSeconds": "1800",
        "elapsedSeconds": "1863"
      }
    ]
  }
}

authenticationForbidden1:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "Invalid or missing event-id"
      }
    ]
  }
}

authenticationForbidden2:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "Could not find project for event 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Customer Host FQDN

Retrieves ASO Customer Host fully qualified domain name (FQDN) by Customer Host ID.

/chost/{customer-host-id}/fqdn get

get

Partner system will make back-channel call to this ASO CHES endpoint sending Customer Host ID in path parameter and receiving back JSON payload with ASO (ASAP) Customer Host fully qualified domain name (FQDN).

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(string)
ASO customer host ID.

Headers

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/json
```

HTTP status code 200

Success; Returns customer host FQDN.

Body

Media type: application/json

Type: object

Properties

fqdn: required(string)
ASO Customer host (ASAP) fully qualified domain name (FQDN).
Example:
```
qa.qa-asap-web-04.combinenet.com
```

Example:

{
  "fqdn": "qa.qa-asap-web-04.combinenet.com"
}

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

Media type: application/json

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

HTTP status code 404

Customer Host FQDN could not be found for Customer Host ID supplied.

Body

Media type: application/json

Type: json

Content:

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

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Event from Template by User

Create an ASO event from a template.

/chost/{customer-host-id}/user/{user-id}/template/{template-id}/apiEvent post

post

Create an ASO event entity from the given template for the given user.

Use the GET Templates by User endpoint for available templates.

Create an ASO event entity from the given template for the given user.

Use the GET Templates by User endpoint for available templates.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
user-id: required(integer)
ASO user ID.
template-id: required(integer)
ASO template ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
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.ches+json
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

Body

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

Type: object

Properties

name: required(string)
New event name. (Max length: 50)
Example:
```
ASO Test Event
```
description: required(string)
New event description. (Max length: 255)
Example:
```
Test North American Truckload Event
```
isTestEvent: required(boolean)
Test event indicator flag.
Example:
```
false
```
templateTypeName: required(one of Transportation, Packaging, Indirect Materials, RFxpress, Direct Materials, Services, SD Auction, Multi-Stage, Facilities Management & Services, Routing Network)
Template type name. Use the GET Template Types endpoint for available template types.
Example:
```
Transportation
```
subcategory1: required(string)
Subcategory 1 value. Use the GET Subcategories by Template Type endpoint for available subcategory 1 values.
Example:
```
LTL
```
subcategory2: (union of string or nil)
Subcategory 2 value. Use the GET Subcategories by Template Type endpoint for available subcategory 2 values.
Example:
```
Packaging
```
copySuppliers: required(boolean)
New event should include template's suppliers.
Example:
```
true
```
copyItems: required(boolean)
New event should include template's items.
Example:
```
true
```
copyHistorics: required(boolean)
New event should include template's item historic pricing.
NOTE: Requires that copySuppliers and copyItems be enabled.
Example:
```
true
```
copyRfiAnswers: required(boolean)
New event should include template's RFI Answers.
NOTE: Requires that copySuppliers be enabled.
Example:
```
true
```
userGroupName: (union of string or nil)
User group name.
Example:
```
All Business Center Users
```

Example:

{
  "name": "Albert's Lemon Grove",
  "description": "api test event",
  "isTestEvent": false,
  "templateTypeName": "Transportation",
  "subcategory1": "LTL",
  "subcategory2": "Packaging",
  "copySuppliers": true,
  "copyItems": true,
  "copyHistorics": true,
  "copyRfiAnswers": true,
  "userGroupName": "All Business Center Users"
}

HTTP status code 201

Created;

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "SUCCESS": [
      {
        "eventId": "34633",
        "eventName": "Albert's Lemon Grove"
      }
    ]
  }
}

HTTP status code 400

Bad Request; A 400 Bad Request response indicates that there was one or more issues detected with the request. The response should be parsed to determine the exact nature of the request errors which can be found defined in the table below.

Status	Key	Description
NULL_PAYLOAD	---	Missing entity-request body.
	payload	Value of null further indicates a missing entity-request body.
USER_NOT_FOUND	---	Existing user entity could not be found for user ID given in path parameter.
	userId	Associated user ID.
TEMPLATE_EVENT_NOT_FOUND	---	Existing event template could not be found for template ID given in path parameter.
	templateId	Associated template ID.
UNEXPECTED_TYPE	---	Invalid event type from event template.
	templateId	Associated template ID.
	eventTypeName	Event template event type name.
INSUFFICIENT_PERMISSIONS	---	User does not have permissions to create an event.
	userId	Associated user ID.
MISSING_REQUIRED_FIELD	---	A required field is missing in the request entity-body.
	field	Name of the missing/required field.
ALREADY_EXISTS	---	Duplicate event name.
	field	Indicates the field that triggered the already exists validation failure.
EXCEEDED_CHARACTER_LIMIT	---	The request-entity body contains a value that exceeds a field'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.
INVALID_TEMPLATE_TYPE	---	Request-entity body contains an invalid template type name. Use the GET Template Types endpoint for available template types.
	field	Name of template type name field.
	value	Invalid value that was attempted to be put into template type name field.
INVALID_SUBCATEGORY_1_VALUE	---	Request-entity body contains an invalid subcategory 1 value. Use the GET Subcategories by Template Type endpoint for available subcategory 1 values.
	field	Name of subcategory 1 field.
	value	Invalid value that was attempted to be put into subcategory 1 field.
INVALID_SUBCATEGORY_2_VALUE	---	Request-entity body contains an invalid subcategory 2 value. Use the GET Subcategories by Template Type endpoint for available subcategory 2 values.
	field	Name of subcategory 2 field.
	value	Invalid value that was attempted to be put into subcategory 2 field.
INVALID_USER_GROUP_NAME	---	Request-entity body contains an invalid user group name.
	field	Name of user group name field.
	value	Invalid value that was attempted to be put into user group name field.
REQUIRES_COPY_SUPPLIERS_AND_COPY_ITEMS	---	To copy historics, copy suppliers and copy items must also be selected.
	field	Field selected.
REQUIRES_COPY_SUPPLIERS	---	To RFI answers, copy suppliers must also be selected.
	field	Field selected.

Body

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

Type: json

Content:

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

Examples:

single:

{
  "statuses": {
    "INVALID_SUBCATEGORY_1_VALUE": [
      {
        "field": "subcategory1",
        "value": "Truckload"
      }
    ]
  }
}

multiple:

{
  "statuses": {
    "INVALID_TEMPLATE_TYPE": [
      {
        "field": "templateTypeName",
        "value": "Trans"
      }
    ],
    "EXCEEDED_CHARACTER_LIMIT": [
      {
        "field": "name",
        "limit": "50",
        "value": "Albert's Passion Fruit Grove Special Event August 2019"
      }
    ],
    "REQUIRES_COPY_SUPPLIERS": [
      {
        "field": "copyRfiAnswers"
      }
    ],
    "REQUIRES_COPY_SUPPLIERS_AND_COPY_ITEMS": [
      {
        "field": "copyHistorics"
      }
    ]
  }
}

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Event from Template by User (Asynchronous)

Initiate asynchronous process to create an ASO event from a template.

/chost/{customer-host-id}/user/{user-id}/template/{template-id}/apiEvent/async post

post

Returns a URL that can be used to check the status of the asynchronous process and when the process has completed download the created event details. For a comprehensive introduction to the ASO asynchronous download process see Working With Asynchronous Download Endpoints.

Use the GET Templates by User endpoint for available templates.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
user-id: required(integer)
ASO user ID.
template-id: required(integer)
ASO template ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
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.ches+json
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

Body

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

Type: object

Properties

name: required(string)
New event name. (Max length: 50)
Example:
```
ASO Test Event
```
description: required(string)
New event description. (Max length: 255)
Example:
```
Test North American Truckload Event
```
isTestEvent: required(boolean)
Test event indicator flag.
Example:
```
false
```
templateTypeName: required(one of Transportation, Packaging, Indirect Materials, RFxpress, Direct Materials, Services, SD Auction, Multi-Stage, Facilities Management & Services, Routing Network)
Template type name. Use the GET Template Types endpoint for available template types.
Example:
```
Transportation
```
subcategory1: required(string)
Subcategory 1 value. Use the GET Subcategories by Template Type endpoint for available subcategory 1 values.
Example:
```
LTL
```
subcategory2: (union of string or nil)
Subcategory 2 value. Use the GET Subcategories by Template Type endpoint for available subcategory 2 values.
Example:
```
Packaging
```
copySuppliers: required(boolean)
New event should include template's suppliers.
Example:
```
true
```
copyItems: required(boolean)
New event should include template's items.
Example:
```
true
```
copyHistorics: required(boolean)
New event should include template's item historic pricing.
NOTE: Requires that copySuppliers and copyItems be enabled.
Example:
```
true
```
copyRfiAnswers: required(boolean)
New event should include template's RFI Answers.
NOTE: Requires that copySuppliers be enabled.
Example:
```
true
```
userGroupName: (union of string or nil)
User group name.
Example:
```
All Business Center Users
```

Example:

{
  "name": "Albert's Lemon Grove",
  "description": "api test event",
  "isTestEvent": false,
  "templateTypeName": "Transportation",
  "subcategory1": "LTL",
  "subcategory2": "Packaging",
  "copySuppliers": true,
  "copyItems": true,
  "copyHistorics": true,
  "copyRfiAnswers": true,
  "userGroupName": "All Business Center Users"
}

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The `statusUrl that is returned in the response allows the client to both poll the status of the asynchonous create event process, and once completed, allows the client access to download the created event metadata. For complete details see GET Async Status.

The completed file will contain limited event metadata for the created event in JSON format:

Model:

Status	Key	Description
SUCCESS	---	Event created in ASO without error.
	eventId	Identifier of the created event.
	eventName	Name of the created event.

Data Example:

{
"statuses": {
  "SUCCESS": [
    {
      "eventId": "34633",
      "eventName": "Albert's Lemon Grove"
    }
  ]
}
}

Body

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

Type: object

Properties

statusUrl: required(string)
Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.
Example:
```
https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==
```
statusUrlExpiresInSeconds: required(integer)
Time in seconds before URL expires.
Example:
```
1800
```

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 400

Status	Key	Description
NULL_PAYLOAD	---	Missing entity-request body.
	payload	Value of null further indicates a missing entity-request body.
USER_NOT_FOUND	---	Existing user entity could not be found for user ID given in path parameter.
	userId	Associated user ID.
TEMPLATE_EVENT_NOT_FOUND	---	Existing event template could not be found for template ID given in path parameter.
	templateId	Associated template ID.
UNEXPECTED_TYPE	---	Invalid event type from event template.
	templateId	Associated template ID.
	eventTypeName	Event template event type name.
INSUFFICIENT_PERMISSIONS	---	User does not have permissions to create an event.
	userId	Associated user ID.
MISSING_REQUIRED_FIELD	---	A required field is missing in the request entity-body.
	field	Name of the missing/required field.
ALREADY_EXISTS	---	Duplicate event name.
	field	Indicates the field that triggered the already exists validation failure.
EXCEEDED_CHARACTER_LIMIT	---	The request-entity body contains a value that exceeds a field'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.
INVALID_TEMPLATE_TYPE	---	Request-entity body contains an invalid template type name. Use the GET Template Types endpoint for available template types.
	field	Name of template type name field.
	value	Invalid value that was attempted to be put into template type name field.
INVALID_SUBCATEGORY_1_VALUE	---	Request-entity body contains an invalid subcategory 1 value. Use the GET Subcategories by Template Type endpoint for available subcategory 1 values.
	field	Name of subcategory 1 field.
	value	Invalid value that was attempted to be put into subcategory 1 field.
INVALID_SUBCATEGORY_2_VALUE	---	Request-entity body contains an invalid subcategory 2 value. Use the GET Subcategories by Template Type endpoint for available subcategory 2 values.
	field	Name of subcategory 2 field.
	value	Invalid value that was attempted to be put into subcategory 2 field.
INVALID_USER_GROUP_NAME	---	Request-entity body contains an invalid user group name.
	field	Name of user group name field.
	value	Invalid value that was attempted to be put into user group name field.
REQUIRES_COPY_SUPPLIERS_AND_COPY_ITEMS	---	To copy historics, copy suppliers and copy items must also be selected.
	field	Field selected.
REQUIRES_COPY_SUPPLIERS	---	To RFI answers, copy suppliers must also be selected.
	field	Field selected.

Body

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

Type: json

Content:

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

Examples:

single:

{
  "statuses": {
    "INVALID_SUBCATEGORY_1_VALUE": [
      {
        "field": "subcategory1",
        "value": "Truckload"
      }
    ]
  }
}

multiple:

{
  "statuses": {
    "INVALID_TEMPLATE_TYPE": [
      {
        "field": "templateTypeName",
        "value": "Trans"
      }
    ],
    "EXCEEDED_CHARACTER_LIMIT": [
      {
        "field": "name",
        "limit": "50",
        "value": "Albert's Passion Fruit Grove Special Event August 2019"
      }
    ],
    "REQUIRES_COPY_SUPPLIERS": [
      {
        "field": "copyRfiAnswers"
      }
    ],
    "REQUIRES_COPY_SUPPLIERS_AND_COPY_ITEMS": [
      {
        "field": "copyHistorics"
      }
    ]
  }
}

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Events by User

Retrieve ASO event data from one or more events visible to user ID.

/chost/{customer-host-id}/user/{user-id}/apiEvents get

get

Returns ASO event entities based on path parameters and a set of filter criteria that can be sent as query parameters. The query parameters can be used in any combination to filter the results of this endpoint.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
user-id: required(integer)
ASO user ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

Query Parameters

eventId: (integer)
Filter to only a single event; WHERE event.eventId = value.
Example:
```
21863
```
name_in: (string)
Include events where name contains this string; WHERE event.name LIKE %%
Example:
```
LTL
```
description_in: (string)
Include events description contains this string; WHERE event.description LIKE %%
Example:
```
auction event
```
createdOn_to: (integer)
Include events created on or before this date. Value is a 13 digit epoch/unix time.
Example:
```
1483290732000
```
createdOn_from: (integer)
Include events created on or after this date. Value is a 13 digit epoch/unix time.
Example:
```
1451668332000
```
createdBy: (integer)
Include events created by this ASO user; WHERE event.createdBy = value.
Example:
```
182948
```

HTTP status code 200

Success; Returns zero or more sets of event data that match path parameters and filter criteria.

Body

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

Type: array of object

Items: ApiProject

eventId: required(integer)
Event ID.
Example:
```
22053
```
customerHostId: required(integer)
ASO Customer Host ID.
Example:
```
258
```
name: required(string)
Event name. (Max length: 50)
Example:
```
ASO Test Event
```
uriName: required(string)
Event URI name.
Example:
```
22053
```

url: required(string)

ASO event URL.

Example:

https://qa.qa-asap-web-04.combinenet.com/clearview/22053

description: required(string)
Event description. (Max length: 255)
Example:
```
Demo North American Truckload Event
```
isTestEvent: required(boolean)
Test event indicator flag.
Example:
```
false
```
isTemplate: required(boolean)
Template indicator flag.
Example:
```
false
```
archivalState: required(one of archiving, archived, restoring, not_archived)
Archival state of the event.
Example:
```
not_archived
```
eventOwner: required(string)
Name of the event owner. (Max length: 100)
Example:
```
Matt Nauman
```
eventOwnerEmail: required(string)
Email address of the event owner. (Max length: 100)
Example:
```
mnauman@jaggaer.com
```
publicOrPrivate: required(one of public, private)
Public or private state of the event.
Example:
```
private
```
templateTypeName: required(string)
Template type name.
Example:
```
Transportation
```
eventTypeName: required(string)
Event type name.
Example:
```
Sealed Bid
```
eventTypeCategory: required(one of RFX, eAuction)
Event type category.
Example:
```
RFX
```
subcategory1: required(string)
Subcategory 1. (Max length: 64)
Example:
```
LTL
```
subcategory2: required(union of string or nil)
Subcategory 2. (Max length: 64)
Example:
```
Truckload
```
active: required(boolean)
Event active flag.
Example:
```
true
```
createdOn: required(integer)
Time that event was created. 13-digit unix/epoch time.
Example:
```
1428676514000
```
projectStartDate: required(integer)
Time that project was set to begin. 13-digit unix/epoch time.
Example:
```
1428676514000
```
biddingOpen: required(integer)
Time that bidding opens. 13-digit unix/epoch time.
Example:
```
1274371980000
```
roundOneBiddingOpen: required(integer)
Time that round-one bidding opens. 13-digit unix/epoch time.
Example:
```
1274371980000
```
biddingClose: required(integer)
Time that bidding closes. 13-digit unix/epoch time.
Example:
```
1340554380000
```
optimizationAvailable: required(integer)
Time that optimization results are first available. 13-digit unix/epoch time.
Example:
```
1340554380000
```
optimizationUnavailable: required(integer)
Time that optimization becomes unavailable. 13-digit unix/epoch time.
Example:
```
1420045980000
```
analysisEnds: required(integer)
Time that analysis ends in event. 13-digit unix/epoch time.
Example:
```
1420045980000
```
lastModified: required(integer)
Time that the event was last modified. 13-digit unix/epoch time.
Example:
```
1536336168000
```

Example:

[
  {
    "eventId": 22053,
    "customerHostId": 258,
    "name": "ASO Test Event",
    "uriName": "22053",
    "url": "https://qa.qa-asap-web-04.combinenet.com/clearview/22053",
    "description": "Demo North American Truckload Event",
    "isTestEvent": false,
    "isTemplate": false,
    "archivalState": "not_archived",
    "eventOwner": "Matt Nauman",
    "eventOwnerEmail": "mnauman@sciquest.com",
    "publicOrPrivate": "private",
    "templateTypeName": "Transportation",
    "eventTypeName": "Sealed Bid",
    "eventTypeCategory": "RFX",
    "subcategory1": "LTL",
    "subcategory2": "South",
    "active": true,
    "createdOn": 1428676514000,
    "projectStartDate": 1428676514000,
    "biddingOpen": 1274371980000,
    "roundOneBiddingOpen": 1274371980000,
    "biddingClose": 1340554380000,
    "optimizationAvailable": 1340554380000,
    "optimizationUnavailable": 1420045980000,
    "analysisEnds": 1420045980000,
    "lastModified": 1536336168000
  },
  {
    "eventId": 22055,
    "customerHostId": 258,
    "name": "Another Test Event",
    "uriName": "22055",
    "url": "https://qa.qa-asap-web-04.combinenet.com/clearview/22055",
    "description": "Demo Event",
    "isTestEvent": true,
    "isTemplate": false,
    "archivalState": "not_archived",
    "eventOwner": "Matt Nauman",
    "eventOwnerEmail": "mnauman@sciquest.com",
    "publicOrPrivate": "private",
    "templateTypeName": "Transportation",
    "eventTypeName": "Sealed Bid",
    "eventTypeCategory": "RFX",
    "subcategory1": "LTL",
    "subcategory2": null,
    "active": true,
    "createdOn": 1428676514000,
    "projectStartDate": 1428676514000,
    "biddingOpen": 1274371980000,
    "roundOneBiddingOpen": 1274371980000,
    "biddingClose": 1340554380000,
    "optimizationAvailable": 1340554380000,
    "optimizationUnavailable": 1420045980000,
    "analysisEnds": 1420045980000,
    "lastModified": 1536336168000
  }
]

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Rate Location Names

Retrieve ASO rate structure location names for a given customer.

/chost/{customer-host-id}/apiLocationNames get

get

Returns ASO rate structure location names. A set of filter, sorting and paging criteria can be sent with the request as query parameters.

Request Details

Filtering

Query Parameter	Type	Description
Filterable `string` response field name	boolean	Exact match with string. Use preceding and/or trailing '*' for startsWith, endsWith, contains
Example
`?locationName=151*`
`?locationName=itts`

Sorting

Only one field can be sorted per request.

Query Parameter	Type	Description
sort_field	string	Field name to sort by
sort_order	enum	Optional; Defaults to `asc`
Example
`?sort_field=locationName&sort_order=desc`

Paging

Query Parameter	Type	Description
page_number	number	The page number or offset to be used when generating the endpoint response
page_size	number	The page size or limit of elements per page to be used when generating the endpoint response
Example
`?page_number=3&page_size=20`

Returns ASO rate structure location names. A set of filter, sorting and paging criteria can be sent with the request as query parameters.

Request Details

Filtering

Query Parameter	Type	Description
Filterable `string` response field name	boolean	Exact match with string. Use preceding and/or trailing '*' for startsWith, endsWith, contains
Example
`?locationName=151*`
`?locationName=itts`

Sorting

Only one field can be sorted per request.

Query Parameter	Type	Description
sort_field	string	Field name to sort by
sort_order	enum	Optional; Defaults to `asc`
Example
`?sort_field=locationName&sort_order=desc`

Paging

Query Parameter	Type	Description
page_number	number	The page number or offset to be used when generating the endpoint response
page_size	number	The page size or limit of elements per page to be used when generating the endpoint response
Example
`?page_number=3&page_size=20`

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

Query Parameters

locationName: (string)
Filter by location name. (See filtering details above)
Example:
```
Pit*
```
sort_field: (locationName)
Field to sort by. (See sorting details above)
Example:
```
locationName
```
sort_order: (one of asc, desc)
Order to sort by. (See sorting details above)
Example:
```
asc
```
page_number: (integer)
Page number of results to return. (See paging details above)
Example:
```
3
```
page_size: (integer)
Number of results to return per page. (See paging details above)
Example:
```
20
```

HTTP status code 200

Success; Returns rate structure location names for a given customer host matching filter, sorting and paging criteria.

Body

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

Type: array of string

Example:

[
  "AEJEA Jebel Ali",
  "Afganistán",
  "Alabama (AL)",
  "Alaska (AK)",
  "Albania",
  "Alemania",
  "Alexandria",
  "Altoona",
  "Anacostia-Bolling",
  "Andorra",
  "Angola",
  "Angola (AO)",
  "Annapolis",
  "Antigua y Barbuda",
  "AOLAD Luanda",
  "Arabia Saudita",
  "Argelia",
  "Argentina",
  "Argentina (AR)",
  "Arizona (AZ)",
  "Arkansas (AR)",
  "Arlington",
  "Armenia",
  "Asheville",
  "Atlanta",
  "Augusta (GA)",
  "Augusta (ME)",
  "Australia",
  "Austria",
  "Azerbaiyán"
]

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Subcategories by Template Type

Retrieve ASO subcategories by template type.

/chost/{customer-host-id}/templateType/{template-type-id}/apiSubcategories get

get

Returns ASO subcategory names matching template type.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
template-type-id: required(integer)
ASO template type ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

HTTP status code 200

Success; Returns all ASO subcateogry names matching template type. The response includes a separate list for subcategory 1 names and subcategory 2 names.

Body

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

Type: object

Properties

subcategory1: required(array of any)
Subcategory 1 names.
Example:
```
[
  "Land",
  "Ocean"
]
```
subcategory2: required(array of any)
Subcategory 2 names.
Example:
```
[
  "Bottles",
  "Filters"
]
```

Example:

{
  "subcategory1": [
    "Land",
    "Ocean"
  ],
  "subcategory2": [
    "Bottles",
    "Filters"
  ]
}

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Templates by User

Retrieve ASO template data from one or more templates visible to user ID.

/chost/{customer-host-id}/user/{user-id}/apiTemplates get

get

Returns ASO event template entities based on path parameters and a set of filter criteria that can be sent as query parameters. The query parameters can be used in any combination to filter the results of this endpoint.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
user-id: required(integer)
ASO user ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

Query Parameters

eventId: (integer)
Filter to only a single event template; WHERE event.eventId = value.
Example:
```
21863
```
name_in: (string)
Include event templates where name contains this string; WHERE event.name LIKE %%
Example:
```
LTL
```
description_in: (string)
Include event templates description contains this string; WHERE event.description LIKE %%
Example:
```
auction event
```
createdOn_to: (integer)
Include event templates created on or before this date. Value is a 13 digit epoch/unix time.
Example:
```
1483290732000
```
createdOn_from: (integer)
Include event templates created on or after this date. Value is a 13 digit epoch/unix time.
Example:
```
1451668332000
```
createdBy: (integer)
Include event templates created by this ASO user; WHERE event.createdBy = value.
Example:
```
182948
```

HTTP status code 200

Success; Returns zero or more sets of template data that match path parameters and filter criteria.

Body

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

Type: array of object

Items: ApiProjectTemplate

eventId: required(integer)
Event ID.
Example:
```
22053
```
customerHostId: required(integer)
ASO Customer Host ID.
Example:
```
258
```
name: required(string)
Partner system org/customer ID.
Example:
```
ASO Test Event
```
uriName: required(string)
Event URI name.
Example:
```
22053
```

url: required(string)

ASO event URL.

Example:

https://qa.qa-asap-web-04.combinenet.com/clearview/22053

description: required(string)
Event description.
Example:
```
Demo North American Truckload Event
```
isTestEvent: required(boolean)
Test event indicator flag.
Example:
```
false
```
isTemplate: required(boolean)
Template indicator flag.
Example:
```
false
```
archivalState: required(one of archiving, archived, restoring, not_archived)
Archival state of the event.
Example:
```
not_archived
```
eventOwner: required(string)
Name of the event owner.
Example:
```
Matt Nauman
```
eventOwnerEmail: required(string)
Email address of the event owner.
Example:
```
mnauman@jaggaer.com
```
publicOrPrivate: required(one of public, private)
Public or private state of the event.
Example:
```
private
```
templateTypeName: required(one of Transportation, Packaging, Indirect Materials, RFxpress, Direct Materials, Services, SD Auction, Multi-Stage, Facilities Management & Services, Routing Network)
Event type name.
Example:
```
Transportation
```
eventTypeName: required(one of Sealed Bid, Reverse Auction, Dutch Reverse Auction, Japanese Reverse Auction, SD Auction, Supply Chain, Routing Network)
Event type name.
Example:
```
Sealed Bid
```
eventTypeCategory: required(one of RFX, eAuction, Advanced Sourcing)
Event type category.
Example:
```
RFX
```
active: required(boolean)
Event active flag.
Example:
```
true
```
createdOn: required(integer)
Time that event was created. 13-digit unix/epoch time.
Example:
```
1428676514000
```
lastModified: required(integer)
Time that the event was last modified. 13-digit unix/epoch time.
Example:
```
1536336168000
```

Example:

[
  {
    "eventId": 34445,
    "customerHostId": 293,
    "name": "JCS RFX Template",
    "uriName": "34445",
    "url": "https://jcs.qa-asap-web-04.combinenet.com/clearview/34445",
    "description": "blah",
    "isTestEvent": false,
    "isTemplate": true,
    "archivalState": "not_archived",
    "eventOwner": "Kathie",
    "eventOwnerEmail": "kmaloney@sciquest.com",
    "publicOrPrivate": "private",
    "templateTypeName": "RFxpress",
    "eventTypeName": "Sealed Bid",
    "eventTypeCategory": "RFX",
    "active": true,
    "createdOn": 1546544237000,
    "lastModified": 1546544237000
  },
  {
    "eventId": 34446,
    "customerHostId": 293,
    "name": "JCS eAuction Template",
    "uriName": "34446",
    "url": "https://jcs.qa-asap-web-04.combinenet.com/clearview/34446",
    "description": "blah",
    "isTestEvent": false,
    "isTemplate": true,
    "archivalState": "not_archived",
    "eventOwner": "Kathie",
    "eventOwnerEmail": "kmaloney@sciquest.com",
    "publicOrPrivate": "private",
    "templateTypeName": "RFxpress",
    "eventTypeName": "Reverse Auction",
    "eventTypeCategory": "eAuction",
    "active": true,
    "createdOn": 1546544434000,
    "lastModified": 1546544434000
  }
]

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Template Types

Retrieve ASO template types.

/chost/{customer-host-id}/apiTemplateTypes get

get

Returns ASO template type entities.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

HTTP status code 200

Success; Returns all ASO template type entities.

Body

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

Type: array of object

Items: ApiTemplateType

templateTypeId: required(integer)
Template type ID.
Example:
```
1
```
name: required(one of Transportation, Packaging, Indirect Materials, RFxpress, Direct Materials, Services, SD Auction, Multi-Stage, Facilities Management & Services, Routing Network)
Template type. (Max length: 100)
Example:
```
Transportation
```

Example:

[
  {
    "templateTypeId": 1,
    "name": "Transportation"
  },
  {
    "templateTypeId": 2,
    "name": "Packaging"
  },
  {
    "templateTypeId": 3,
    "name": "Indirect Materials"
  },
  {
    "templateTypeId": 4,
    "name": "RFxpress"
  },
  {
    "templateTypeId": 5,
    "name": "Direct Materials"
  },
  {
    "templateTypeId": 6,
    "name": "Services"
  },
  {
    "templateTypeId": 7,
    "name": "SD Auction"
  },
  {
    "templateTypeId": 8,
    "name": "Multi-Stage"
  },
  {
    "templateTypeId": 10,
    "name": "Routing Network"
  }
]

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

User

Retrieve an ASO user by user ID.

/chost/{customer-host-id}/apiUser/{user-id} get

get

Returns an ASO user entity by the specified user ID.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.
user-id: required(integer)
ASO user ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

HTTP status code 200

Success; Returns a single user matching the specified user ID.

Body

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

Type: object

Properties

userId: (union of integer or nil)
User ID.
Example:
```
1
```
username: required(union of string or nil)
User username.
Example:
```
mnauman@jaggaer.com
```
name: required(union of string or nil)
User full name.
Example:
```
Mathew Nauman
```
status: required(one of locked, single_use, unlocked, bad_password, expired)
User status.
NOTE: Returned only in GET response. Not supported for POST, PATCH, or PUT requests.
Example:
```
unlocked
```
active: required(boolean)
Whether or not the user is active.
Example:
```
false
```

Example:

{
  "userId": 1281658,
  "username": "test_user+1@jaggaer.com",
  "name": "Test User 1",
  "status": "unlocked",
  "active": true
}

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

HTTP status code 404

User ID cannot be found.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "userId": "99"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

Users

Retrieve one or more ASO users.

/chost/{customer-host-id}/apiUsers get

get

Returns all ASO user entities for the specified customer host.

Secured by oauth_2_0

ASO requires OAuth 2.0 for authorizing endpoint requests.

URI Parameters

customer-host-id: required(integer)
ASO customer host ID.

Headers

X-API-Key: required(string)

API key.

Example:

7BpB136Rfj75IOabv55iQ6ACgLu9AKpWn3FG0gxd

Authorization: required(string)
System-to-system OAuth 2.0 bearer access token.
Example:
```
Bearer 76ac929c-f90b-4a35-85d6-53f6a0904f7f
```
Accept: required(string)
Informs the server about which mediatypes are acceptable in the response.
Example:
```
application/vnd.sciquest.com.ches+json
```

HTTP status code 200

Success; Returns all users that match the specified customer host.

Body

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

Type: array of object

Items: ApiUser

userId: (union of integer or nil)
User ID.
Example:
```
1
```
username: required(union of string or nil)
User username.
Example:
```
mnauman@jaggaer.com
```
name: required(union of string or nil)
User full name.
Example:
```
Mathew Nauman
```
status: required(one of locked, single_use, unlocked, bad_password, expired)
User status.
NOTE: Returned only in GET response. Not supported for POST, PATCH, or PUT requests.
Example:
```
unlocked
```
active: required(boolean)
Whether or not the user is active.
Example:
```
false
```

Example:

[
  {
    "userId": 1281658,
    "username": "test_user+1@jaggaer.com",
    "name": "Test User 1",
    "status": "unlocked",
    "active": true
  },
  {
    "userId": 1281659,
    "username": "test_user+2@jaggaer.com",
    "name": "Test User 2",
    "status": "unlocked",
    "active": true
  },
  {
    "userId": 1281660,
    "username": "test_user+3@jaggaer.com",
    "name": "Test User 3",
    "status": "unlocked",
    "active": true
  }
]

HTTP status code 403

Invalid or unauthorized Customer Host ID entered.

Body

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

Type: json

Content:

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

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "System does not have access to customerHost 999999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
X-API-Key: required(string)
API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

ASO Customer Host Entity Service (CHES) version v23.3.0.0

Async Status

get /asyncStatus/{encoded-async-pid}

URI Parameters

Headers

HTTP status code 200

Working With the Result URL (Pre-Signed URL)

Pre-Signed URL -- 200 OK

Pre-Signed URL -- 403 Forbidden

Body

HTTP status code 400

Body

HTTP status code 403

Body

Secured by oauth_2_0

Headers

HTTP status code 400

HTTP status code 403

Customer Host FQDN

get /chost/{customer-host-id}/fqdn

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 404

Body

Secured by oauth_2_0

Headers

HTTP status code 400

HTTP status code 403

Event from Template by User

post /chost/{customer-host-id}/user/{user-id}/template/{template-id}/apiEvent

URI Parameters

Headers

Body

HTTP status code 201

Body

HTTP status code 400

Body

HTTP status code 403

Body

Secured by oauth_2_0

Headers

HTTP status code 400

HTTP status code 403

Event from Template by User (Asynchronous)

post /chost/{customer-host-id}/user/{user-id}/template/{template-id}/apiEvent/async

URI Parameters

Headers

Body

HTTP status code 202

Working With Status URL

Model:

Data Example:

Body

HTTP status code 400

Body

HTTP status code 403

Body

Secured by oauth_2_0

Headers

HTTP status code 400

HTTP status code 403

Events by User

get /chost/{customer-host-id}/user/{user-id}/apiEvents

URI Parameters

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

Secured by oauth_2_0

Headers

HTTP status code 400

HTTP status code 403

Rate Location Names

Request Details