Threat Investigation Automation API Responses

ビュー:

Threat Investigation Automation APIs return JSON response objects in the following format:

{
  "Data": {
    "Code": 0,
    "Message": "OK",
    "Data": {
      "taskId": "3d189747-08cf-439e-abc8-966df4e572c4,
                 f429b4b6-058a-4d76-8bbe-b8ef2b1cba68",
      "lastContentId": "",
      "hasMore": false,
      "serverGuid": "E7DB4DA69FD9-4F4588CC-DFCF-CA7B-9227,
                     EEF8F4D610C0-41FEA6A6-8394-A44D-8FD1",
      "serverName": "andy-osce-ies,andy-ies2",
      "content": [
        {
          "statusCode": 0,
          "message": "TMSL_S_SUCCESS",
          "content": ""
        }
      ]
    },
    "HasDataSource": false,
    "TimeZone": 8
  },
  "Meta": {
    "result": 1,
    "errorCode": 0,
    "errorMessgae": "Success"
  },
  "PermissionCtrl": {
    "permission": "255",
    "elements": null
  }
}

Where the "Data" object contains the following information:

Name	Type	Description
Response Objects for All Requests
Data.Code	Integer	The result code of the response For possible values, see Threat Investigation Automation API Result Codes.
Data.CodeType	Integer	Indicates the product that sent the response For Endpoint Sensor, the value is always `1`.
Data.Message	String	The description of the result code
Data.taskId	String	The task ID of the response
Data.hasMore	Boolean	Indicates if additional data can be retrieved from the server
Data.serverGuid	String	The GUID of the responding servers
Data.serverName	String	The server names of the responding servers
Data.Data.content[0].statusCode	Integer	The status code of the response For possible values, see Threat Investigation Automation API Status Codes.
Data.Data.content[0].message	String	The message of the response
Data.Data.content[0].content	Object	The payload of the response
Data.HasDataSource	Boolean	Indicates if data is retrieved from multiple Endpoint Sensor servers
Data.TimeZone	Integer	The Coordinated Universal Time (UTC) offset
Data.lastContentId	String	Contains information about the dataset’s location, and enables the `ShowContent` API to request the next chunks of data
Data.lastContentId schema
serverGuid	String	The server GUID
lastContentId	Integer	ID used to retrieve the next set of results
hasMore	Boolean	Indicates whether the source has more results
totalProgress	Integer	Number of agents in the server Only used for querying the progress of the "CreateQuickScan" API. If not called by the "CreateQuickScan" API, the value is 0.
currentProgress	Integer	Number of investigated agents in the server Only used for querying the progress of the "CreateQuickScan" API. If not called by the "CreateQuickScan" API, the value is 0.
Response Objects for Unsuccessful Requests
Data.ErrorServerName	String	Host name of the server which responded with the error
Data.ErrorServers	Object	Container for error information
Data.ErrorServers[i].httpCode	Integer	The HTTP status code of the error
Data.ErrorServers[i].statusCode	Integer	The status code of the error
Data.ErrorServers[i].serverName	String	The host name of the server that encountered the error
Data.ErrorServers[i].message	String	The error message of the response
Data.ErrorServers[i].content	Object	The payload of the error response
Data.ErrorServers[i].codeType	Integer	Indicates the product/service that encountered the error 1: Endpoint Sensor error 2: Apex Central error 3: HTTP request error
Custom Intelligence Automation API Response Objects
Meta	Object	Indicates the response status, including the result, error code, and error message
Result	Integer	The result code of the response For available values, see Custom Intelligence Automation API Response Codes.
ErrorCode	Integer	The error code of the response For available values, see Custom Intelligence Automation API Response Codes.
ErrorMsg	String	The error message of the response For available descriptions, see Custom Intelligence Automation API Response Codes.
PermissionCtrl	Object	Indicates the permissions assigned to the logged-on user account for accessing Apex Central menu items and features
permission	Integer	255: Full control 1: Read-only
elements	String	The value is always "null" for Custom Intelligence Automation APIs