API-Related Information - D365 SCM

This article contains the following information related to APIs.

• Pagination Info
• Throttling Info
• Handling Errors

Pagination Info

The OData service supports the maximum page size of 10,000.

If there are more entities that match the query filter criteria, a @odata.nextLink property will be returned with the results. Use the value of the @odata.nextLink property with a new GET request to return the next page of data.

"@odata.nextLink":"[Organization URI]/data/SalesOrderHeadersV3?cross-company=true&$skip=10000&$top=10000"

For every subsequent request for additional pages from the D365 SCM Connector, you should use the query parameters part of the @odata.nextLink (for example, skip and top).

To know more about pagination and  query parameters from OData Specifications please refer to: https://docs.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/data-entities/odata#supported-features-from-the-odata-specification

Throttling Info

The service protection API limits are evaluated within a 5-minute (300 seconds) sliding window. If any of the limits are exceeded within the preceding 300 seconds, a service protection API Limit error will be returned on subsequent requests to protect the service until the Retry-After duration has ended.

To know more about the API limits for D365 Service endpoints please refer to https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/api-limits#how-service-protection-api-limits-are-enforced

Handling Errors

In case the D365 SCM Connector Business Process, i.e. API call is successful (returns status code btw 200 & 300), the BP task will pass and return a response payload (The task will be marked as complete in the Auditor view of the Studio's Admin Console perspective). 

Or

In case the D365 SCM Connector Business Process i.e. API call has failed (any response status code not between 200 & 300) bps task will fail without returning any response payload (the task is marked as failed in the Auditor view, and the error payload returned from D365 SCM; stack trace are logged).

Or

In case the D365 SCM Connector Business Process i.e API call execution fails (which can be an internal error such as payload parse issue), the task will fail without returning any response payload. The task is marked as failed in the Auditor, and a stack trace is logged.