Previous topic

PeriodicTaskManagement

Next topic

Version Management

REST Interface

This document set specifies the backend interface used in the APS infrastructure including interfaces on the application, session, and transport layers as in the following list:

  • Application Programming Interface (API) is used for calling different methods in the APS controller and APS applications. It is the major part of this document set, especially in these documents:

    • APS Controller: an overview of object collections processed by the APS controller

    • APS Application: the APS application interface and APS application instance operations

    • Resources: operations with resources

    • APS Events: operations with various event types

    • Types: operations with APS types

    • Packages: operations with APS packages

  • The other documents explain API specifics:

    • Protocols: specifics of application and transport protocols including setting a session, authentication, HTTP headers, and response codes

    • Resource Query Language: an extension to API requests that enables a requester to filter and sort the required resources