×

Please give details of the problem

Docs

Find

    User Guide

  1. Usage Report
  2. Logs Application
  3. Easy Builder
  4. FAQ
  5. User Management
        1. Composite API Design Tab
        2. Composite API Configuration Tab
        1. Providers
        2. Connectors
        3. Processes
        1. Roles entities
        2. Organization
      1. Collections
        1. Project Files Tab
        2. Project Definition Tab
        3. Project Versioned Files Tab
        4. Project Version Tab
        5. Project Description Tab
        6. Version
        7. Project Rights Tab
        8. Project Collection Tab
        1. Web Interface JS Tab
        2. Web Interface Design Tab
          1. Image Widget
          2. FileUpload Widget
          3. StaticText Widget
          4. ProgressBar Widget
          5. TextInput Widget
          6. JavaScript Widget
          7. Section Widget
          8. Geolocation Widget
          9. Checkbox Widget
          10. RadioButton Widget
          11. Tree Widget
          12. Spinner Widget
          13. History Widget
          14. URLInput Widget
          15. Tab Widget
          16. List Widget
          17. Array Widget
          18. HTML Editor Widget
          19. Report Widget
          20. Button Widget
          21. Custom Widget
          22. Captcha Widget
          23. HTML Widget
          24. Multi Checkbox Widget
        3. Web Interface Analytics Tab
        4. Web Interface Collection Tab
        5. Web Interface Implementation Tab
        6. Web Interface API Tab
        7. Web Interface Stylesheet Tab
      2. Revision
      3. Custom Lists
        1. Process Variables Tab
        2. Process Measures Tab
            1. Process Timer Event
            2. Process Start Event
            3. Process Intermediary Event
          1. Gate
            1. Process Task Loop Tab
            2. Process Task Manual Tab
            3. Process Task Email Tab
            4. Process Task Connector Tab
            5. Process Task SubProcess Tab
            6. Process Task Functional Tab
            7. Process Task Script Tab
          2. Process Step Output Variables
          3. Process Step Testing Variables
          4. Process Step Input Variables
        3. Process General Tab
        4. Process Design
        5. Process Input Tab
      1. Home
      2. My Tasks
      3. My Applications
      4. Files
    1. Customer Management
      1. Messages
      2. Scheduled Process
      1. Process Examples
      2. Connectors
      1. Users
      2. Configuration
      3. Usage
      1. Web Interface Reports
        1. Measuring
        2. Runtime Users
        3. Execution Path
        4. Parameters
    1. RunMyApp for Android
    2. RunMyApp for iOS
    3. RunMyApp for Windows
  6. My Settings
  7. App Translator

Composite API Configuration Tab

Allows you to define general characteristics of the web service representing your process

Title
Name of the Composite API.

Provider url
First part of URL to call Composite API : it is automatically filled up after Composite API creation and can't be modified.

Connector Url
Second part of URL to call Composite API : it is automatically filled up after Composite API creation and can't be modified.

Architecture
Protocol used to start your Composite API (process) : it is REST/XML-RPC

Method
Select the method to use to start the Composite API : GET, POST, PUT, DELETE

Accept media type
Select the media type that RunMyProcess will accept from the web service call to start Composite API (process). Choose "application/json" if you want to use your Composite API within a Web interface API call.

info_1 Header a received request are available in a variable called P_header

Input validation
Allows you to define a freemarker script to check if sent parameters within web service call fulfill given criteria. If not, a error message is automatically sent as an answer and Composite API is not started

Result media type
Select the media type that RunMyProcess will set in the response of the web service call. Choose "application/json" if you want to use your Composite API within a Web interface API call.

Result transformation
Allows you to define a freemarker script that will define response of Composite API call :

Code

1
<root>${P_computed.var1}</root>

Description
Description of Composite API