Socotra
API ReferenceConfiguration and Development API

Logging API

ActionEndpoint
Fetch a List of LogsGET/plugin/{tenantLocator}/logs/list
Fetch Logs for a RequestGET/plugin/{tenantLocator}/logs/{locator}

Fetch a List of Logs

Fetch a List of LogsfetchLogsList
GET/plugin/{tenantLocator}/logs/list

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
requestIdqueryulid?No
objectLocatorqueryulid?No
createdAtMinquerydatetime?No
createdAtMaxquerydatetime?No
offsetqueryinteger?No
countqueryinteger?No
extendedqueryboolean?NoWhen false, returns a bare array.
Security Group:logs
Permissions:
read,list
PluginLogsListResponse

Required properties

PropertyTypeDescription
listCompletedboolean
itemsPluginLogsMetadata[]
PluginLogsMetadata

Required properties

PropertyTypeDescription
locatorulid
pluginTypeEnum delinquencyEvent | documentDataSnapshot | documentSelection | preCommit | rating | renewal | underwriting | validation
requestIdulid
createdAtdatetime
objectReferencesObjectReference[]
ObjectReference

Required properties

PropertyTypeDescription
locatorulid
typestring

Fetch Logs for a Request

Fetch Logs for a RequestfetchLogs
GET/plugin/{tenantLocator}/logs/{locator}

Parameters

NameInTypeRequiredDescription
tenantLocatorpathuuidYes
Accept-Encodingheaderstring?No
locatorpathulidYes
Response:StreamingResponseBody<string>
Security Group:logs
Permission:
read

On this page