Unit attributes with distinct values

GET /v1/unit-attributes

Operation id: v1UnitAttributes

Tags: Kernel NextGen APIs

Parameters

Query parameters

NameTypeRequiredDescription
auth_tokenstringNo
entity_typestringNoOptional. Entity type filter; defaults to U when omitted.
los_unit_idstringNoOptional. Line-of-sight unit id used when resolving which units' attributes to include; combined with other filters, the server resolves the effective unit set for attribute discovery.
unit_idsarrayNoOptional, repeatable. Restrict results to these unit ids (filter).

Header parameters

NameTypeRequiredDescription
x-reflexis-auth-token-xstringNoAuthentication token (or use auth_token query param)
x-reflexis-domain-xstringNoDomain id string; optional — defaults to token domain

Responses

200 — OK — list envelope; data is the list of attribute value objects built from the server's map of attribute names to distinct values (attribute-name keys are not repeated on each item — each value object carries its own identity). has_more is always false (no pagination).

Content type: application/json

401 — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.

Content type: application/json

500 — An unexpected error occurred while processing the request.

Content type: application/json

Response models

200 — OK — list envelope; data is the list of attribute value objects built from the server's map of attribute names to distinct values (attribute-name keys are not repeated on each item — each value object carries its own identity). has_more is always false (no pagination).

Content type: application/json

Schema

List envelope — object list, url, data array, has_more, optional next_cursor, fetched_at

PropertyTypeRequiredDescription
objectstringNo
urlstringNo
dataarrayNo
has_morebooleanNo
next_cursorstring, nullableNo
fetched_atstring (date-time)No
{
  "type": "object",
  "description": "List envelope — `object` list, `url`, `data` array, `has_more`, optional `next_cursor`, `fetched_at`",
  "properties": {
    "object": {
      "type": "string",
      "example": "list"
    },
    "url": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {}
    },
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "type": "string",
      "nullable": true
    },
    "fetched_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

401 — Authentication failed. The request is missing a token, the token is invalid, or the token has expired.

Content type: application/json

Schema

Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.

PropertyTypeRequiredDescription
errorobjectNo
{
  "type": "object",
  "description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
          "example": "invalid_parameter"
        },
        "code": {
          "type": "string",
          "description": "Machine-readable error code; clients should branch on this rather than `message`.",
          "example": "invalid_parameter"
        },
        "message": {
          "type": "string",
          "description": "Human-readable description of the error.",
          "example": "One or more request parameters are invalid."
        },
        "param": {
          "type": "string",
          "description": "Name of the request parameter or field that caused the error, when applicable.",
          "example": "page_number",
          "nullable": true
        },
        "doc_url": {
          "type": "string",
          "description": "Optional URL to documentation describing the error.",
          "example": "https://{APP_URL}/kernel/errors/invalid_parameter",
          "nullable": true
        }
      }
    }
  }
}

500 — An unexpected error occurred while processing the request.

Content type: application/json

Schema

Structured error envelope returned by external gateway endpoints (/v1/api/*). Wraps a single error object with type, code, human-readable message, the offending param (when applicable), and an optional documentation URL.

PropertyTypeRequiredDescription
errorobjectNo
{
  "type": "object",
  "description": "Structured error envelope returned by external gateway endpoints (`/v1/api/*`).\nWraps a single `error` object with `type`, `code`, human-readable `message`, the offending\n`param` (when applicable), and an optional documentation URL.\n",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "High-level error category (for example `unauthorized`, `invalid_parameter`, `validation_error`).",
          "example": "invalid_parameter"
        },
        "code": {
          "type": "string",
          "description": "Machine-readable error code; clients should branch on this rather than `message`.",
          "example": "invalid_parameter"
        },
        "message": {
          "type": "string",
          "description": "Human-readable description of the error.",
          "example": "One or more request parameters are invalid."
        },
        "param": {
          "type": "string",
          "description": "Name of the request parameter or field that caused the error, when applicable.",
          "example": "page_number",
          "nullable": true
        },
        "doc_url": {
          "type": "string",
          "description": "Optional URL to documentation describing the error.",
          "example": "https://{APP_URL}/kernel/errors/invalid_parameter",
          "nullable": true
        }
      }
    }
  }
}