Status Codes

HTTP Status Success Codes

These are the standard HTTP success codes that the Solution Reporting APIs use:

HTTP Response Status	Resolution
200 OK	The request succeeded and the API returned a response body.
201 Created	A new resource was created as a result of the request with details returned in the response body.
204 No Content	The request succeeded, but there is no response body.

Response Success Information

In most cases, the API returns a response with success information in JSON format. For example:

{
  "count": 1,
  "value": [
    {
      "id": "8c3a3fa4-6c59-4ef9-8a9d-4c0a99f0e921",
      "name": "Monthly Sales Summary",
      "description": "Summary of monthly sales totals by region",
      "templateId": "3f72d6c5-f671-4d28-8f43-b0bb4c26e50d",
      "templateName": "Sales Summary Template",
      "category": {
        "id": "b2fb1b52-bf71-4a67-ad3b-7b6336872e62",
        "name": "Sales Reports"
      },
      "createdDateTime": "2025-10-18T14:32:10Z",
      "modifiedDateTime": "2025-12-01T09:12:45Z",
      "fields": null,
      "filters": null
    }
  ]
}

HTTP Status Error Codes

These are the standard HTTP error codes that the Solution Reporting APIs use:

HTTP Response Status	Resolution
400 Bad Request	This error may be caused by the invalid JSON payload in the request. Inspect the error details included in the response (if any) for further information.
401 Unauthorized	Ensure the authentication token in the HTTP header was included in the request and was valid.
403 Forbidden	This error indicates that the server understood the request but refused to process it.
404 Not Found	This error indicates that the requested report definition or template was not found.
500 Internal Server Error	The operation should be retried later. If the error persists, reach out to Vertex Support.

Response Error Information

In most cases, the API returns a response with error information in JSON format. For example:

{
	"code": 404,
	"error": "Not Found",
	"message": "No report found with UUID: f8cf6296-c6b2-44b3-9ec1-7531cef53e26",
	"timestamp": "2025-08-28T12:06:56.648877795Z",
	"path": "/api/v1/reports/f8cf6296-c6b2-44b3-9ec1-7531cef53e26"
}