GET Log/LogSchema

Returns the definition and format of Trust Protection Platform and CodeSign Protect events.

Requirements

Permissions: The caller must have View permission and Read permission to the default SQL channel object.
Integration: In the UI, use an API integration to import a set of scopes that your application will use.

Token scope: Admin:ViewLogs

POST https://tpp.venafi.example/vedauth/authorize/oauth
{
   "client_id": "Event",
   "username": "local:UserwIntegrationAccess",
   "password": "CallerPassw0rd",
   "scope": "admin:viewlogs"
}

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

None

Returns

Response description
Name	Description
LogEventApplicationDefinitions	An array of application definitions: ApplicationName: The name of the application that fires events. ID: The high bits that are shared among all Event IDs logged by this component.
LogEventDefinitions	An array of event definitions: DataFormat: The event message. DataTitle: The name of the data field. DataType: The MIME type of the data field. Description: The event description or reason for occurrence. GroupingTitle: The event category, if any. GroupingType: The datatype. ID: The high bits that are shared among all Event IDs logged by this component. For example: Id=65538. Text1Title: The name of data in the Text 1 field, if present. Text2Title: The name of data in the Text 2 field, if present. Value1Title: The name of the data in the Value 1 field, if present. Value1Type: The data type for Value1. Value2Title: The name of data in the Text 2 field, if present. Value2Type: The data type for Value2Title.
LogResult	The result code that indicates the reason for success or failure. For more information, see Log Result Codes.

Example: Show the entire Event schema

Request

GET https://tpp.venafi.example/vedsdk/Log/LogSchema
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "LogEventApplicationDefinitions":[
      {
         "ApplicationName":"ACME Service",
         "ID":50
      },
      {
         "ApplicationName":"Adaptable Workflow",
         "ID":36865
      },
      {
         "ApplicationName":"Admin UI",
         "ID":12
      }, ...
   ],
   "LogEventDefinitions":[
      {
         "DataFormat":"$Event.Text1$:$Event.Value1$ - $Event.Text2$",
         "DataTitle":"",
         "DataType":"String",
         "Description":"Debug Event",
         "GroupingTitle":"ThreadID",
         "GroupingType":"Long",
         "ID":4294901761,
         "Text1Title":"Sourcefile",
         "Text2Title":"Message",
         "Value1Title":"Line Number",
         "Value1Type":"Long",
         "Value2Title":"Column Number",
         "Value2Type":"Long"
      }, ...
   ],
   "LogResult":0
}