Get the closed vocabularies

The closed value sets the API enforces, read from the same constants the handlers validate against. A value absent here is a value the runtime rejects.

Includes decision urgency and shape, lifecycle level and action, the accepted ledger event types for the event-stream filter, and the rate classes budgets are drawn from. Account-free.

GET /meta/enums

Get the closed vocabularies

cURL

curl --request GET \
  --url https://useorgx.com/api/v1/meta/enums

200

{
  "data": {
    "version": "1",
    "generated_from": "The constants the route handlers validate against.",
    "schemas_url": "https://useorgx.com/api/v1/meta/schemas",
    "errors_url": "https://useorgx.com/api/v1/errors",
    "enums": [
      {
        "name": "decision_urgency",
        "values": [
          "deferred",
          "standard",
          "urgent",
          "critical"
        ],
        "description": "How soon a decision needs a human ruling.",
        "used_by": [
          "POST /decisions",
          "GET /decisions?urgency="
        ]
      },
      {
        "name": "lifecycle_level",
        "values": [
          "initiative",
          "workstream",
          "milestone",
          "task",
          "run"
        ],
        "description": "Which node of the work hierarchy a lifecycle command names.",
        "used_by": [
          "POST /lifecycle"
        ]
      }
    ]
  },
  "meta": {
    "apiVersion": "1",
    "count": 7
  }
}

Headers

If-None-Match · string

Prior ETag. A match answers 304.

Response

200

application/json

The closed vocabularies v1 enforces

data · object · required

Show child attributes

meta · object · required

Show child attributes