AM/FA/Inv - Save Batch Error Information

Details

/external/v1/error-log/batch

Synopsis

Save Batch Error Information

post

This route is used to save an errors batch details. This endpoint can be called by applications with access to scope "manageErrors".

Required scopes

This endpoint requires the following scopes:

• : manageErrors

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

Responses

201

Successfully saved errors batch

application/json

400

The following error codes can be returned: - GN0002 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

post

/external/v1/error-log/batch

HTTPcURLJavaScriptPython

POST /external/v1/error-log/batch HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 492

{
  "errors": [
    {
      "action": {
        "httpData": {
          "method": "POST",
          "url": "/v1/external/error-log"
        },
        "name": "Create Error Log Record",
        "id": "PM001"
      },
      "trackingId": "123456789",
      "inputData": {
        "test": "123",
        "someOtherProperty": "456"
      },
      "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"
              ]
            }
          }
        }
      ]
    }
  ]
}

{
  "errorIds": [
    "2159457f-0167-4e93-a969-9cf0db05e0bf"
  ]
}