Order Parameter

Parameter object

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

Field	Type	Description
id	string	(Read-only) Primary identifier for the parameter.
name	string	(Read-only) Display name for the parameter.
externalId	string	(Read-only) The ID of the parameter within the external system.
value	string	(Optional) The parameter's value that can be updated.
displayValue	string	(Read-only) (Optional) Read-only value for the parameter.
constraints	object	(Optional) Represents the parameter constraints object. If specified, the value represents overridden parameter constraints. If unspecified, parameter constraints must be taken from the parameter definition.
error	object	(Optional) Represents the error object.

PARAMETER OBJECT

{
    "id": "PRM-1234-1234-1234-1234",
    "name": "Tenant 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 object

Parameter Constraints define the overridden behavior of a parameter.

Field	Data	Description
readonly	bool	The parameter can only be viewed.
hidden	bool	The parameter is hidden and must not be shown to the user.
required	bool	The parameter value is required.
unique	bool	The parameter value is unique.

PARAMETER CONSTRAINTS OBJECT

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

Parameter Group object

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

Field	Type	Description
ordering	Parameter []	(Optional) Array of ordering parameters.
fulfillment	Parameter []	(Optional) Array of fulfillment parameters.

PARAMETER GROUP OBJECT

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