Version 25.3.9411

• Parameters
• Control Attributes
• Example
• See Also

You can use the api:check keyword with or without a value parameter.

Without a value parameter, it is used to ensure that an attribute is present in an item and that it is not a null string before the body of the api:check is executed. If you specify a value parameter, the api:check body executes only if the expression evaluates to true. Other values are considered false. The evaluation is case-insensitive.

Like other simple conditionals in APIScript, you can pair it with an api:else keyword. However, unlike api:equals, api:check does not throw an exception if the attribute does not exist in the item.

Parameters

• item: The item in which to check the attribute. If no item is specified, the default output item is used.
• attr: The name of the attribute to check. Mandatory.
• value: An expression that evaluates to true or false. For example, the result of a formatter that returns true or false.
• action: The action to execute if the expression evaluates to true. Allowed values are break and continue.

Control Attributes

None

Example

Check whether an attribute is set before using it:

<api:check attr="_input.In_Stock">
...
</api:check>

See Also

• api:exists: Check if an attribute exists.
• api:equals: Check for equality.
• api:notequals: Check for inequality.