Skip to main content
Skip table of contents

ROAD Service API

Introduction to the ROAD Service and the architecture: Introduction and General Architecture.

Introduction to ROAD jobs and their data model: Jobs Data.

Introduction to ROAD schedules: Schedule Data.

General description of pipe interfaces used between Service and Workers: Command and Live Interface between ROAD Service and Workers

REST and socket interfaces between Service and clients: Subscriptions, Live Data and Notifications - Overview

Specification of data being transferred via the Service's interfaces is in the REST documentation pages or in sub-pages.

General note for interface command's casing: All field names passed to ROAD's REST and web socket interfaces are accepted in PascalCase and camelCase. All results from these interfaces are formatted with field names in camelCase. All content of fields is expected or returned as quoted in this documentation (usually in PascalCase).

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.