afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/BulkApiEventLog.json

98 lines
4.1 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules"
],
"title": "BulkApiEventLog - Data API",
"description": "Bulk API event logs contain details about Bulk API requests. This object is available in API version 61.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"BatchIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The 15-character ID of the Bulk API batch."
},
"ClientIp": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The IP address of the client thats using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”. For example: 96.43.144.26."
},
"CpuTime": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer."
},
"FailureCount": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The number of failures that were returned with the request."
},
"IsSuccess": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the callout request was successful."
},
"JobIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The 15-character ID of the Bulk API job."
},
"LoginKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The string that ties together all events in a given users login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I."
},
"Message": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "Any success or error message thats associated with the request."
},
"ObjectType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of entity that the Bulk API used."
},
"OperationType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of Bulk API operation that was performed."
},
"RequestIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same RequestId. For example: 3nWgxWbDKWWDIk0FKfF5DV."
},
"RunTime": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The amount of time that the request took in milliseconds."
},
"SessionKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The users unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started. For example: d7DEq/ANa7nNZZVD."
},
"Timestamp": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting."
},
"Uri": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The URI of the page thats receiving the request. For example: /home/home.jsp."
},
"UserIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The 15-character ID of the user whos using Salesforce services through the UI or the API. For example: 00530000009M943."
}
},
"special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
}