TAG LINE
TAG LINE
SMALL TITLE

Json API / Log

(API Version v10)


Log information for API calls performed within the system.


What can you do with JsonApiLog?


Properties

Property Details
identity
READ-ONLY
"identity": "Hello World"
Type: String
This is the unique numeric identifier for the JsonApiLog
userIdentity
"userIdentity": 24
Type: Number
The ID of the user that performed the API request.
ownerTenantIdentity
"ownerTenantIdentity": 2
Type: Number
The usage identifier the mediated usage belongs to.
user
"user": "Hello World"
Type: String
The user name that made the request.
requestTrackingIdentity
"requestTrackingIdentity": "Hello World"
Type: String
The unique tracking ID of the request.
utc
"utc": "2021-04-26T15:25:27.587Z"
Type: Date
The date and time of the request.

Date and time values are specified in the ISO 8601 format.
requestUri
"requestUri": "Hello World"
Type: String
The URI of the request..
requestVerb
"requestVerb": "Hello World"
Type: String
The type of request e.g. GET, POST, PATCH.
requestHeaders
"requestHeaders": "Hello World"
Type: String
The Headers of the request.
requestLength
"requestLength": "Hello World"
Type: String
The length of the request.
request
"request": "Hello World"
Type: String
Any additional request parameters.
responseStatusCode
"responseStatusCode": "Hello World"
Type: String
The status code of the response.
responseReasonCode
"responseReasonCode": "Hello World"
Type: String
The reason code of the response.
responseHeaders
"responseHeaders": "Hello World"
Type: String
The headers of the response.
responseLength
"responseLength": "Hello World"
Type: String
The length of the response.
response
"response": "Hello World"
Type: String
The body of the response.
ipAddressFrom
"ipAddressFrom": "Hello World"
Type: String
The IP address from which the request was made.
ipAddressTo
"ipAddressTo": "Hello World"
Type: String
The IP address of the system to where the request was being made.
duration
"duration": "Hello World"
Type: String
The duration of the request.
idempotencyKey
"idempotencyKey": "Hello World"
Type: String
A unique key that the server uses to recognize subsequent retries of the same request.


End Points

GETJsonApi/Log/ByRequestTracking/{id}
Retrieve an instance of the JsonApiLog object by its ID.
{id}Unique identifier for the JsonApiLog object.
Retrieve an instance of the JsonApiLog object by its ID.
GET JsonApi/Log/ByRequestTracking/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "userIdentity": 13,
        "ownerTenantIdentity": 8,
        "user": "Sample Text Data",
        "requestTrackingIdentity": "Sample Text Data",
        "utc": "2021-04-26T15:25:27.587Z",
        "requestUri": "Sample Text Data",
        "requestVerb": "Sample Text Data",
        "requestHeaders": "Sample Text Data",
        "requestLength": "Sample Text Data",
        "request": "Sample Text Data",
        "responseStatusCode": "Sample Text Data",
        "responseReasonCode": "Sample Text Data",
        "responseHeaders": "Sample Text Data",
        "responseLength": "Sample Text Data",
        "response": "Sample Text Data",
        "ipAddressFrom": "Sample Text Data",
        "ipAddressTo": "Sample Text Data",
        "duration": "Sample Text Data",
        "idempotencyKey": "Sample Text Data"
    }
}