Validate step inputs

post/commons/validations/modules/{moduleId}/steps/{stepId}
Internal-Use Only

Validates input values that are used to execute the step against the expected input signature of the step. If the input is not formatted properly or does not match the input requirements of the step, one violation of each input parameter is reported.

Request Samples

1

Response Samples

1{
2 "version": 1,
3 "valid": true
4}

Path Parameters

NameTypeRequiredDescription
moduleId
string
true

The identifier of the module to update.

stepId
string
true

The identifier of the step to validate.

Request Body

The input values to validate against the expected input signature of the step.

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

NameTypeRequiredDescription
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

StatusMeaningDescription
201CreatedThe request succeeded.Schema
400Bad RequestThe request body is missing or invalid.Schema
404Not FoundThe requested module or step could not be found.Schema