REST API Reference

Back Next

Configuration information in the config array for flat file as a source and as a target

The response returns only the fields that you entered in the request.

If the request is successful, the response returns the following fields:

Key	Type	Required	Description
File	String	Yes	Absolute path and name of the source file you want to read.
initialPosition	String	Yes	Starting position to read data from the file to tail.
rolloverPattern	String	-	File name pattern for the file that rolls over.
tailingMode	String	Yes	Tail a file or multiple files based on the logging pattern.
File Name	String	Yes	The name of the target file.
interimDirectory	String	Yes	Path to the staging directory on the Secure Agent.
rolloverSize	Integer	Yes	The file size, in KB, at which the task moves the file from the staging directory to the target.
rolloverEvents	Integer	Yes	Number of events or messages to accumulate before a file rollover.
rolloverTime	Integer	-	Length of time, in milliseconds, after which the target file rolls over.

If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example:

{
  "Success": {
    "name": "FileToFile",
    "description": "FileToFile_V2",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "FileToFile_source",
        "type": "source",
        "connectionId": "0100000B000000000002",
        "transformationType": "",
        "config": [
          {
            "key": "File",
            "value": "siagent.log"
          },
          {
            "key": "initialPosition",
            "value": "Current Time"
          },
          {
            "key": "rolloverPattern",
            "value": ""
          },
          {
            "key": "tailingMode",
            "value": "Single file"
          }
        ]
      },
      {
        "name": "FileToFile_target",
        "type": "target",
        "connectionId": "0100000B000000000002",
        "transformationType": "",
        "config": [
          {
            "key": "File Name",
            "value": "testing.log"
          },
          {
            "key": "interimDirectory",
            "value": "/home/agent/infa/test_file_target"
          },
          {
            "key": "rolloverSize",
            "value": 100
          },
          {
            "key": "rolloverEvents",
            "value": 100
          },
          {
            "key": "rolloverTime",
            "value": 100
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "FileToFile_source",
        "to": "FileToFile_target"
      }
    ],
    "runtimeOptions": {
      "maxLogSize": {
        "value": 10,
        "unit": "MB"
      },
      "logLevel": "INFO"
    }
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Configuration information in the config array for flat file as a source and as a target

Configuration information in the config array for flat file as a source and as a target

POST response example