×

Please give details of the problem

Docs

Find

    Developer Guide

      1. Todo Validation
    1. Release Your User Login
    1. Markdown Template
      1. Backloop
      2. JavaScript Inclusion
      3. Task Reminder Email
      4. Variable Mapping
      5. SubProcess
      6. PDF
    2. Trigger
      1. Lock
      2. Dynamic Variable
      3. List 1000+ Objects
      4. JSONObject Creation
      5. JSONArray Conversion
      6. Number Currency Format
      7. Error Handling
      8. JSONObject Concatenation
      9. Freemarker Container Test
      10. Number Test
      11. Loop
      12. File Visibility
      13. List Hash Sequence
      14. Special Freemarker Characters
      15. Array To List
      16. Salesforce Computation
      17. Metadata
      18. JSONObject Keys Values
    1. Delegation
    2. Access Rights
    3. Dynamic Lanes
    4. Runtime Lanes
    5. Scripted Lanes
    6. Compound Organization Hierarchy
      1. Array From WS
      2. Column Inactivation
      3. Holidays
      4. List Reinitialization
      5. ArrayJSON to JSONArray
      6. Print JSONObject
      7. Invalid Fields
      8. Number Currency Format
      9. Google Tables
      10. Initialization Widget Date
      11. Date
      12. JQuery
      13. Round
      14. Inject JSONObject
      15. Label Modification
      16. Launch Process JQuery
      1. CSS Personalization
      2. CSS Examples
      1. Tags
      2. Retrieving Variables Values
      3. Dialog Window
      4. Autocomplete Widget
      5. JavaScript Report
      6. User Lane Picker
        1. Chart Dashboard Collection
        2. Chart Dashboard
        3. Report Chart
        4. Google Visualization
      7. Collection
      8. Dynamic List
      9. Summing Array
      10. API Listener
      11. File Preview
    1. Performance
      1. Custom Login Page
      2. Redirection ExecutionMode
      3. Mobile Devices
        1. homepage.js
        2. homepage.css
      4. Logout
      5. Header
      6. Menu Bar
      7. Information Tags
      8. Basket
    1. Mobile
    2. Offline
        1. Collections
          1. Process General Tab
            1. Process Step Output Variables
              1. Process Task Email Tab
              2. Process Task SubProcess Tab
              3. Process Task Functional Tab
              4. Process Task Connector Tab
              5. Process Task Manual Tab
              6. Process Task Loop Tab
              7. Process Task Script Tab
            2. Process Step Input Variables
            3. Gate
            4. Process Step Testing Variables
              1. Process Intermediary Event
              2. Process Timer Event
              3. Process Start Event
          2. Process Variables Tab
          3. Process Measures Tab
          4. Process Design
          5. Process Input Tab
          1. Organization
          2. Roles entities
          1. Project Collection Tab
          2. Project Definition Tab
          3. Version
          4. Project Versioned Files Tab
          5. Project Files Tab
          6. Project Description Tab
          7. Project Version Tab
          8. Project Rights Tab
          1. Connectors
          2. Providers
          3. Processes
          1. Composite API Configuration Tab
          2. Composite API Design Tab
        2. Custom Lists
        3. Revision
            1. Image Widget
            2. Spinner Widget
            3. FileUpload Widget
            4. Section Widget
            5. Multi Checkbox Widget
            6. URLInput Widget
            7. RadioButton Widget
            8. Array Widget
            9. Captcha Widget
            10. Checkbox Widget
            11. Report Widget
            12. Geolocation Widget
            13. Button Widget
            14. Custom Widget
            15. TextInput Widget
            16. Tree Widget
            17. List Widget
            18. StaticText Widget
            19. HTML Editor Widget
            20. JavaScript Widget
            21. Tab Widget
            22. HTML Widget
            23. ProgressBar Widget
            24. History Widget
          1. Web Interface Stylesheet Tab
          2. Web Interface Design Tab
          3. Web Interface Analytics Tab
          4. Web Interface Collection Tab
          5. Web Interface API Tab
          6. Web Interface Implementation Tab
          7. Web Interface JS Tab
        1. Scheduled Process
        2. Messages
        1. Configuration
        2. Users
        3. Usage
        1. Connectors
        2. Process Examples
      1. Customer Management
          1. Measuring
          2. Parameters
          3. Execution Path
          4. Runtime Users
        1. Web Interface Reports
        1. Files
        2. Home
        3. My Applications
      1. Collections To Array
      2. Collections BackOffice
      3. Collection JS Freemarker
      4. Collections To List
      1. Composite API Example
      1. Process Reporting API

    Development with Metadata and preferences

    The metadata and preferences are a set of data configured for each user of the account.

    Using metadata and preferences with the resources

    URI

    The uri are of the following format:

    • /config/{customer_id}/user/{user_id}/metadata/{path}?P_mode={mode}
    • /config/{customer_id}/user/{user_id}/preferences/{path}?P_mode={mode}

    with

    • customer_id: the id of the customer (the id of the account)
    • user_id: the id of the user
    • path (optional): the path of the data you want to manage
    • mode : the execution mode where you want to see or update the data

    Content-Type and Accept type

    Those resources will communicate only in JSON. It's why you have to set the Content-Type and the Accept properties to application/json in the header of your HTTP request.

    Methods

    The resources accept the following methods:

    • GET: To get the data
    • PUT or POST: To update or create data
    • DELETE: To remove one key of the data

    info_1 For each action, the rights will be checked

    Samples

    For our example the account (123) is configured with the following metadata:

    1
    2
    3
    4
        identity <structure>
            age  : <number>
            name : <string>
            items: <array of string>
    

    The user (456) will have, for instance, the following values:

    1
    2
    3
    4
    5
    6
        {"identity":{
            "age" : 20,
            "name": "John Doe",
            "items": ["plate", "knife", "fork"]
            }
        }
    

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/age
    RESPONSE: {"data":20}

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/items
    RESPONSE: {"data":["plate", "knife", "fork"]}

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/items/1
    RESPONSE: {"data":"knife"}

    REQUEST: PUT http://live.runmyprocess.com/config/123/user/456/metadata/identity/items/0
    POST DATA: {"data":"cup"}
    RESPONSE: {"data":{"identity":{ "age" : 20, "name": "John Doe", "items": ["cup", "knife", "fork"] } }}

    Freemarker methods

    According to the resources, two methods allow to change metadata or preferences of user with a path.

    • P_change_metadata : Like the resource, you can specify a path to change specificly a key of the metadata.
    • P_change_preferences : Like the resource, you can specify a path to change specificly a key of the preferences.