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

      • get /v1/appInstanceConfigurations/list

        Response Class

        AppInstanceConfig {
        appConfig (AppConfig): The application configuration associated with the application instance configuration.,
        appInstance (AppInstance): The list of application instances associated with a flow.,
        id (integer): The unique ID of the application instance configuration generated by the system. ,
        value (string): The value of the application instance configuration entered by the user.
        }
        AppConfig {
        configType (AppConfigType) = ['String' or 'Integer' or 'Long' or 'Date' or 'Boolean' or 'Password' or 'File' or 'Readonly']: The category of application configuration.,
        id (integer): The unique ID of the application instance configuration generated by the system. ,
        name (string): The name of the application configuration.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        appInstId

        (required)

        ID of application instance. query integer
      • get /v1/appInstanceConfigurations/{id}

        Response Class

        AppInstanceConfig {
        appConfig (AppConfig): The application configuration associated with the application instance configuration.,
        appInstance (AppInstance): The list of application instances associated with a flow.,
        id (integer): The unique ID of the application instance configuration generated by the system. ,
        value (string): The value of the application instance configuration entered by the user.
        }
        AppConfig {
        configType (AppConfigType) = ['String' or 'Integer' or 'Long' or 'Date' or 'Boolean' or 'Password' or 'File' or 'Readonly']: The category of application configuration.,
        id (integer): The unique ID of the application instance configuration generated by the system. ,
        name (string): The name of the application configuration.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of application configuration instance. path integer
  • appInstances : The appInstances service supports operations associated with Gateway application instances.

      • post /v1/appInstances

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        body

        application/json

        The application instance object to be created. body
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
      • get /v1/appInstances/deployments

        Response Class

        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }


        Response Content Type: application/json

      • put /v1/appInstances/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of application instance. path integer
        body

        application/json

        The application instance object to be updated. body
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
      • delete /v1/appInstances/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of application instance. path integer
      • get /v1/appInstances/{id}

        Response Class

        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of application instance. path integer
      • get /v1/appInstances/list

        Response Class

        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        appId

        (required)

        ID of application object. query integer
  • eventServices : The eventServices service supports operations on the Event and EventProviderInstanceConfigs business objects.

      • post /v1/eventServices/processEvent/{appInstanceName}

        Response Class

        boolean


        Response Content Type: application/json

      • get /v1/eventServices/eventProviderInstanceConfigs/{appInstanceName}

        Response Class

        EventProviderInstanceConfigs {
        EventListenerConfigList (array[EventListenerConfigs]): A reference to the EventListenerConfig business object.,
        EventProviderConfig (EventProviderConfigs): A reference to the EventProviderConfig business object.,
        description (string): A description of the event provider instance configuration.,
        id (integer): The unique ID of the EventProviderInstanceConfig generated by the system.
        }
        EventListenerConfigs {
        businessFlowName (string): The business flow name associated with the event listener configuration. ,
        configNames (array[string], optional),
        configValueMap (Map[string,string]): The configuration value mappings associated with the event listener configuration.,
        name (string): The name of the event listener configuration.,
        synchronizationName (string): The synchronization name associated with an event listener configuration.
        }
        EventProviderConfigs {
        ConfigValueMap (Map[string,string]): The configuration value mappings associated with the event provider configuration..,
        configNames (array[string], optional),
        name (string): The name of the event provider configuration.,
        version (string): The version number of the event provider configuration.
        }


        Response Content Type: application/json

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

      • get /v1/flowDefinitionApps/list

        Response Class

        FlowDefinitionApp {
        app (App): A reference to the App business object.,
        children (array[FlowDefinitionApp]): A list of flow definition applications.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow definition application generated by the system.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowDefinitionId

        (required)

        ID of flow definition object. query integer
  • flowFieldMapTemplates : The flowFieldMapTemplates service supports operations on the flowFieldMapTemplates business object.

      • get /v1/flowFieldMapTemplates/list

        Response Class

        FlowTemplateMap {
        fieldMapTemplate (FieldMapTemplate): A reference to the fieldMapTemplate business object.,
        id (integer): The unique ID of the flow template map generated by the system.,
        type (TemplateType) = ['Both' or 'Create' or 'Update']: The type of fieldmap template associated with a flow template map.
        }
        FieldMapTemplate {
        description (string, optional): A description of the fieldmap template.,
        id (integer, optional): The unique ID of the fieldmap template generated by the system. ,
        name (string, optional): The name of the fieldmap template.,
        type (FieldMapTemplateType, optional) = ['Direct' or 'Java' or 'Groovy']: The type of fieldmap template.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowId

        (required)

        ID of flow object. query integer
      • get /v1/flowFieldMapTemplates/{id}

        Response Class

        FlowTemplateMap {
        fieldMapTemplate (FieldMapTemplate): A reference to the fieldMapTemplate business object.,
        id (integer): The unique ID of the flow template map generated by the system.,
        type (TemplateType) = ['Both' or 'Create' or 'Update']: The type of fieldmap template associated with a flow template map.
        }
        FieldMapTemplate {
        description (string, optional): A description of the fieldmap template.,
        id (integer, optional): The unique ID of the fieldmap template generated by the system. ,
        name (string, optional): The name of the fieldmap template.,
        type (FieldMapTemplateType, optional) = ['Direct' or 'Java' or 'Groovy']: The type of fieldmap template.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow template map object. path integer
  • flowInstances : The flowInstances service supports operations on the flowInstance business object.

      • get /v1/flowInstances/list

        Response Class

        FlowInstance {
        ErrorDataDesc (string): A description of the error data associated with the flow instance.,
        childInstances (array[long]): A list of child flow instances associated with a flow instance object.,
        endTime (string): The end time when a flow instance was completed. ,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowSchedule (FlowSchedule): _TESTING=The indicator that determines whether a flow schedule has undergone testing for the production environment. ,
        hostName (string): The host name associated with a flow instance.,
        id (integer): The unique ID of the flow instance generated by the system.,
        parentFlowInstanceId (integer): The unique ID of the parent flow instance associated with the child flow instance. ,
        startTime (string): The start time of the flow instance.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow instance.
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowId

        (required)

        ID of flow object. query integer
      • get /v1/flowInstances/childrenOf/{id}

        Response Class

        FlowInstance {
        ErrorDataDesc (string): A description of the error data associated with the flow instance.,
        childInstances (array[long]): A list of child flow instances associated with a flow instance object.,
        endTime (string): The end time when a flow instance was completed. ,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowSchedule (FlowSchedule): _TESTING=The indicator that determines whether a flow schedule has undergone testing for the production environment. ,
        hostName (string): The host name associated with a flow instance.,
        id (integer): The unique ID of the flow instance generated by the system.,
        parentFlowInstanceId (integer): The unique ID of the parent flow instance associated with the child flow instance. ,
        startTime (string): The start time of the flow instance.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow instance.
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow instance. path integer
      • get /v1/flowInstances/{id}

        Response Class

        FlowInstance {
        ErrorDataDesc (string): A description of the error data associated with the flow instance.,
        childInstances (array[long]): A list of child flow instances associated with a flow instance object.,
        endTime (string): The end time when a flow instance was completed. ,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowSchedule (FlowSchedule): _TESTING=The indicator that determines whether a flow schedule has undergone testing for the production environment. ,
        hostName (string): The host name associated with a flow instance.,
        id (integer): The unique ID of the flow instance generated by the system.,
        parentFlowInstanceId (integer): The unique ID of the parent flow instance associated with the child flow instance. ,
        startTime (string): The start time of the flow instance.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow instance.
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow instance. path integer
  • flowLoadObjects : The flowLoadObjects service supports operations on the flowLoadObject business object.

      • get /v1/flowLoadObjects/list

        Response Class

        FlowLoadObject {
        flowBusinessObject (FlowBusinessObject): A reference to a flow business object.,
        id (integer): The unique ID of the flow load object generated by the system.
        }
        FlowBusinessObject {
        businessObject (BusinessObject): A reference to a business object.,
        id (integer): The unique ID of the flow business object generated by the system.
        }
        BusinessObject {
        description (string): A description of the business object.,
        id (integer): The unique ID of the business object generated by the system.,
        name (string): The name of the flow business object.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowId

        (required)

        ID of flow object. query integer
  • flowParameters : The flowParameters service supports operations on the flowParameter business object.

      • get /v1/flowParameters/list

        Response Class

        FlowParameter {
        defaultValue (string): The default value of the parameter.,
        hidden (boolean): An indicator which determines whether the flow parameter is a hidden object.,
        id (integer): The unique ID of the flow parameter generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        readOnly (boolean): An indicator which determines whether the flow parameter is a read-only object.,
        required (boolean): The parameter that must be present when a flow is run.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowId

        (required)

        ID of flow object. query integer
      • get /v1/flowParameters/{id}

        Response Class

        FlowParameter {
        defaultValue (string): The default value of the parameter.,
        hidden (boolean): An indicator which determines whether the flow parameter is a hidden object.,
        id (integer): The unique ID of the flow parameter generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        readOnly (boolean): An indicator which determines whether the flow parameter is a read-only object.,
        required (boolean): The parameter that must be present when a flow is run.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow parameter object. path integer
  • flowStepInstanceMessages : The flowFieldMapTemplates service supports operations associated with the fieldmap templates corresponding to a flow.

      • get /v1/flowStepInstanceMessages/{id}

        Response Class

        FlowStepInstanceMessage {
        id (integer): The unique ID of the flowstep instance message generated by the system.,
        name (string): The name of the flowstep instance message.,
        seqNo (integer): The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.,
        stringData (string): The input and output messages of each step in a flow.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow step instance message object. path integer
  • flowStepInstances : The flowStepInstances service supports operations on the flowStepInstance business object.

      • get /v1/flowStepInstances/{id}

        Response Class

        FlowStepInstance {
        WarningData (string): Depending on the flow, indicates that data is missing or that there is extra data. The synchronization will run and finish. The user should investigate the messages and fix any problems that are found.,
        errorData (string): An exception occured. The synchronization has failed.,
        errorDataDesc (string): A description of the error data object associated with a flow step instance.,
        flowStepInstanceMessages (array[FlowStepInstanceMessage]): A reference to the flowStepInstMsg business object.,
        id (integer): The unique ID of the flowstep instance generated by the system.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The job status associated with the flowstep instance. ,
        warningDataDesc (string): A description of the error data associated with the warning data.
        }
        FlowStepInstanceMessage {
        id (integer): The unique ID of the flowstep instance message generated by the system.,
        name (string): The name of the flowstep instance message.,
        seqNo (integer): The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.,
        stringData (string): The input and output messages of each step in a flow.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow step instance object. path integer
      • get /v1/flowStepInstances/list

        Response Class

        FlowStepInstance {
        WarningData (string): Depending on the flow, indicates that data is missing or that there is extra data. The synchronization will run and finish. The user should investigate the messages and fix any problems that are found.,
        errorData (string): An exception occured. The synchronization has failed.,
        errorDataDesc (string): A description of the error data object associated with a flow step instance.,
        flowStepInstanceMessages (array[FlowStepInstanceMessage]): A reference to the flowStepInstMsg business object.,
        id (integer): The unique ID of the flowstep instance generated by the system.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The job status associated with the flowstep instance. ,
        warningDataDesc (string): A description of the error data associated with the warning data.
        }
        FlowStepInstanceMessage {
        id (integer): The unique ID of the flowstep instance message generated by the system.,
        name (string): The name of the flowstep instance message.,
        seqNo (integer): The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.,
        stringData (string): The input and output messages of each step in a flow.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowInstanceId

        (required)

        ID of flow instance object. query integer
  • flows : The Flows service supports operations on the Flow business object.

      • post /v1/flows

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        body

        application/json

        The flow object to be created. body
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
      • put /v1/flows/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow object. path integer
        body

        application/json

        The flow object to be updated. body
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
      • delete /v1/flows/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow object. path integer
      • get /v1/flows/{id}

        Response Class

        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow object. path integer
      • get /v1/flows/list

        Response Class

        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        flowDefinitionId

        (required)

        ID of flow definition object. query integer
        isUser

        true

        false (default)

        Use current user name if 'true'. query boolean
  • parameterValues : The parameterValues service supports operations on the parameterValues business object. Each parameterValue is identified by a unique ID.

      • get /v1/parameterValues/list

        Response Class

        ParameterValue {
        id (integer): The unique ID of the parameter value generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        value (string): The value of the parameter.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        scheduleId

        (required)

        ID of flow schedule object. query integer
      • get /v1/parameterValues/{id}

        Response Class

        ParameterValue {
        id (integer): The unique ID of the parameter value generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        value (string): The value of the parameter.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of parameter value object. path integer
      • get /v1/parameterValues/byJobId

        Response Class

        ParameterValue {
        id (integer): The unique ID of the parameter value generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        value (string): The value of the parameter.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        jobId

        (required)

        ID of flow instance object. query integer
        paramName

        (required)

        The name of the parameter. query string
  • services : The Services service supports operations on the flowInstance business object.

      • post /v1/services/createJobProcess/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow schedule object. path integer
        review

        true

        false (default)

        Flag to indicate if review is enabled. query boolean
      • post /v1/services/createJobProcessWithParameters/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow schedule object. path integer
  • settings : The Settings service supports operations associated with parameterValue business object. Each parameter value is identified by a unique ID.

      • post /v1/settings

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        body

        application/json

        The settings object to be updated. body
        Settings {
        parameterValues (array[ParameterValue])
        }
        ParameterValue {
        id (integer): The unique ID of the parameter value generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        value (string): The value of the parameter.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }
      • get /v1/settings/list

        Response Class

        ParameterValue {
        id (integer): The unique ID of the parameter value generated by the system.,
        parameter (Parameter): A reference to the parameter business object.,
        value (string): The value of the parameter.
        }
        Parameter {
        appTitle (string): The application title associated with the parameter.,
        customerDefined (boolean): An indicator which determines whether a parameter is defined by the customer.,
        defaultValue (string): The default value of the parameter.,
        description (string): A description of the parameter.,
        enumOptions (string): The enumeration options associated with a parameter.,
        group (string): The parameter group associated with the parameter.,
        id (integer): The unique ID of the parameter generated by the system.,
        name (string): The name of the parameter.,
        seqNo (integer): The sequence number of a parameter. The sequence number determines the display order of the parameter in a sequence.,
        side (FlowSide) = ['Source' or 'Destination' or 'PDI']: The side of a data flow that a parameter is associated with. Values include: Source, Desctination, or PDI. ,
        title (string): The title of the parameter.,
        type (ParameterType) = ['String' or 'Int' or 'Double' or 'DateTime' or 'Boolean' or 'Enum' or 'Password' or 'Filter' or 'Custom' or 'HiddenString' or 'Group']: The data type of the parameter. Values include: String, Int, Double, DateTime, Boolean, Enum, Password, Filter, Custom, HiddenString, or Group.
        }


        Response Content Type: application/json

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

      • put /v1/synchronizations/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow schedule object. path integer
        body

        application/json

        The flow schedule object to be updated. body
        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }
      • delete /v1/synchronizations/{id}

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID of flow schedule object. path integer
      • get /v1/synchronizations/{id}

        Response Class

        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        id

        (required)

        ID offlow schedule object. path integer
      • post /v1/synchronizations

        Response Class

        boolean


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        body

        application/json

        The flow schedule object to be created. body
        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }
      • get /v1/synchronizations/list

        Response Class

        FlowSchedule {
        active (boolean): An indicator which determines whether the flow schedule is active.,
        destinationAppInstance (AppInstance): The list of application instances associated with a flow.,
        eventListenerInstance (EventProviderInstance): FLOWSCHEDULE_EVENTLISTENERINSTANCE,
        flow (Flow): The flow object associated with a flow instance.,
        flowDefName (string): The name of the flow definition.,
        flowInstRuns (integer): The number of flow instance runs associated with a flow schedule.,
        id (integer): The unique ID of the flow schedule generated by the system.,
        isParent (boolean): The indicator that determines whether a flow schedule is a parent object. ,
        lastCompletionDate (string): The last completion date of the flow schedule.,
        lastJobRunStatus (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the last job run associated with the flow schedule. Values include: New, Queued, Running, Delegated, On Hold, Rejected, Completed, Completed with Errors, Failed, Noop, or Completed with Warnings.,
        lastRunJobId (integer): The unique ID of the last job run in the flow schedule generated by the system.,
        lastStartDate (string): The last start date associated with the flow schedule.,
        maxRuns (integer): The maximum number of runs allowed for a flow schedule.,
        name (string): The name of the flow schedule.,
        nextRunDate (string): The next run date associated with a flow schedule.,
        noEndDate (boolean): An indicator which determines whether the flow schedule has no end date specified.,
        recurring (boolean): The indicator that determines whether a flow schedule recurs. ,
        schedule (Schedule): The schedule object associated with a flow schedule. This is used for scheduling jobs.,
        sourceAppInstance (AppInstance): The list of application instances associated with a flow.,
        status (JobStatusType) = ['NEW' or 'QUEUED' or 'RUNNING' or 'DELEGATED' or 'ON_HOLD' or 'REJECTED' or 'COMPLETED' or 'COMPLETED_WITH_ERRORS' or 'FAILED' or 'NOOP' or 'COMPLETED_WITH_WARNINGS']: The status of the flow schedule.
        }
        AppInstance {
        app (App): A reference to the App business object.,
        description (string): A description of the application instance.,
        id (integer): The unique ID of the application instance generated by the system.,
        name (string): The name of the application instance associated with the application instance ID.
        }
        App {
        appInstances (array[AppInstance]): The list of application instances associated with a flow.,
        description (string): A description of the application.,
        id (integer): The unique ID of the application generated by the system.,
        name (string): The name of the application associated with the flow.,
        providerName (string): The Oracle Primavera Gateway provider associated with an application.,
        providerPath (string): The path and the folder location of the provider associated with an application. For example, location of the primeprovider folder associated with the Oracle Primavera Prime application.,
        version (string): The application version number.
        }
        EventProviderInstance {
        description (string),
        eventProvider (EventProvider),
        id (integer)
        }
        EventProvider {
        app (App),
        classPath (string),
        description (string),
        id (integer),
        name (string),
        version (string)
        }
        Flow {
        description (string): A description of the flow.,
        destinationApp (App): A reference to the App business object.,
        disableCompare (boolean): The indicator that determines whether the Compare step is enabled or disabled for a flow.,
        flowDefinition (FlowDefinition): The flow definition object associated with a flow.,
        id (integer): The unique ID of the flow generated by the system.,
        name (string): The name of the flow.,
        sourceApp (App): A reference to the App business object.
        }
        FlowDefinition {
        hasCompareStep (boolean): An indicator which determines whether the Compare step exists in a flow definition.,
        id (integer): The unique ID of the flow definition generated by the system.,
        isEnabled (boolean): An indicator which determines whether the flow definition is enabled.,
        name (string): The name of the flow definition.,
        priority (integer): The priority of the flow definition. This value determines the order for displaying the flow definition in the Gateway user interface.
        }
        Schedule {
        endDate (string): The end date of a schedule.,
        scheduleExpression (string): The job schedule in CRON format.,
        scheduleId (integer): The unique ID of the schedule generated by the system.,
        scheduleName (string): The name of the schedule.,
        startDate (string): The start date of a schedule.
        }


        Response Content Type: application/json

        Parameters

        Parameter Value Description Parameter Type Data Type
        deploymentName

        (required)

        The name of deployment. query string
        flowDefinitiontype

        (required)

        The flow definition type. query string