Skip to main content

Workstations status colors

1. Naming Convention​

  • Status colors must be defined using the prefix status- followed by the specific status type.
  • Example valid names: status-active, status-inactive, status-error, status-imported.
  • Use this convention in API requests replacing <status-key>

2. Valid Workstation Statuses​

The following statuses are valid and must adhere to the naming convention status-[status type]:

  • Active: status-active
  • Closed: status-closed
  • Idle: status-idle
  • Error: status-error
  • Payment: status-payment
  • Finalized: status-finalized
  • Imported: status-imported
  • Cancelled: status-cancelled

3. Configuration Format​

Each status type is associated with a predefined hex color code, for example:

  • Active: #28A745
  • Inactive: #6C757D
  • Error: #DC3545
  • Imported: #FFC107

By enforcing this structure, we maintain uniformity and clarity in workstation status displays.

4. API requests for configuring values​

Set values

⚠️ Important:
When using the set request, all toggle settings of this type will be overwritten with the provided values.
If you intend to change only specific settings, consider using the update request instead.

  • Permission required ["ccc.configuration.update"]
curl --location --request PUT 'https://ccc-api.retailsvc.com/api/v1/config/att.colors-config.v1/values/tenant' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>' \
--data '{
  "value": {
    "colors": {
      "<status-key>":{
          "name": "color name",
          "value": "color code"
      }
    }
  }
}'

Update values

  • Permission required ["ccc.configuration.update"]
curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/att.colors-config.v1/values/tenant?replaceExistingPatch=false&calculateDiff=false&dryRun=false' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>' \
--data '{
  "value": {
    "colors": {
      "<status-key>":{
        "name": "color name",
        "value": "color code"
      }
    }
  }
}'

Get configured values

  • Permission required ["ccc.configuration.get"]
curl --location 'https://ccc-api.retailsvc.com/api/v1/config/att.colors-config.v1/values/tenant?tags=%3Cstring%3E&tags=%3Cstring%3E&getPatch=false' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'

Delete configured values

  • Permission required ["ccc.configuration.delete"]
curl --location --request DELETE 'https://ccc-api.retailsvc.com/api/v1/config/att.colors-config.v1/values/tenant' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'