---
title: "List resource descriptor fields"
method: GET
path: "/resource/descriptors/{resourceDescriptorId}/fields"
tags: ["ResourceDescriptors"]
---

# List resource descriptor fields

`GET /resource/descriptors/{resourceDescriptorId}/fields`

Lists fields declared for a resource descriptor. Fields carry path/column names, value
type hints, required/multi-valued semantics, semantic attribute references, sensitivity,
and optional retention metadata.

## Path parameters

- `resourceDescriptorId` string, uuid, required — Stable identifier for a described external or internal resource shape.

## Query parameters

- `page` integer
- `size` integer

## Response `200`

Paged field descriptors.

- FieldDescriptorPage — Page of field descriptors.
  - `data` FieldDescriptor[], required
    - `fieldPath` string, required — Path or column name within the resource representation.
    - `displayName` string — Human-readable field name.
    - `valueType` string, required — Logical value type, for example string, number, boolean, date, datetime, object, array, or binary.
    - `required` boolean — Whether the field is required for validation and mapping.
    - `multiValued` boolean — Whether the field can hold multiple values.
    - `semanticAttributeId` string, uuid — Optional semantic attribute binding used for validation, governance, and policy.
    - `sensitivity` string — Optional sensitivity or classification label used by governance and policy checks.
    - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads.
      - `purpose` string — Processing purpose.
      - `legalBasis` string — Legal or contractual basis for retention.
      - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y.
      - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy.
      - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.
    - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.
    - `fieldDescriptorId` string, uuid, required — Stable identifier for a field within a resource descriptor.
  - `pagination` Page, required — Pagination metadata emitted with each paged response under the `pagination` property.
    - `limit` integer, required — Maximum number of records requested for this page.
    - `offset` integer, required — Zero-based offset of the first record in this page.
    - `page` integer, required — Zero-based page index derived from offset and limit.
    - `size` integer, required — Effective page size.
    - `total` integer, required — Total number of matching records.
    - `totalPages` integer, required — Total number of available pages.
    - `hasMore` boolean, required — Whether another page is available after this page.

## Other responses

- `401` — Authentication is required.
- `404` — The requested resource was not found.

---

[API](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/connector-integration-profile-api/revisions/60cb8c70871b/schema)