CatalogItemVariable - Scoped

  • Release version: Australia
  • Updated March 12, 2026
  • 1 minute to read

    • The CatalogItemVariable API provides methods that enable you to create and modify service catalog item variables using scripts.

    This API runs in the sn_sc namespace.

    CatalogItemVariable - create(Boolean standardUpdate)

    Inserts the specified catalog item variable.

    Table 1. Parameters
    Name Type Description
    standardUpdate Boolean Flag that indicates whether to enable the running of engines and workflow.
    Valid values:
    • true: Enable engines and workflow.
    • false: Do not enable engines and workflow.
    Table 2. Returns
    Type Description
    String Return the sys_id of the inserted variable record.

    CatalogItemVariable - deleteRecord(Boolean standardUpdate)

    Deletes the defined catalog item variable.

    Table 3. Parameters
    Name Type Description
    standardUpdate Boolean Flag that indicates whether to enable the running of engines and workflow.
    Valid values:
    • true: Enable engines and workflow.
    • false: Do not enable engines and workflow.
    Table 4. Returns
    Type Description
    void

    CatalogItemVariable - read(Object columns, Boolean standardUpdate)

    Returns a mapping of catalog item variable attribute values.

    Table 5. Parameters
    Name Type Description
    columns Object Set of columns for which to return values.
    standardUpdate Boolean Flag that indicates whether to enable the running of engines and workflow.
    Valid values:
    • true: Enable engines and workflow.
    • false: Do not enable engines and workflow.
    Table 6. Returns
    Type Description
    Object An object mapping column names to values.

    CatalogItemVariable - setAttributes(Object attributes)

    Defines attribute values for this catalog item variable.

    Table 7. Parameters
    Name Type Description
    attributes Object An object mapping column names to values.
    Table 8. Returns
    Type Description
    void

    CatalogItemVariable - update(Object columnValues, Boolean standardUpdate)

    Updates current catalog item variable with set values.

    Table 9. Parameters
    Name Type Description
    columnValues Object An object mapping column names to values.
    standardUpdate Boolean Flag that indicates whether to enable the running of engines and workflow.
    Valid values:
    • true: Enable engines and workflow.
    • false: Do not enable engines and workflow.
    Table 10. Returns
    Type Description
    void