Get asset event setup options

Request#

GET /api/v1/asset-events/options

Requires asset-events:read and an active token creator who remains an administrator of the token’s organization. Event setup and permissions.

Send Authorization: Bearer YOUR_API_TOKEN and Accept: application/json.

Query parameters#

This endpoint does not use query parameters.

Example#

Replace the example ID with an ID from your organization. Set ASSETCENTER_API_TOKEN as described in the quick start.

curl --request GET "https://my.assetcenter.app/api/v1/asset-events/options" \
  --header "Authorization: Bearer $ASSETCENTER_API_TOKEN" \
  --header "Accept: application/json"

Response#

200 OK. Illustrative values; IDs and positions will differ.

Choice arrays and built-in/default field lists are abbreviated below. The actual response returns the complete choices.

{
  "data": {
    "groups": [
      {
        "value": "acquisition",
        "label": "Acquisition Events",
        "builtin_fields": [],
        "default_fields": []
      },
      {
        "value": "lifecycle",
        "label": "Lifecycle Events",
        "builtin_fields": [],
        "default_fields": []
      },
      {
        "value": "condition",
        "label": "Condition Events",
        "builtin_fields": [],
        "default_fields": []
      },
      {
        "value": "decommission",
        "label": "Decommission Events",
        "builtin_fields": [],
        "default_fields": []
      }
    ],
    "colors": [
      "gray",
      "blue"
    ],
    "icons": [
      "box",
      "calendar"
    ],
    "field_types": [
      {
        "value": "number",
        "label": "Number"
      }
    ],
    "categories": [
      {
        "id": 7,
        "name": "Vehicles"
      }
    ],
    "cost_categories": [
      {
        "id": 3,
        "name": "Maintenance"
      }
    ],
    "defaults": {
      "icon": "box",
      "color": "gray",
      "visible": true,
      "limit_to_categories": [],
      "cost_category_id": null
    }
  }
}

Behavior and constraints#

Options include four groups with their value, label, builtin_fields, and default_fields; supported color names, recommended icon names, field type values and labels; this organization’s asset categories and cost categories; and creation defaults. Fields in built-in and default lists include read-only is_system and has_values; remove those when constructing write payloads. Acquisition defaults have no fields; condition defaults include date, time, and notes; lifecycle and decommission defaults additionally include hidden responsible person and cost fields. GET bodies are rejected.

Errors#

401 means the customer token is missing, invalid, expired, or revoked, or its creator is inactive. 403 means the required permission or administrator membership is missing. 404 means the definition is unavailable in the token’s organization, including a shared ID already overridden. 422 means invalid or unsupported input. 429 means the rate limit was reached. Errors and limits.