REST Style Architecture

Primavera Gateway API Employs Web-based Technology

The Primavera Gateway API platform employs Web-based technology to handle requests from external programs. External client programs use Primavera Gateway API by creating a request and sending it to the application server using one of the following operations.

Operation

Description

Get

Returns data based on the parameters you provide when you call the operation.

Delete

Deletes objects.

Post

Creates new objects.

Put

Updates existing objects.

Having received the request, Primavera Gateway invokes the required business and security logic to service the request and provide an appropriate response.

The following Primavera Gateway APIs provide REST style services on Gateway business objects:

Service

Description

appInstances

The appInstances service supports operations associated with Gateway application instances.

appInstanceConfigurations

The appInstanceConfigurations service supports operations on configurations of Gateway application instances.

eventServices

The eventServices service supports operations on the Event and EventProviderInstanceConfigs business objects

Flows

The Flows service supports operations on the Flow business object.

flowDefinitionApps

The flowDefinitionApps returns a list of FLowDefinitionApp business objects from the database.

flowFieldMapTemplates

The flowFieldMapTemplates service supports operations associated with the field Map templates corresponding to a flow.

flowInstances

The flowInstances service supports operations on the flowInstance business object.

flowLoadObjects

The flowLoadObjects service supports operations on the flowLoadObject business object.

flowStepInstances

The flowStepInstances service supports operations on the flowStepInstance business object.

flowStepInstanceMessages

The flowStepInstanceMessages service supports operations on the flowStepInstanceMessages business object.

flowParameters

The flowParameters service supports operations on the flowParameter business object.

flowStepInstances

The flowStepInstances service supports operations on the flowStepInstance business object.

parameterValues

The parameterValues service supports operations on the parameterValues business object. Each parameter value is identified by a unique ID.

Services

The Services service schedules a job and queues it for processing.

Settings

The Settings service supports operations associated with parameterValue business object. Each parameter value is identified by a unique ID.

Synchronizations

The Synchronizations service supports operations associated with synchronizations in Primavera Gateway.



Legal Notices
Copyright © 2013, 2015, Oracle and/or its affiliates. All rights reserved.

Last Published Wednesday, March 25, 2015