REST API for Oracle Primavera Gateway

All REST Endpoints

App Instance Configurations

Returns all appInstanceConfig business objects.: Method: get
Path: /gatewayapi/restapi/v1/appInstanceConfigurations/list
Returns the appInstanceConfig business object for the specified appInstanceConfig ID.: Method: get
Path: /gatewayapi/restapi/v1/appInstanceConfigurations/{id}

App Instances

Creates an AppInstance business object.: Method: post
Path: /gatewayapi/restapi/v1/appInstances
Deletes an AppInstance business object identified by its ID.: Method: delete
Path: /gatewayapi/restapi/v1/appInstances/delete/{id}
Deletes an AppInstance business object identified by its ID.: Method: delete
Path: /gatewayapi/restapi/v1/appInstances/{id}
Returns all AppInstance business objects.: Method: get
Path: /gatewayapi/restapi/v1/appInstances/list
Returns all deployment business objects.: Method: get
Path: /gatewayapi/restapi/v1/appInstances/deployments
Returns an AppInstance business object for the specified AppInstance ID.: Method: get
Path: /gatewayapi/restapi/v1/appInstances/{id}
Test deployment connection.: Method: post
Path: /gatewayapi/restapi/v1/appInstances/testConnection
Updates the AppInstance identified by the AppInstance ID.: Method: put
Path: /gatewayapi/restapi/v1/appInstances/{id}

Customization

Returns all customization apps: Method: get
Path: /gatewayapi/restapi/v1/customization/list
Returns the customization update result: Method: post
Path: /gatewayapi/restapi/v1/customization

Event Services

Creates an event in an application instance.: Method: post
Path: /gatewayapi/restapi/v1/eventServices/processEvent/{appInstanceName}
Returns all event provider instance configuration parameters associated with an application instance.: Method: get
Path: /gatewayapi/restapi/v1/eventServices/eventProviderInstanceConfigs/{appInstanceName}

External Steps

Creates or log message: Method: post
Path: /gatewayapi/restapi/v1/externalStep/createLog
Creates or log message: Method: post
Path: /gatewayapi/restapi/v1/externalStep/writeMessage
Creates warning log message: Method: post
Path: /gatewayapi/restapi/v1/externalStep/createWarningLog
Retreives the object key name value: Method: post
Path: /gatewayapi/restapi/v1/externalStep/getObjectKeyName
Retrieve provider deployment configuration for validation: Method: get
Path: /gatewayapi/restapi/v1/externalStep/loadInstanceConfig
Returns all pending External Step Requests by GUID: Method: get
Path: /gatewayapi/restapi/v1/externalStep/pending
Returns Attachment byte array by attachment id: Method: get
Path: /gatewayapi/restapi/v1/externalStep/retrieveAttachment
Returns External Step Requests by flow step instance id: Method: get
Path: /gatewayapi/restapi/v1/externalStep/extReq
Returns External Step Requests by flow step instance id: Method: get
Path: /gatewayapi/restapi/v1/externalStep/flowStepInst
Returns Load Objects by app instance id and flow id: Method: post
Path: /gatewayapi/restapi/v1/externalStep/loadObjects
Returns the object level log detail.: Method: get
Path: /gatewayapi/restapi/v1/objectLogData/summary
Sends child flow info: Method: post
Path: /gatewayapi/restapi/v1/externalStep/sendChildFlowResult
Sends deployment validation result: Method: get
Path: /gatewayapi/restapi/v1/externalStep/sendValidationResult
Sends External Step execution result: Method: post
Path: /gatewayapi/restapi/v1/externalStep/sendStepResult
Sends object log: Method: post
Path: /gatewayapi/restapi/v1/externalStep/sendObjectLog
Sends project key map: Method: post
Path: /gatewayapi/restapi/v1/externalStep/sendProjectKepMap
Starts external step and sends request data: Method: get
Path: /gatewayapi/restapi/v1/externalStep/start
Stores Attachment byte array: Method: post
Path: /gatewayapi/restapi/v1/externalStep/storeAttachment

Flow Definition Apps

Returns all flowDefinitionApp business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowDefinitionApps/list

Flow Field Map Templates

Returns all flowFieldTemplateMap business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowFieldMapTemplates/list
Returns the flowFieldTemplateMap business object for the specified flowFieldMapTemplate ID.: Method: get
Path: /gatewayapi/restapi/v1/flowFieldMapTemplates/{id}

Flow Instances

Returns all child flowInstance business objects for the specified parent FlowInstances ID.: Method: get
Path: /gatewayapi/restapi/v1/flowInstances/childrenOf/{id}
Returns all flowInstance business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowInstances/list
Returns the flowInstance business object for the specified flowInstance ID.: Method: get
Path: /gatewayapi/restapi/v1/flowInstances/{id}

Flow Load Objects

Returns all FlowLoadObject business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowLoadObjects/list

Flow Parameters

Returns all flowParameter business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowParameters/list
Returns the flowParameter business object for the specified flowParameter ID.: Method: get
Path: /gatewayapi/restapi/v1/flowParameters/{id}

Flow Step Instance Messages

Download FlowStepInstanceMessage objects: Method: get
Path: /gatewayapi/restapi/v1/flowStepInstanceMessages/download/{id}
Returns a FlowStepInstanceMessage business object for the specified FlowStepInstanceMessage ID.: Method: get
Path: /gatewayapi/restapi/v1/flowStepInstanceMessages/{id}

Flow Step Instances

Returns all flowStepInstance business objects.: Method: get
Path: /gatewayapi/restapi/v1/flowStepInstances/list
Returns the flowStepInstance business object for the specified flowStepInstance ID.: Method: get
Path: /gatewayapi/restapi/v1/flowStepInstances/{id}

Flows

Creates a Flow business object.: Method: post
Path: /gatewayapi/restapi/v1/flows
Deletes the Flow business object for the specified Flow ID.: Method: delete
Path: /gatewayapi/restapi/v1/flows/delete/{id}
Deletes the Flow business object for the specified Flow ID.: Method: delete
Path: /gatewayapi/restapi/v1/flows/{id}
Retuns the Flow business object for the specified Flow ID.: Method: get
Path: /gatewayapi/restapi/v1/flows/{id}
Returns all Flow business objects.: Method: get
Path: /gatewayapi/restapi/v1/flows/list
Updates the Flow business object for the specified Flow ID.: Method: put
Path: /gatewayapi/restapi/v1/flows/{id}

Object Log

Returns the object level log detail.: Method: get
Path: /gatewayapi/restapi/v1/objectLogData/summary

Parameter Values

Returns all parameterValue business objects.: Method: get
Path: /gatewayapi/restapi/v1/parameterValues/list
Returns the parameterValue business object for the specified parameterValue ID.: Method: get
Path: /gatewayapi/restapi/v1/parameterValues/{id}
Returns the parameterValue businesss objects for the specified Job ID.: Method: get
Path: /gatewayapi/restapi/v1/parameterValues/byJobId

Provider

Deletes an external provider identified by its ID.: Method: post
Path: /gatewayapi/restapi/v1/provider/delete
Returns the provider update result: Method: post
Path: /gatewayapi/restapi/v1/provider

Services

Creates a job process specified by parameters.: Method: post
Path: /gatewayapi/restapi/v1/services/createJobProcessWithParameters/{id}
Creates a job process.: Method: post
Path: /gatewayapi/restapi/v1/services/createJobProcess/{id}

Settings

Returns all ParameterValue business objects associated with a setting.: Method: get
Path: /gatewayapi/restapi/v1/settings/list
Updates settings business object.: Method: post
Path: /gatewayapi/restapi/v1/settings

Synchronizations

Creates a FlowSchedule business object.: Method: post
Path: /gatewayapi/restapi/v1/synchronizations
Deletes the synchronization for the specified synchronization ID.: Method: delete
Path: /gatewayapi/restapi/v1/synchronizations/delete/{id}
Deletes the synchronization for the specified synchronization ID.: Method: delete
Path: /gatewayapi/restapi/v1/synchronizations/{id}
Returns all flowSchedule business objects associated with a synchronization for the specified synchronization ID.: Method: get
Path: /gatewayapi/restapi/v1/synchronizations/{id}
Returns all FlowSchedule business objects.: Method: get
Path: /gatewayapi/restapi/v1/synchronizations/list
Updates the synchronization identified by the synchronization ID.: Method: put
Path: /gatewayapi/restapi/v1/synchronizations/{id}