RunModScript

Description

This service runs a specified SBM ModScript.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
scriptId (required)	Identifier	Identifier for the script to execute.
inputs	ExtendedData	Holds name/value pairing for inputs to the ModScript that you want to execute.

Response

ModScriptHolder is returned. For more detail, see ModScriptHolder.

Usage

Use RunModScript to execute any of the methods available in SBM ModScript. You can also call RunModScript from an orchestration workflow to execute a ModScript. For example, in an orchestration, you might want to invoke a script from the command-line, read/write data to a file, or update an item with text. You can have an orchestration call ModScript for any of these tasks and more.

Note: You can send any one of the elements in scriptId—you do not need to provide values for every element. You only need to provide more than one element in the event that the first element does not uniquely identify the script.

For details on programming with SBM ModScript, refer to the SBM ModScript Reference Guide or SBM Composer help.

Faults

Invalid ModScript <script id>.
The user lacks sufficient permission.
Validation constraint violation: data type mismatch.

XML

The following XML is a snippet of the payload that is sent with RunModScript.

<urn:RunModScript>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:scriptId>
        <urn:displayName>test_script</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
    </urn:scriptId>
    <urn:inputs>
    <urn:data>
        <urn:name>param_two</urn:name>
        <urn:value>two</urn:value>
    </urn:data>
    <urn:data>
        <urn:name>param_one</urn:name>
        <urn:value>one</urn:value>
    </urn:data>
    </urn:inputs>
</urn:RunModScript>