Skip to main content
Version: 6.0.2

Built-in Services

This document details the input variable schema required for built-in services, facilitating the preparation of variables for Service Integration operations.

Preparing Input Variables Using Schema​

To prepare input variables effectively using the schema, follow these steps:

1. Identify the Input Schema​

Locate the input schema relevant to the action or trigger you intend to execute.

2. Populate the Input Variables​

Follow the structure provided by the input schema to populate each variable:

  • Input variables must be prepared in the order specified by the schema.
  • Handling Non-Primitive Data Types: If an x-datatype is specified, it indicates a non-primitive type.
    • For primitive types, simply input values that match the specified primitive data type.
    • For non-primitive types, you must acquire the datatypeVersionId:
      1. Retrieve Datatypes to select the action you want to utilize.
      2. Fetch Datatype Version to select the required version.
    • You can use datatypeName instead of datatypeVersionId.
  • Fetching Valid Values: To obtain valid values for an x-datatype, use the POST Execute Datatype Version Manually API, referring to the Datatype Schema for necessary input variables.

3. Verify Complete Variable Preparation​

Ensure all necessary input variables are prepared for the action execution:

  • Refreshing Variables: If refreshVariable is set to true, you must refresh the schema after entering the input variables. 
    "x-onChange": {
      "refreshVariables": true
    }
  • If there are no unhandled "refreshVariable": true flags in the action input schema:
  • If unhandled "refreshVariable": true flags exist:
  • Repeat steps 2 and 3 as necessary.