patch

HTTP Request

PATCH /workflows/:workflowReference/parameters/:parameterReference

Path parameters

Parameter
parameterReference	A scoped reference to the notebook. See referencing resources for more information.
workflowReference	A qualified reference to the parameter's workflow. See referencing resources for more information.

This endpoint extends the general API structure.

Authorization

You must have edit access to the underlying workflow, and hour access token must have one of the following scopes:

• workflow.write

Learn more about authorization.

Request body

Provide a JSON object with information about the parameter.

Property name	Type	Description
name	string	The updated name of the parameter. Must be unique within the workflow.
values	list	A list of values associated with the parameter. Will overwrite any existing values.
type	string	The parameter's type. If not specified, type will be inferred based on the set of values. Must be one of the allowed Redivis types, except for geography. Specifically, one of: boolean integer float string date dateTime

Response body

The response body will contain a JSON representation of a parameter.get resource.