DaVinci Admin Variables

When: A POST /environments/{envID}/variables or a PUT /environments/{envID}/variables/{davinciVariableID} request supplies a body that violates the data model: an omitted name, context, dataType, or mutable property, a flow object without an id property, a name or displayName longer than 256 characters, an empty or blank name or displayName, a name, displayName, or flow.id value that starts with an unsupported character or contains a < or a ${ sequence, a context value other than flow, flowInstance, company, or user, a dataType value other than string, number, object, boolean, or secret, or a property whose value is not of the documented JSON type

Details: One detail per validation error, each with the failing property path as the target. must have required property 'name', must have required property 'context', must have required property 'dataType', or must have required property 'mutable' with the omitted property as the target when the request omits that property, and must have required property 'id' with target flow when the request supplies a flow object without an id property. must NOT have more than 256 characters for a name or displayName longer than 256 characters. must not be empty or blank for an empty or blank name or displayName. must match pattern "<pattern>", where <pattern> is the schema pattern, for a name, displayName, or flow.id value that starts with an unsupported character or contains a < or a ${ sequence. must be one of the values: flow or flowInstance or company or user for an unknown context value and must be one of the values: string or number or object or boolean or secret for an unknown dataType value. must be string for a property that must be a string, for example with target name, must be boolean for a mutable value that is not a boolean, must be integer for a min or max value that is not an integer, and must be string,number,boolean,object for a value that is not one of those types.

When: A GET /environments/{envID}/variables or a GET /environments/{envID}/variables/{davinciVariableID} request supplies an expand query parameter longer than 100 characters or a filter query parameter longer than 256 characters

Details: Detail code INVALID_PARAMETER with message must NOT have more than 100 characters and target expand for an overlong expand parameter, or message must NOT have more than 256 characters and target filter for an overlong filter parameter.

When: A GET /environments/{envID}/variables request supplies an order query parameter that names an attribute other than name, createdAt, context, value, dataType, or updatedAt

Details: Detail code INVALID_PARAMETER with message Invalid attribute provided for sorting: valid parameters are name, createdAt, context, value, dataType, updatedAt and target order.

When: A GET /environments/{envID}/variables request supplies a limit query parameter that is not a positive integer or is greater than 100

Details: Detail code INVALID_PARAMETER with message Invalid page size provided: page size ranges from 1 to 100 and target limit.

When: A POST request that sets dataType to secret while context is anything other than company, a PUT request that sets dataType to secret for a variable whose context is not company, or a POST request that uses the reserved variable name proto, prototype, or constructor

Details: Detail code INVALID_VALUE with message 'Secret' type is only available for company variables for a secret data type outside the company context, or message Cannot create variable with this name for a reserved name. No target is returned.

When: A POST request sets context to flow without a flow.id property in the request body

Details: Detail code REQUIRED_VALUE with message must have required property 'flow.id' and no target.

When: A POST request creates a variable whose name and context combination already exists in the environment

Details: Detail code UNIQUENESS_VIOLATION with message Construct already exists and no target.

When: A GET /environments/{envID}/variables request supplies a filter query parameter that references an attribute other than context, name, value, createdAt, or updatedAt, an operator that the filtered attribute does not support, or an actor attribute such as createdBy.user.id when actor metadata is disabled for the environment. When actor metadata is enabled, actor attributes support only eq combined through and or or

Details: Detail code INVALID_PARAMETER with message The filter attribute was invalid or does not support filtering. and the invalid attribute as the target, or message The filter operator was invalid or not supported. and the invalid operator or the attribute that does not support it as the target. A filter that is not a well-formed SCIM expression returns detail code INVALID_FILTER with message The specified filter was invalid. and no target.

When: A POST request creates a variable after the environment has reached the maximum number of variables allowed for the environment

Details: Detail code CONSTRAINT_VIOLATION with message Cannot create more constructs due to resource limit and no target.

When: The actor lacks the davinci:create:constructs permission (POST operations), the davinci:read:constructs permission (GET operations), the davinci:update:constructs permission (PUT operations), or the davinci:delete:constructs permission (DELETE operations)

Details: None

When: A GET one, PUT, or DELETE request references a variable ID that does not exist in the environment

Details: None

When: The service encounters an unexpected internal failure while processing a variable operation, including a create or update whose variable value exceeds the 1 MB per-variable size limit when size-limit enforcement is enabled for the environment

Details: None