Skip to main content

get_containers

Get all containers with their associated areas.
Property
Read-onlyYes

Parameters

None.

Returns

A list of ContainerDto objects, each containing:
  • containerId, containerCode, containerName, containerDesc — container identity
  • areas — list of areas with ID, name, and description

get_container_process_list

Get the processes configured for a specific container, along with their fields.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDescription
containerIdstringYesContainer ID.

Returns

A list of ContainerProcessDto objects with process name and field names.

get_container_items

Get items belonging to a specific container.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDefaultDescription
containerIdstringYesContainer ID.
includeClosedboolNofalseInclude closed items.
limitintNo100Maximum items to return.

Returns

A list of CycleItemDto objects sorted by key.

get_item_filter_list

Filter items using condition groups. Each group contains AND conditions; groups are OR-ed together.
Property
Read-onlyYes

Parameters

ParameterTypeRequiredDefaultDescription
containerIdsstring[]YesContainer IDs to search within.
conditionsJsonstringYesFilter conditions as JSON (see format below).
includeClosedboolNofalseInclude closed items.
limitintNo100Maximum items to return.

Condition Format

[
  {
    "condition": [
      {
        "leftSide": "<fieldId>",
        "operator": "Equal",
        "rightSide": "<value>"
      }
    ]
  }
]
Operators: Equal, NotEqual, LessThan, LessThanOrEqual, GreaterThan, GreaterThanOrEqual, Contains, StartsWith, EndsWith Use get_field_list and get_status_list to discover field IDs and valid values.

Returns

A list of CycleItemDto objects sorted by key.