API Reference

Create Order Configuration

Use to create task configurations which are sets of operational capabilities you can apply to specific sets of tasks using other API operations. The task configuration ID returned by this service can be attached to tasks and those tasks will get the task configuration's operational capabilities.
Also known as task configuration.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

Id

Int32

The Id of this task configuration.

is_top_level

boolean

Indicates whether this task configuration appears on the driver's default action list.

  • false - does not appear on a driver's default action list
  • true - does appear on a driver's default action list

pre_schedule_buffer

Int32

The time window before the task is scheduled.

post_schedule_buffer

Int32

The time window after the task is scheduled.

time_on_site_buffer_seconds

Int32

The default time on site (seconds) for this task.

action_data

Object

This description is pending a documentation update.

Language