AM/TA/Inv - Get Error Details

Details

/external/v1/error-log

Synopsis

Get Error Details

get

This route is used to retrieve the details of errors, given a set of search filters. This endpoint is paginated, up to 50 records can be retrieved per call. This endpoint can be called by applications with access to scope "readErrors".

Required scopes

This endpoint requires the following scopes:

• : readErrors

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

securityIdsFilterstringOptional

The comma delimited list of security ids to filter the error records. Up to 10 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

trackingIdsFilterstringOptional

The comma delimited list of tracking ids to filter the error records. Up to 10 records can be provided. Each record should not exceed 12 characters.

Example: 2f33038c-7a80-4d4c-8dbe-57e105f84446

securityCorrelationIdsFilterstringOptional

The comma delimited list of security correlation ids to filter the error records. Up to 10 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

securityCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

errorIdsFilterstringOptional

The comma delimited list of error ids to filter the error records. Up to 50 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bf

Responses

200

Successfully retrieved error details

application/json

trackingIdstring · max: 500Optional

This ID can be provided to allow tracking the request that generated the error on the platform.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

inputDataobjectOptional

JSON object to that represents the action details.

Example: {"some":"Input","that":"Caused the error"}

errorIdstring · max: 500Required

The unique identifier of the error.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

timestampone ofOptional

This is the date on which the error happened

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/error-log

HTTPcURLJavaScriptPython

GET /external/v1/error-log HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "action": {
      "httpData": {
        "method": "POST",
        "url": "/v1/external/error-log"
      },
      "name": "Create Error Log Record",
      "id": "PM001"
    },
    "trackingId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "inputData": {
      "some": "Input",
      "that": "Caused the error"
    },
    "errorDetails": [
      {
        "message": "Cannot find the requested resource",
        "type": "businessRuleValidations",
        "code": "NF001",
        "reason": [
          "invoked the api but obtained no response"
        ],
        "category": {
          "code": "EC006",
          "description": "Other Issue(s)"
        },
        "context": {
          "entities": {
            "securityIds": [
              "USS3JKS01I00"
            ]
          }
        }
      }
    ],
    "errorId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "timestamp": "2024-09-12T00:00:00.000Z",
    "callerDetails": {
      "applicationId": "FILE_MW_001",
      "oauthClientId": "ca3c2795-49b0-473b-9327-211afeb5142b"
    }
  }
]