Order Parameter

Parameter

The Parameter object contains a value of the given parameter along with additional information, like constraints and validation errors.

Field	Type	Description
id	string	The primary identifier for the parameter.
name	string	The display name for the parameter.
externalId	string	The ID of the parameter within the external system.
value	string	The parameter's updatable value.
displayValue	string	The read-only value for the parameter.
constraints		Parameter constraints. When specified, the value represents overridden parameter constraints. When not specified, parameter constraints must be taken from the parameter definition.
error	message	A reference to the error object. When specified represents a parameter validation error.

Example

PARAMETER

{
    "id": "PRM-1234-1234-1234-1234",
    "name": "Tennant Id",
    "externalId": "tenant_id",
    "constraints": {
        "readonly": false,
        "hidden": true,
        "required": true,
        "unique": false
    },
    "value": "69b73824-ce76-4866-ad47-b615ae9d8998",
    "error": {
        "id": "E001234",
        "message": "Incorrect parameter value"
    }
}

Parameter Constraints

Parameter Constraints define the overridden behavior of a parameter.

Field	Type	Description
readonly	bool	The parameter may be only viewed.
hidden	bool	The parameter must not be shown to user.
required	bool	The parameter value is required.
unique	bool	The parameter value is unique.

Example

PARAMETER CONSTRAINTS

{
    "readonly": false,
    "hidden": true,
    "required": true,
    "unique": false
}

Parameter Group

Parameter Group is used to visually split different types of parameters.

Field	Type	Description
ordering	Parameter []	Array of ordering parameters
fulfillment	Parameter []	Array of fulfillment parameters

Example

PARAMETER GROUP

{
    "ordering": [...],
    "fulfillment": [...]
}