REST APIs (Outbound)

Use REST APIs to retrieve information – such as purchase orders, work confirmations, purchase agreements, requisition processing requests, compliance checklists, and procurement agents – from a resource.

Key Features

Use the REST API GET method.

Best Practices

  • To improve performance and prevent REST APIs from experiencing 504 gateway time outs if a request runs for more than 5 minutes, limit the attributes using the fields query parameter while performing a GET operation whenever it's supported.

    Use the query parameters limit and offset to specify how many records to return, and which batch of records to return. When exporting large amounts of data, these query parameters are needed to retrieve the next batch of records because the maximum number of records you can retrieve at once within a single batch is 500.

  • Avoid OR conditions with LIKE clauses.
  • For better performance, consider using file-based data import (FBDI) when creating large purchase orders.

Constraints

JSON format only.