Logging API
| Action | Endpoint |
|---|---|
| Fetch a List of Logs | GET/plugin/{tenantLocator}/logs/list |
| Fetch Logs for a Request | GET/plugin/{tenantLocator}/logs/{locator} |
Fetch a List of Logs
Fetch a List of Logs
fetchLogsListGET
/plugin/{tenantLocator}/logs/listParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
requestId | query | ulid? | No | |
objectLocator | query | ulid? | No | |
createdAtMin | query | datetime? | No | |
createdAtMax | query | datetime? | No | |
offset | query | integer? | No | |
count | query | integer? | No | |
extended | query | boolean? | No | When false, returns a bare array. |
Response:
PluginLogsListResponseSecurity Group:
logsPermissions:
read,listPluginLogsListResponse
Required properties
| Property | Type | Description |
|---|---|---|
listCompleted | boolean | |
items | PluginLogsMetadata[] |
PluginLogsMetadata
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
pluginType | Enum delinquencyEvent | documentDataSnapshot | documentSelection | preCommit | rating | renewal | underwriting | validation | |
requestId | ulid | |
createdAt | datetime | |
objectReferences | ObjectReference[] |
ObjectReference
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
type | string |
Fetch Logs for a Request
Fetch Logs for a Request
fetchLogsGET
/plugin/{tenantLocator}/logs/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
Accept-Encoding | header | string? | No | |
locator | path | ulid | Yes |
Response:
StreamingResponseBody<string>Security Group:
logsPermission:
read