Skip to main content

ReportCommitResponse

The response body for the POST /api/v1/reports/commit_records endpoint.

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true
uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users
statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

resultsboolean

Indicates whether the request was successful (normally true if it's not an error response).

Example: true
ReportCommitResponse
{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": true
}