This route is used to save an errors batch details.
This endpoint can be called by applications with access to scope "manageErrors".
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"
]
}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".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
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.
USCCWSF01I00,USCCWSF01I01The 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.
1234,5678,7890The 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.
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.
bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bfGET /external/v1/error-log HTTP/1.1
Host:
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"
}
}
]