The SiteSense API enables customers and partners to:

a) retrieve data from SiteSense

b) store data in SiteSense

c) retrieve selected reports (as structured JSON or HTML that can be styled via VSS) from SiteSense

The SiteSense API is a RESTful API accessed via an API Key.

All parts and documents submitted to the SiteSense API in a single submission must belong to the same project.

Prior to processing submitted data, the SiteSense API applies a comprehensive set of validations to ensure that the submitted data is valid.

The types of validations peformed are:

• field content
• data integrity (such as requiring that a part referenced on a purchase order either already exist or be created by the current submission)
• contextual business rules (such as requiring that a purchase order that references a needs document line item actually refers to an existing line item on the specified needs document)

If any validations fail, the entire submission is rejected and no changes will be made within SiteSense. The response to the submission will provide detailed information about the nature of all failed validations.

If the data in a submission passes all validations, it will be processed immediately.
Upon successful completion of processing, the submitted data will immediately be visible in SiteSense (ie: processing is never deferred).

The SiteSense API optionally applies rate control to requests.

There are a variety of rate control mechanisms available, such as:

• submission count per time window - Only a specified number of submissions within a specified time window are allowed.
• count per document type - A single submission may only contain a specified number of a particular document type.
• time of day - A submission may only be performed during a particular time window.
• document type - A submission may only contain specified document types.

The specific mechanism or combination of mechanisms applied to your API Key (if any) are determined by your system administrator and Intelliwave Technologies.

The SiteSense API (as of 1-Feb-2024) requires GraphQL queries submitted to the /query endpoint to include a 'first' argument that specifies the maximum number of records to return and an 'offset' argument that specifies at which record to commence returning results.

An example of using GraphQL query pagination is illustrated below:

First Page

query MyQuery { allDataapiPurchaseOrders(first: 100, offset: 0, condition: {projectId: 99}) { edges { node { resourceName } } } }

Additional Pages

query MyQuery { allDataapiPurchaseOrders(first: 100, offset: 100, condition: {projectId: 99}) { edges { node { resourceName } } } }

The maximum page size is 2500.

If an attempt is made to use a larger page size, SiteSense API will return an error:

"payload": { "errors": [ { "message": "The requested page size exceeds the maximum allowed page size (2500).", "locations": [ { "line": 2, "column": 3 } ], "path": [ "allDataapiPurchaseOrders" ] } ], "data": { "allDataapiPurchaseOrders": null } }

If an attempt is made to submit a qeury without a 'first' argument, SiteSense API will return an error:

"payload": { "errors": [ { "message": "You must use pagination in your query (specify a 'first' condition in your query with a value not exceeding the maximum allowed page size of 2500).", "locations": [ { "line": 2, "column": 3 } ], "path": [ "allDataapiPurchaseOrders" ] } ], "data": { "allDataapiPurchaseOrders": null } }

The 'offset' argument is technically optional (it will default to 0); this is useful in query scenarios where only the first page is of interest.

A line item on a UOSD document may (or, where noted, must) have the following properties defined for each line item:

A line item on a transfer document may (or, where noted, must) have the following properties defined for each line item:

A line item on an adjustment document may (or, where noted, must) have the following properties defined for each line item:

A line item on a return document may (or, where noted, must) have the following properties defined for each line item:

A line item on a receipt document may (or, where noted, must) have the following properties defined for each line item:

A line item on an issue ticket document may (or, where noted, must) have the following properties defined for each line item: