Execute a step

post/modules/{moduleId}/steps/{stepId}

Internal-Use Only

Executes the step with the specified input values. Depending on the value that is assigned to the waitTime parameter, execution occurs in one of the following ways: If the assigned value is missing, the call waits until the execution is complete before it returns. The outputs variable in the reply contains the output of the execution. The executionState variable is assigned the value completed in the returned stepOutput object.

If the assigned value is a positive number, the call waits the specified number of milliseconds. If the execution completes within the waitTime value, the outputs variable in the reply contains the output of the execution and the executionState variable is set to completed.

If the execution does not complete within waitTime value, the outputs variable is empty and the executionState variable is assigned the value timedOut in the returned stepOutput object.

If the assigned value is zero, the call returns immediately after validation. The outputs variable is empty and the executionState variable is assigned the value submitted in the returned stepOutput object.

If the assigned value is non-numeric or a negative value, the execution fails with an error.

Request Samples

application/vnd.sas.microanalytic.module.step.input+json
1

Response Samples

201
application/vnd.sas.microanalytic.module.step.output+json
1{
2  "links": [],
3  "version": 2,
4  "moduleId": "endtoend",
5  "stepId": "variable_test",
6  "executionState": "completed",
7  "metadata": {
8    "module_id": "endtoend",
9    "step_id": "variable_test"
10  },
11  "outputs": [
12    {
13      "name": "out_string",
14      "value": "gnirtS nI"
15    },
16    {
17      "name": "out_int",
18      "value": -1
19    },
20    {
21      "name": "out_float",
22      "value": 0.9100000000000001
23    },
24    {
25      "name": "out_boolean",
26      "value": 0
27    }
28  ]
29}

Path Parameters

Name	Type	Required	Description
moduleId	string	true	The identifier of the module that contains the step to execute.
stepId	string	true	The identifier of the step to execute.

Query Parameters

Name	Type	Required	Description
waitTime	integer	false	A value that determines how to execute the step. For more information, see the operation description above and Synchronous, Asynchronous, and Timed Execution.

Request Body

The input values to use for the execution.

Describes the input values that are required when a step is validated or executed.

Name	Type	Required	Description
inputs	array [anyOf]NumberVariableStringVariableBooleanVariableArrayVariableObjectVariable	true	The values to pass to the step as inputs for validation or execution. The order of the variables should match the order presented in the input signature.
version	integer	false	The media type's schema version number. The current version is 1. Default: 1
metadata	object	false	A map of name-value pairs that are used to pass metadata from the client to the server. For more information, see Using Transaction Metadata during Step Execution.

Responses

Status	Meaning	Description
201	Created	The StepOutput was created.	Schema
400	Bad Request	The specified inputs were invalid. The step could not be executed.	Schema
404	Not Found	The requested module or step could not be found.	Schema