Description | Example | Return Message | Group(s)

IngestCommands

HTTP Request Formats

POST api/IngestCommands

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/IngestCommands

Description

The SCHED IngestCommands REST API command opens the specified file and processes the connect commands within that file.

Parameters

  • FilePathName: The parameter is a string of text in single quotes of the file name. More information on the acceptable file path formats can be found here.

Examples

Ingest the command file at C:\CommandFile.txt

POST api/IngestCommands

Body:

"C:\CommandFile.txt"

Return Message

If activated, a standard response for a successful HTTP response shall appear.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.3