<div style="float:right;"> <nav> <a href="index.html">Home</a> | <a href="tips.html">Tips</a> </nav> </div> # Orchestration Gateway Service API Specification ## What Is the Orchestration Gateway Service? The orchestration gateway service provides a gateway to VMware Realize Orchestrator (vRO) for services running on vRealize Automation. By using the gateway, consumers of the API can access a vRO instance, and initiate workflows or script actions without having to deal directly with the vRO APIs. Note: Currently orchestration gateway service users can access only one vRO configuration (i.e., instance) per tenant. Access to multiple configurations is not suported. The orchestration gateway service provides a standard way to request code execution by using: * Well-defined and well-known model abstractions; for example, &#x60;LiteralMap&#x60; for input/output. * Additional metadata needed to handle the request properly; for example, workflow/action definition ID, tenant ID, requester details, and so on. When execution of a vRO workflow based on the request occurs, the orchestration gateway tracks code execution, collects the output from the vRO execution, and if needed, provides feedback to the requester. ## Typical Use Cases * The IP address management (IPAM) service or another internal vRA service calls the orchestration gateway service APIs to access a vRO workflow or execute a script. * A solution user, system administrator, or tenant administrator accesses a GUI to configure, modify, or delete a vRO endpoint. ## Key Concepts ### Configuration Configuration for a concrete vRO instance per tenant ### Workflow A vRO workflow. ### ScriptAction A vRO script action. ### vRO Endpoint An endpoint defined on a tenant for accessing vRO. ## How the Orchestration Gateway Works The orchestration gateway service provides APIs that allow an application to list existing categories and workflows associated with a category, and retrieve the workflow definition and workflow definition presentation for a workflow. After the application has obtained a workflow definition and definition presentation, it can request execution of a workflow definition. Similarly, an application can list vRO action definitions, retrieve a specified action definition, and then request vRO action definition execution. In addition, an application can configure a vRO endpoint. After a workflow or action execution is requested, the orchestration gateway service can get execution details and status. It then broadcasts events indicating the changes in the status of tracked workflows, and if requested, notifify the requesterer of a vRO workflow by using a callback method. ## Additional Information For additional information, see the *VRealize Automation Programming Guide*. # APIs ## /api/tenants/{tenantId}/actions ### GET <a id="findO11nActions">Search for o11nAction</a> Searches for o11nAction by containment of name, description and categoryName #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>name</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>categoryName</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>description</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/o11n-action">o11n-action</a>]| ## /api/tenants/{tenantId}/actions/{categoryName}/{actionName}/execute ### POST <a id="executeAction">execute script action</a> Executes synchronously script action. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>categoryName</th> <td>path</td> <td>yes</td> <td>the category name</td> <td> - </td> <td>string </td> </tr> <tr> <th>actionName</th> <td>path</td> <td>yes</td> <td>the action name</td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the run request id | <a href="#/definitions/literal">literal</a>| ## /api/tenants/{tenantId}/actions/{categoryName}/{name} ### GET <a id="getO11nAction">Get o11nAction</a> Get o11nAction by given category name and action name for tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>categoryName</th> <td>path</td> <td>yes</td> <td>the parent category name</td> <td> - </td> <td>string </td> </tr> <tr> <th>name</th> <td>path</td> <td>yes</td> <td>the o11nAction</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the o11nAction | <a href="#/definitions/o11n-action">o11n-action</a>| | 404 | &#x27;Not found&#x27; if no o11nAction for provided input | - | ## /api/tenants/{tenantId}/categories/workflows ### GET <a id="getWorklfowsRootCategory">get root category for given tenant</a> Get the root category for the given tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the root workflowCategory | <a href="#/definitions/o11n-workflowCategory">o11n-workflowCategory</a>| ## /api/tenants/{tenantId}/categories/workflows/{categoryId} ### GET <a id="getWorkflowCategory">get category by parent category id in tenant</a> Get a category by parent category id for requested tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>categoryId</th> <td>path</td> <td>yes</td> <td> (**Pattern**: `.+$`)</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the workflowCategory | <a href="#/definitions/o11n-workflowCategory">o11n-workflowCategory</a>| ## /api/tenants/{tenantId}/configurations ### GET <a id="getConfigurations">Get orchestrationConfiguration in tenant</a> Get the orchestrationConfiguration for the given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the orchestrationConfiguration | Array[<a href="#/definitions/o11n-configuration">o11n-configuration</a>]| | 404 | &#x27;Not found&#x27; if no orchestrationConfiguration with provided configurationId | - | ### PUT <a id="createOrUpdate">Create or Update orchestrationConfiguration in tenant</a> Create or Update orchestrationConfiguration for the given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/o11n-configuration">o11n-configuration</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the orchestrationConfiguration | <a href="#/definitions/o11n-configuration">o11n-configuration</a>| ## /api/tenants/{tenantId}/configurations/certificate ### PUT <a id="">Gets a certificate</a> Gets a certificate for the given configuration #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/o11n-configuration">o11n-configuration</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | | - | ## /api/tenants/{tenantId}/configurations/default ### PUT <a id="useDefault">Set default orchestrationConfiguration for tenant</a> Set the default/embedded orchestrationConfiguration for the given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the orchestrationConfiguration | <a href="#/definitions/o11n-configuration">o11n-configuration</a>| ## /api/tenants/{tenantId}/configurations/default/status ### PUT <a id="testDefaultConfiguration">test default orchestrationConfiguration for tenant</a> test connectivity to default vRO for the given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the ConfigurationStatus | | ## /api/tenants/{tenantId}/configurations/status ### PUT <a id="testConfiguration">test orchestrationConfiguration for tenant</a> test connectivity to vRO according to the given orchestrationConfiguration for the given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/o11n-configuration">o11n-configuration</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the ConfigurationStatus | | ## /api/tenants/{tenantId}/configurations/{configurationId} ### GET <a id="getConfiguration">Get orchestrationConfiguration</a> Get orchestrationConfiguration by given configurationId in specified tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>configurationId</th> <td>path</td> <td>yes</td> <td>the configuration id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the orchestrationConfiguration | <a href="#/definitions/o11n-configuration">o11n-configuration</a>| | 404 | &#x27;Not found&#x27; if no orchestrationConfiguration with provided configurationId | - | ### DELETE <a id="deleteConfiguration">Delete orchestrationConfiguration</a> Delete orchestrationConfiguration. Only Solution user, system and tenant admins can delete orchestrationConfigurations. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>configurationId</th> <td>path</td> <td>yes</td> <td>the configuration id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 204 | &#x27;No Content&#x27; is returned on successful delete. | - | ## /api/tenants/{tenantId}/inventory/objectUri/{objectUri} ### GET <a id="findInventoryResourceByObjectUri">Get inventory resource by objectUri in given tenant</a> Get inventory resource by provided objectUri in given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>objectUri</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the o11n-inventoryResource | <a href="#/definitions/o11n-inventoryResource">o11n-inventoryResource</a>| | 404 | &#x27;Not found&#x27; if no o11n-inventoryResource with requested parameters | - | ## /api/tenants/{tenantId}/inventory/{vcoType} ### GET <a id="findInventoryResources">Get inventory resources by provided vcoType in given tenant</a> Get inventory resources by provided vcoType in given tenant. Additional ciretira could be supplied to narrow down the response #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>vcoType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>criteria</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with list of o11n-inventoryResource | Array[<a href="#/definitions/o11n-inventoryResource">o11n-inventoryResource</a>]| ## /api/tenants/{tenantId}/inventory/{vcoType}/{id} ### GET <a id="findInventoryResource">Get inventory resource by provided vcoType and id in given tenant</a> Get inventory resource by provided vcoType and id in given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>vcoType</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>id</th> <td>path</td> <td>yes</td> <td> (**Pattern**: `.+$`)</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the o11n-inventoryResource | <a href="#/definitions/o11n-inventoryResource">o11n-inventoryResource</a>| | 404 | &#x27;Not found&#x27; if no o11n-inventoryResource with requested parameters | - | ## /api/tenants/{tenantId}/metadata ### GET <a id="getPluginNames">Get endpoint names in given tenant</a> Get endpoint names in given tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with collection of names | <a href="#/definitions/entities">entities</a>| ## /api/tenants/{tenantId}/metadata/types ### GET <a id="getInventoryTypes">Get Inventory types</a> Get inventory types in the provided tenantId, according to filter criteria . #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>endpointType</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>typeName</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>includeSimpleTypes</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>boolean </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the inventory type Schema | Array[<a href="#/definitions/o11n-inventoryType">o11n-inventoryType</a>]| ## /api/tenants/{tenantId}/metadata/{endpointName} ### GET <a id="findPluginMetadata">Get endpoint metadata for given endpointName</a> Get endpoint metadata for given endpointName in provided tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>endpointName</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the o11nEndpointMetadata | <a href="#/definitions/o11n-endpointMetadata">o11n-endpointMetadata</a>| | 404 | &#x27;Not found&#x27; if no o11nEndpointMetadata with provided endpointName in requested tenant | - | ## /api/tenants/{tenantId}/metadata/{endpointName}/{type}/icon ### GET <a id="getInventoryTypeIcon">Get Inventory type icon</a> Get inventory type icon for the given endpointName and type in provided tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>endpointName</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>type</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the inventory type icon | <a href="#/definitions/O11nIcon">O11nIcon</a>| | 404 | &#x27;Not found&#x27; if no o11nEndpointMetadata with provided endpointName in requested tenant | - | ## /api/tenants/{tenantId}/metadata/{endpointName}/{type}/schema ### GET <a id="getInventoryTypeSchema">Get Inventory type schema</a> Get inventory type schema for the given endpointName and type in provided tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>endpointName</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>type</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the inventory type Schema | <a href="#/definitions/Schema">Schema</a>| | 404 | &#x27;Not found&#x27; if no o11nEndpointMetadata with provided endpointName in requested tenant | - | ## /api/tenants/{tenantId}/metadata/{endpointName}/{type}/values ### POST <a id="getFieldValues">Get permissible values</a> Get permissible values for inventory type from given endpoint in provided tenantId. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>endpointName</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>type</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>asTree</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>boolean </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/elementValuesRequest">elementValuesRequest</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the values | <a href="#/definitions/elementValues">elementValues</a>| ## /api/tenants/{tenantId}/package/import ### POST <a id="importPackage">Import package</a> Import package in vCO. Operation will succeed even in case the prerequisites for the content to import are not presented. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>fileupload</th> <td>formData</td> <td>yes</td> <td></td> <td> - </td> <td>file </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the string value &#x27;SUCCESS&#x27; in case of success | | | 400 | &#x27;Bad Request&#x27; in case of error | - | ## /api/tenants/{tenantId}/requests/correlation/{correlationType}/{correlationId}/info ### GET <a id="getRoutineRunInfoWithCorrelation">Get run info</a> Retrieves a run information for the given correlation type and id. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>correlationType</th> <td>path</td> <td>yes</td> <td>the correlation type</td> <td> - </td> <td>string </td> </tr> <tr> <th>correlationId</th> <td>path</td> <td>yes</td> <td>the correlation id</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the runInfo | <a href="#/definitions/routineRunInfo">routineRunInfo</a>| | 404 | &#x27;Not found&#x27; if no runInfo with provided requestId | - | ## /api/tenants/{tenantId}/requests/{requestId}/cancel ### PATCH <a id="cancelRunRequest">Cancel run request</a> Cancels run result for the given request id. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>requestId</th> <td>path</td> <td>yes</td> <td>the request id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 204 | &#x27;No Content&#x27; is returned on successful cancel. | - | ## /api/tenants/{tenantId}/requests/{requestId}/info ### GET <a id="getRoutineRunInfo">Get run info</a> Retrieves a run information for a given request id. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>requestId</th> <td>path</td> <td>yes</td> <td>the request id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the runInfo | <a href="#/definitions/routineRunInfo">routineRunInfo</a>| | 404 | &#x27;Not found&#x27; if no runInfo with provided requestId | - | ## /api/tenants/{tenantId}/requests/{requestId}/logs ### GET <a id="getRunStateLogs">Get run logs</a> Retrieves a run logs for a given request id. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>requestId</th> <td>path</td> <td>yes</td> <td>the request id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the logs | <a href="#/definitions/o11n-logs">o11n-logs</a>| | 404 | &#x27;Not found&#x27; if no runRequest with provided requestId | - | ## /api/tenants/{tenantId}/requests/{requestId}/result ### GET <a id="getRoutineRunResult">Get run result</a> Retrieves a run result for a given request id. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>requestId</th> <td>path</td> <td>yes</td> <td>the request id</td> <td> - </td> <td>string (uuid)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the runResult | <a href="#/definitions/routineRunRunResult">routineRunRunResult</a>| | 404 | &#x27;Not found&#x27; if no runResult with provided requestId | - | ## /api/tenants/{tenantId}/workflows/{workflowId} ### GET <a id="getWorkflowById">Get workflow</a> Get workflow by given workflowId from the vRO configured for the current tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>workflowId</th> <td>path</td> <td>yes</td> <td>the workflow id</td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | &#x27;Success&#x27; with the workflow | <a href="#/definitions/o11n-workflow">o11n-workflow</a>| | 404 | &#x27;Not found&#x27; if no workflow with provided workflowId in current tenant | - | ### POST <a id="runWorkflow">Request workflow to run</a> Request workflow, by given workflowId, to run by the vRO configured for the current tenant. #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>tenantId</th> <td>path</td> <td>yes</td> <td>the tenant id</td> <td> - </td> <td>string </td> </tr> <tr> <th>workflowId</th> <td>path</td> <td>yes</td> <td>the workflow id</td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>yes</td> <td></td> <td> - </td> <td> <a href="#/definitions/routineRunRequest">routineRunRequest</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | &#x27;Success&#x27; with the run request id | | # Definitions ## <a name="/definitions/AndClause">AndClause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/BooleanLiteral">BooleanLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/CallbackEvaluator">CallbackEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/CertificateInfo">CertificateInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>identityCertificateExists</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>issuerName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>principalName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>notValidBefore</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>notValidAfter</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>thumbprint</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Clause">Clause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/CoalesceEvaluator">CoalesceEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ComplexDataType">ComplexDataType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ComplexEvaluator">ComplexEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ConditionalEvaluator">ConditionalEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ConditionalEvaluatorCase">ConditionalEvaluatorCase</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>condition</td> <td> <a href="#/definitions/Clause">Clause</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>value</td> <td> <a href="#/definitions/Evaluator">Evaluator</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ConstantClause">ConstantClause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ConstantValue">ConstantValue</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Constraint">Constraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>value</td> <td> <a href="#/definitions/Evaluator">Evaluator</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ContainsOperator">ContainsOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ContextPermissibleValueList">ContextPermissibleValueList</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/CriteriaOperator">CriteriaOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/CustomPropertyDefinitionMetadata">CustomPropertyDefinitionMetadata</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/DataType">DataType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>typeId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/DefaultValueBehavior">DefaultValueBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/DisplayTextBehavior">DisplayTextBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/DynamicPermissibleValueList">DynamicPermissibleValueList</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/DynamicValueContext">DynamicValueContext</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>providerEntityId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>parameterMappings</td> <td> <a href="#/definitions/ParameterMappingCollection">ParameterMappingCollection</a> </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/EditableBehavior">EditableBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ElementState">ElementState</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>dependencies</td> <td> array[string] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>facets</td> <td> array[<a href="#/definitions/Constraint">Constraint</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ElementValuesPagingInfo">ElementValuesPagingInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>offset</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>count</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/EncryptedBehavior">EncryptedBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/EndsWithOperator">EndsWithOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/EntityReferenceDataType">EntityReferenceDataType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/EqualsOperator">EqualsOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Evaluator">Evaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Expression">Expression</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ExternalValue">ExternalValue</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Field">Field</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>label</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataType</td> <td> <a href="#/definitions/DataType">DataType</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>displayAdvice</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>permissibleValues</td> <td> <a href="#/definitions/PermissibleValueList">PermissibleValueList</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>state</td> <td> <a href="#/definitions/ElementState">ElementState</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>isMultiValued</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>columns</td> <td> array[<a href="#/definitions/Field">Field</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/FieldReference">FieldReference</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/FixedValueConstraint">FixedValueConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/GreaterThanOperator">GreaterThanOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/GreaterThanOrEqualsOperator">GreaterThanOrEqualsOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/IaasPropertyNameBehavior">IaasPropertyNameBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/IncrementBehavior">IncrementBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/InternalConstraint">InternalConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/IsDefinedOperator">IsDefinedOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/LessThanOperator">LessThanOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/LessThanOrEqualsOperator">LessThanOrEqualsOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Link">Link</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>rel</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>href</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LiteralMapEntry">LiteralMapEntry</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>key</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>value</td> <td> <a href="#/definitions/literal">literal</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/MandatoryConstraint">MandatoryConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MaxCardinalityConstraint">MaxCardinalityConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MaxLengthConstraint">MaxLengthConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MaxValueConstraint">MaxValueConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MaximumValueEvaluator">MaximumValueEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MinCardinalityConstraint">MinCardinalityConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MinLengthConstraint">MinLengthConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MinValueConstraint">MinValueConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MinimumValueEvaluator">MinimumValueEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MonetaryValue">MonetaryValue</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/MultipleEvaluator">MultipleEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/NotClause">NotClause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/NotEqualsOperator">NotEqualsOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/NullDisplayTextBehavior">NullDisplayTextBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/O11nIcon">O11nIcon</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>contentType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>data</td> <td> array[string] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>href</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ObjectDataType">ObjectDataType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/OrClause">OrClause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ParameterMapping">ParameterMapping</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>key</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>value</td> <td> <a href="#/definitions/Evaluator">Evaluator</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ParameterMappingCollection">ParameterMappingCollection</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>params</td> <td> array[<a href="#/definitions/ParameterMapping">ParameterMapping</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PermissibleValueList">PermissibleValueList</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>customAllowed</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PrimitiveDataType">PrimitiveDataType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ReadOnlyConstraint">ReadOnlyConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/RefreshOnChangeBehavior">RefreshOnChangeBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/RegexpConstraint">RegexpConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/ResetValueBehavior">ResetValueBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/Schema">Schema</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>fields</td> <td> array[<a href="#/definitions/Field">Field</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/SkipExportBehavior">SkipExportBehavior</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/StartsWithOperator">StartsWithOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/StaticPermissibleValueList">StaticPermissibleValueList</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/SubsetOperator">SubsetOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/SupersetOperator">SupersetOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/TimeSpan">TimeSpan</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/UniqueConstraint">UniqueConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/UnspecifiedEvaluator">UnspecifiedEvaluator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/VisibilityConstraint">VisibilityConstraint</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/WithinOperator">WithinOperator</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/WrapperClause">WrapperClause</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/booleanLiteral">booleanLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/complexLiteral">complexLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/dateTimeLiteral">dateTimeLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/decimalLiteral">decimalLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/elementValues">elementValues</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>values</td> <td> array[<a href="#/definitions/value">value</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/elementValuesRequest">elementValuesRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>text</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>tenantId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>userId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dependencyValues</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pagingInfo</td> <td> <a href="#/definitions/ElementValuesPagingInfo">ElementValuesPagingInfo</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>associateValue</td> <td> <a href="#/definitions/literal">literal</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>headers</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/entities">entities</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>links</td> <td> array[<a href="#/definitions/Link">Link</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>content</td> <td> array[object] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/entityRef">entityRef</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/entityRefEx">entityRefEx</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/integerLiteral">integerLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/literal">literal</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/literalMap">literalMap</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>entries</td> <td> array[<a href="#/definitions/LiteralMapEntry">LiteralMapEntry</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/money">money</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/moneyRange">moneyRange</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/moneyRate">moneyRate</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/moneyTimeRate">moneyTimeRate</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/multipleLiteral">multipleLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/o11n-action">o11n-action</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>inputParameters</td> <td> array[<a href="#/definitions/o11n-actionParameter">o11n-actionParameter</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resultType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resultContentType</td> <td> <a href="#/definitions/DataType">DataType</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>fqn</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-actionParameter">o11n-actionParameter</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-configuration">o11n-configuration</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>Configuration name</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>Configuration description</td> <td></td> </tr> <tr> <td>host</td> <td> string </td> <td>required</td> <td>vRO host</td> <td></td> </tr> <tr> <td>port</td> <td> integer (int32) </td> <td>optional</td> <td>vRO port</td> <td></td> </tr> <tr> <td>username</td> <td> string </td> <td>optional</td> <td>username to use for authentication</td> <td></td> </tr> <tr> <td>password</td> <td> string </td> <td>optional</td> <td>user password to use for authentication</td> <td></td> </tr> <tr> <td>ssoMode</td> <td> boolean </td> <td>optional</td> <td>Indicates whether this condifuration is for sso mode or not</td> <td></td> </tr> <tr> <td>tenantId</td> <td> string </td> <td>required</td> <td>the id of the tenant where this condifuration belongs to</td> <td></td> </tr> <tr> <td>embedded</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>systemDefault</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-configurationCertificateInfo">o11n-configurationCertificateInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>configurationStatus</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>certificateInfo</td> <td> <a href="#/definitions/CertificateInfo">CertificateInfo</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-endpointMetadata">o11n-endpointMetadata</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>displayName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>enabled</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>configurable</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>icon</td> <td> <a href="#/definitions/O11nIcon">O11nIcon</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>version</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>buildNumber</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-inventoryResource">o11n-inventoryResource</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>href</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pluginName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pluginType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>displayName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>additionalAttributes</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-inventoryType">o11n-inventoryType</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pluginType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pluginName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>properties</td> <td> array[<a href="#/definitions/o11n-inventoryTypeProperty">o11n-inventoryTypeProperty</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>icon</td> <td> <a href="#/definitions/O11nIcon">O11nIcon</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-inventoryTypeProperty">o11n-inventoryTypeProperty</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>displayName</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-logEntry">o11n-logEntry</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>long description</td> <td></td> </tr> <tr> <td>severity</td> <td> string </td> <td>optional</td> <td>severity</td> <td></td> </tr> <tr> <td>timestamp</td> <td> string (date-time) </td> <td>optional</td> <td>timestamp</td> <td></td> </tr> <tr> <td>user</td> <td> string </td> <td>optional</td> <td>user</td> <td></td> </tr> <tr> <td>short-description</td> <td> string </td> <td>optional</td> <td>short description</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-logs">o11n-logs</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>logEntries</td> <td> array[<a href="#/definitions/o11n-logEntry">o11n-logEntry</a>] </td> <td>required</td> <td>log entries</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-workflow">o11n-workflow</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>Workflow id</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>Workflow name</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>required</td> <td>Workflow description</td> <td></td> </tr> <tr> <td>inputParameters</td> <td> array[<a href="#/definitions/o11n-workflowParameter">o11n-workflowParameter</a>] </td> <td>optional</td> <td>Workflow input parameters</td> <td></td> </tr> <tr> <td>outputParameters</td> <td> array[<a href="#/definitions/o11n-workflowParameter">o11n-workflowParameter</a>] </td> <td>optional</td> <td>Workflow output parameters</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-workflowCategory">o11n-workflowCategory</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string </td> <td>required</td> <td>Workflow category id</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>Workflow category name</td> <td></td> </tr> <tr> <td>categories</td> <td> array[<a href="#/definitions/o11n-workflowCategory">o11n-workflowCategory</a>] </td> <td>optional</td> <td>Children Workflow categories</td> <td></td> </tr> <tr> <td>workflows</td> <td> array[<a href="#/definitions/o11n-workflow">o11n-workflow</a>] </td> <td>optional</td> <td>Children Workflows</td> <td></td> </tr> </table> ## <a name="/definitions/o11n-workflowParameter">o11n-workflowParameter</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>required</td> <td>Workflow parameter name</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>Workflow parameter value type</td> <td></td> </tr> <tr> <td>parameterType</td> <td> string </td> <td>optional</td> <td>Workflow parameter type</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>Workflow parameter description</td> <td></td> </tr> </table> ## <a name="/definitions/routineRunCorrelation">routineRunCorrelation</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>correlationType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>correlationId</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/routineRunInfo">routineRunInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> string (uuid) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>routineId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>executionId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>routineRunStatus</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>traceId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>correlation</td> <td> <a href="#/definitions/routineRunCorrelation">routineRunCorrelation</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>tenantId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/routineRunRequest">routineRunRequest</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>requestHeader</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>optional request header to pass to the service which is going to call the routine</td> <td></td> </tr> <tr> <td>requestData</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>optional request data to pass as input when call the routine</td> <td></td> </tr> <tr> <td>correlation</td> <td> <a href="#/definitions/routineRunCorrelation">routineRunCorrelation</a> </td> <td>optional</td> <td>correlation</td> <td></td> </tr> <tr> <td>requestedBy</td> <td> string </td> <td>optional</td> <td>name/id of the user requested the routine run</td> <td></td> </tr> <tr> <td>description</td> <td> string </td> <td>optional</td> <td>human readable description for the routine run request</td> <td></td> </tr> <tr> <td>callbackServiceId</td> <td> string </td> <td>optional</td> <td>service id to callback on routine run complete/fail</td> <td></td> </tr> </table> ## <a name="/definitions/routineRunRunResult">routineRunRunResult</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>correlation</td> <td> <a href="#/definitions/routineRunCorrelation">routineRunCorrelation</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resultHeader</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resultData</td> <td> <a href="#/definitions/literalMap">literalMap</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>runDetails</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>runStatus</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>requestId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>requestedBy</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>createDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>completeDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/secureString">secureString</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/stringLiteral">stringLiteral</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> </table> ## <a name="/definitions/timeSpan">timeSpan</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>unit</td> <td> string </td> <td>optional</td> <td>The unit of measure for the time span. e.g: days.</td> <td></td> </tr> <tr> <td>amount</td> <td> integer (int64) </td> <td>optional</td> <td>The amount for the time span.</td> <td></td> </tr> </table> ## <a name="/definitions/value">value</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>underlyingValue</td> <td> <a href="#/definitions/literal">literal</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>label</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table>