ShowFootPrintCSV · Customer Self-Service

Retrieves data of a root cause analysis table view as a CSV file.

HTTP Request

PUT /WebApp/OSCE_iES/OsceIes/ApiEntry

Parameters

Important:

The HTTP request body must contain all required parameters.

Name	Type	Description
Required Parameters
Url	String	Specifies the Endpoint Sensor API request to query
TaskType	Integer	Type of API request For Endpoint Sensor, the value is always `4`. For available values, see Threat Investigation API Task Types.
Payload	Object	Payload of the request
agentGuid	String	GUID of the target endpoint
scanSummaryGuid	String	GUID of the investigation summary to retrieve
serverGuid	String array	GUID of the target server
hostIP	String	Host IP address
hostName	String	Host name

HTTP Request Example

PUT /WebApp/OSCE_iES/OsceIes/ApiEntry

HTTP Request Body

Specify a JSON object containing the following HTTP request body:

Request body:

{
  "Url": "V1/Task/ShowFootPrintCsv",
  "TaskType": 4,
  "Payload": {
    "agentGuid": "654B1B52-C3C9-4405-B133-48E2353DA13B",
    "scanSummaryGuid": "58127b3e-1bde-4c6e-8d86-0d0f89ded601",
    "serverGuid": [
      "2EBEC86D-3FEB-4666-9CA6-B80AB1E193E6"
    ],
    "hostIP": "10.1.172.94",
    "hostName": "SAMPLE_AGENT"
  }
}

Response

If successful, this method returns an HTTP status code of "200", result code of "0", and a response body with the following structure:

{
  "Data": {
    "Code": 0,
    "CodeType": 1,
    "Message": "OK",
    "Data": {
      "taskId": "bf2e9787-b1cb-41d3-b902-44c43becdaf8",
      "lastContentId": "",
      "hasMore": false,
      "serverName": "SAMPLE_SERVER",
      "serverGuid": "2EBEC86D-3FEB-4666-9CA6-B80AB1E193E6",
      "content": [
        {
          "statusCode": 0,
          "message": "TMSL_S_SUCCESS",
          "content": {
            "csv": "Host Name,SAMPLE_AGENT\nIP Address,
                    10.1.172.94\nChain, ... "
          }
        }
      ]
    },
    "TimeZone": 8
  },
  "Meta": {
    "result": 1,
    "errorCode": 0,
    "errorMessgae": "Success"
  },
  "PermissionCtrl": {
    "permission": "255",
    "elements": null
  },
  "FeatureCtrl": {
    "mode": "0"
  },
  "SystemCtrl": {
    "TmcmSoDist_Role": "none"
  }
}

The following table describes the response objects specific to this API.

Name	Type	Description
csv	String	Contents of the CSV file

For more information about standard responses and response codes for this API, see the following topics: