Service request tracing

As a best practice when you develop data integrations with finance and operations service endpoints, you should include a request identifier in the request header. In this way, you enable the request to be traced through the service. Your client application should generate and log a client request ID (x-ms-client-request-id) value and send it in the application programming interface (API) request header. This value is a globally unique identifier (GUID) that uniquely identifies each client request.

The finance and operations service logs the x-ms-client-request-id value that is received in the request header. In this way, the value becomes available as an identifier for the request in service telemetry.

Troubleshooting API operations

If a request consistently fails, and you've verified that it's correctly formulated, you might have to open a support ticket so that Microsoft can help troubleshoot the issue. In your support ticket, include the following values:

• The x-ms-client-request-id value that your client application generated and sent in the request header.
• The ms-dyn-aid value, which is the finance and operations activity ID. The finance and operations service generates this unique identifier for the request and sends it back to the client application in the response header.
• The approximate time when the request was made.

These values enable Microsoft to trace the request through service telemetry and troubleshoot the cause of the request failure. If the service doesn't return a response to the client, so that no ms-dyn-aid value is provided, be sure to provide at least the x-ms-client-request-id value and the approximate time of the request in your support ticket to enable Microsoft to trace the API request.