> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/studio/integrations-and-apis/origin-studio-production-api/fields.md).

# Fields

Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields.

## Get fields

> Lists the tenant's fields: the shared system fields and the tenant's custom fields. Add \`include=dataset\` or \`include=dataset.items\` to embed each field's linked dataset.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FieldFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldFindManyResponse","description":"The metadata fields that match the filters, all in one response. With `include=dataset` or `include=dataset.items`, `included` holds the related datasets and optionally their items.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"next":{"type":["string","null"]}},"additionalProperties":false},"included":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Dataset"},{"$ref":"#/components/schemas/DatasetItem"}]}},"meta":{"type":"object","properties":{"cursor":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Field":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IField","description":"A metadata field that records in a tenant can carry. It has a display `label`, a unique `key`, a JSON Schema for its value, and a `dataset` relationship that constrains valid values.","allOf":[{"type":"object","required":["id","type","attributes","meta","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["fields"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/FieldAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","additionalProperties":false,"properties":{"tenant":{"type":"object","required":["data","links"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false}}},"dataset":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]},"meta":{"type":"object","required":["tenantId"],"properties":{"tenantId":{"type":"string"},"localized":{"type":"boolean"},"validKeys":{"type":"array","items":{"type":"string"},"description":"Valid item keys for a non-localized dataset, or the default keys for a localized one."},"validKeysByLocale":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Valid item keys per locale, for a localized dataset."}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"author":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"section":{"type":"object","additionalProperties":false,"description":"Where the field appears in the record layout. Present only when the request sets `filter.workType`.","properties":{"data":{"type":"object","required":["id","key","label"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}}}}}}}}}]},"FieldAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldAttributes","description":"Attributes of a metadata field.","type":"object","required":["label","dataSource","key","localized"],"additionalProperties":false,"properties":{"label":{"type":"string","description":"Display name the UI shows, such as `\"Release Year\"`, `\"Genre\"` or `\"Synopsis\"`."},"key":{"type":"string","description":"Stable machine-readable identifier for reading and writing record data, such as `\"release_year\"` or `\"genre\"`. You can't change it after creation."},"schema":{"type":"object","description":"JSON Schema fragment with the shape and validation rules for the field's value. The server generates it on create from `dataType`, `list`, `localized` and `dataValidation`. Read-only.","properties":{"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"field":{"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"required":["type"]}}}},"additionalProperties":false},"dataSource":{"type":"string","description":"Who owns the field.\n- `fabric`: system-provisioned and shared across all tenants. Read-only; you can't delete it.\n- `custom`: tenant-created. You can modify or delete it."},"localized":{"type":"boolean","description":"When `true`, the field stores one value per locale, such as an English and a French synopsis. When `false`, it stores one value for all locales. Only `string` and `dataset` fields support localization."},"supportsInheritance":{"type":"boolean","description":"When `true`, a record can inherit this field's value from its parent, such as a Season from its Series."},"supportsKeywordSearch":{"type":"boolean","description":"When `true`, search supports `starts_with` on this text field as a whole-value, case-sensitive prefix match. Typical for identifier fields such as Origin Nexus ID or EIDR ID. `eq` and `ne` always compare whole values case-sensitively on text fields, whatever this flag says."},"list":{"type":"boolean","description":"When `true`, the field stores an array of values; when `false`, a single value. A `genre` field is typically a list; `release_year` is not."},"uiComponent":{"type":"string","description":"Input component the UI renders for the field. Common values: `TextInput`, `TextArea`, `NumberInput`, `ToggleSwitch`, `Date`, `DateTime`, `Time`, `Select`, `MultiSelect`, `Autocomplete`, `AutocompleteSelect`, `AutocompleteMultiSelect`, `DataGrid`, `Custom`."},"uiSpan":{"type":"number","description":"Horizontal space the UI gives the field in forms."},"propertiesAttributes":{"type":"object","description":"Open map of extra display or configuration hints for the UI. The API doesn't validate it.","additionalProperties":true}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"Dataset":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataset","description":"A dataset: a controlled vocabulary or lookup list that constrains field values. A localized dataset keys its items by locale.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"allowCustomItems":{"type":"boolean","description":"Whether users can add, update or delete items. When `false`, the dataset is locked: users can't change items, and only Fabric manages them."}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false},"items":{"type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false}},"required":["tenant"],"additionalProperties":false}},"required":["attributes","meta"],"additionalProperties":false}]},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"DatasetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetAttributes","description":"Attributes of a dataset.","type":"object","additionalProperties":false,"properties":{"dataSource":{"type":"string","description":"Who owns the dataset.\n- `fabric`: system-provisioned.\n- `custom`: tenant-created.","enum":["fabric","custom"]},"label":{"type":"string","description":"Display name."},"localized":{"type":"boolean","description":"When `true`, the dataset keys its items by locale."},"availableLocales":{"type":"array","description":"Locales a localized dataset supports.","items":{"type":"string"}},"key":{"type":"string","description":"Machine-readable identifier."},"tenantId":{"type":"string","description":"Tenant that owns the dataset."},"allowCustomItems":{"type":"boolean","description":"Whether tenants can add, update or delete items. When `false`, the dataset is locked and accepts no item changes."}},"required":["dataSource","label","key"]},"DatasetItem":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItem","description":"One entry in a dataset: a `key`, a display `value`, and a `locale` in localized datasets.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetItemAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"relationships":{"type":"object","properties":{"dataset":{"$ref":"#/components/schemas/DatasetRelationship"},"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false}},"required":["attributes","relationships"],"additionalProperties":false}]},"DatasetItemAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItemAttributes","description":"Attributes of one dataset item.","type":"object","additionalProperties":false,"properties":{"locale":{"type":"string","description":"Language and region the item belongs to, in a localized dataset."},"dataSource":{"type":"string","description":"Who created the item: Fabric or the tenant."},"key":{"type":"string","description":"Stable machine-readable identifier. Records store this key."},"value":{"type":"string","description":"Display label the UI shows."}},"required":["key","value"]},"DatasetRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetRelationship","description":"Links a resource to a dataset. `links.related` fetches the full dataset.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"TenantRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationship","description":"A relationship to a tenant","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/fields":{"get":{"summary":"Get fields","operationId":"fieldFindMany","description":"Lists the tenant's fields: the shared system fields and the tenant's custom fields. Add `include=dataset` or `include=dataset.items` to embed each field's linked dataset.","tags":["Fields"],"parameters":[{"name":"filter.key","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"One or more field keys, comma-separated."},{"name":"filter.dataSource","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"Only fields from this data source."},{"name":"filter.workType","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"Only fields in this work type's record layout. Each field then carries a `section` relationship naming its layout section."},{"name":"filter.id","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"One or more field IDs, comma-separated."},{"name":"filter.label","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"Only fields whose label contains this text, ignoring case."},{"name":"include","description":"Related resources to embed, comma-separated.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string","enum":["dataset","dataset.items","dataset,dataset.items"]}},{"name":"tenantId","description":"The tenant whose fields to list. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldFindManyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Create a field

> Creates a custom field for the current tenant. A tenant can have up to 250 custom fields.\
> \- \`key\` must be unique in the tenant, and you can't change it later.\
> \- Answers 400 when \`key\` matches a system field (\`dataSource: fabric\`); system fields reserve those keys.\
> \- Link a \`dataset\` relationship to limit values to that dataset's items.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FieldCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldCreateOneRequest","description":"Creates a metadata field in a tenant. Link a dataset through `relationships.dataset` to limit values to its items.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"type":"object","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["fields"]}}},{"type":"object","required":["attributes","relationships"],"additionalProperties":false,"properties":{"attributes":{"required":["label","key","dataType"],"type":"object","additionalProperties":false,"properties":{"label":{"type":"string","description":"Display name the UI shows, such as `\"Release Year\"` or `\"Genre\"`."},"key":{"type":"string","description":"Stable machine-readable identifier for reading and writing record data, such as `\"release_year\"` or `\"custom_genre\"`. Must be unique in the tenant and can't match the key of one of the tenant's system fields (`dataSource: fabric`). You can't change it after creation."},"localized":{"type":"boolean","description":"When `true`, the field stores one value per locale; when `false` (default), one value for all locales. Only `string` and `dataset` fields support it: `true` with a `dataType` of `number` or `boolean` answers 400. You can't change it after creation."},"supportsInheritance":{"type":"boolean","nullable":true,"description":"When `true`, a record can inherit this field's value from its parent, such as a Season from its Series. Defaults to `false`."},"uiComponent":{"type":"string","description":"Input component the UI renders. Common values: `TextInput`, `TextArea`, `NumberInput`, `ToggleSwitch`, `Date`, `DateTime`, `Select`, `Autocomplete`, `AutocompleteMultiSelect`."},"list":{"type":"boolean","description":"When `true`, the field accepts an array of values; when `false` (default), a single value. `genre` is a list; `release_year` is not."},"dataSource":{"type":"string","description":"Who owns the field. Defaults to `custom`. Use `fabric` only to provision system fields."},"dataType":{"type":"string","enum":["string","number","boolean","dataset"],"default":"string","description":"Type of the field's value.\n- `string`: text.\n- `number`: a number.\n- `boolean`: true or false.\n- `dataset`: a value from a dataset (controlled vocabulary)."},"dataValidation":{"type":"object","description":"Optional constraints the server checks when you save a record. They depend on `dataType`:\n- string: `minLength`, `maxLength`, `pattern`, `format`.\n- number: `minimum`, `maximum`.\n- list: `minItems`, `maxItems`. On a string list, `maxLength` bounds each entry, not the whole list.","properties":{"minLength":{"type":"number","nullable":true,"description":"Minimum characters for string fields. Can't exceed the field's maximum length: 255 for single line text, 6144 for a text area, 100 per entry for a text list. On a localized field, the limit applies per locale."},"maxLength":{"type":"number","nullable":true,"description":"Maximum characters for string fields: at most 255 for single line text, 6144 for a text area and 100 per entry for a text list. A higher value answers 400. Without it, the cap still applies. On a localized field, the limit applies per locale."},"minimum":{"type":"number","nullable":true,"description":"Minimum numeric value for number fields."},"maximum":{"type":"number","nullable":true,"description":"Maximum numeric value for number fields."},"pattern":{"type":"string","nullable":true,"description":"Regular expression pattern the string value must match."},"format":{"type":"string","nullable":true,"description":"Named format the string value must match, such as `date`, `date-time` or `uri`."},"minItems":{"type":"number","nullable":true,"description":"Minimum items for list fields (`list: true`). Can't exceed the field's maximum entry count: 100 for a text list, 50 for a dataset-backed list. On a localized field, the limit applies per locale."},"maxItems":{"type":"number","nullable":true,"description":"Maximum items for list fields (`list: true`): at most 100 for a text list and 50 for a dataset-backed list. A higher value answers 400. Without it, the cap still applies. On a localized field, the limit applies per locale."}},"additionalProperties":false}}},"relationships":{"type":"object","properties":{"dataset":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"additionalProperties":false}}}]}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"BaseCreateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseCreateRequest","description":"Base shape for create requests. `type` must match the target resource type. Omit `id` to let the server generate one.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["type"]},"FieldFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldFindOneResponse","description":"One metadata field. With `include=dataset` or `include=dataset.items`, `included` holds its dataset and optionally the dataset's items.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/Field"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"included":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Dataset"},{"$ref":"#/components/schemas/DatasetItem"}]}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Field":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IField","description":"A metadata field that records in a tenant can carry. It has a display `label`, a unique `key`, a JSON Schema for its value, and a `dataset` relationship that constrains valid values.","allOf":[{"type":"object","required":["id","type","attributes","meta","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["fields"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/FieldAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","additionalProperties":false,"properties":{"tenant":{"type":"object","required":["data","links"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false}}},"dataset":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]},"meta":{"type":"object","required":["tenantId"],"properties":{"tenantId":{"type":"string"},"localized":{"type":"boolean"},"validKeys":{"type":"array","items":{"type":"string"},"description":"Valid item keys for a non-localized dataset, or the default keys for a localized one."},"validKeysByLocale":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Valid item keys per locale, for a localized dataset."}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"author":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"section":{"type":"object","additionalProperties":false,"description":"Where the field appears in the record layout. Present only when the request sets `filter.workType`.","properties":{"data":{"type":"object","required":["id","key","label"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}}}}}}}}}]},"FieldAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldAttributes","description":"Attributes of a metadata field.","type":"object","required":["label","dataSource","key","localized"],"additionalProperties":false,"properties":{"label":{"type":"string","description":"Display name the UI shows, such as `\"Release Year\"`, `\"Genre\"` or `\"Synopsis\"`."},"key":{"type":"string","description":"Stable machine-readable identifier for reading and writing record data, such as `\"release_year\"` or `\"genre\"`. You can't change it after creation."},"schema":{"type":"object","description":"JSON Schema fragment with the shape and validation rules for the field's value. The server generates it on create from `dataType`, `list`, `localized` and `dataValidation`. Read-only.","properties":{"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"field":{"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"required":["type"]}}}},"additionalProperties":false},"dataSource":{"type":"string","description":"Who owns the field.\n- `fabric`: system-provisioned and shared across all tenants. Read-only; you can't delete it.\n- `custom`: tenant-created. You can modify or delete it."},"localized":{"type":"boolean","description":"When `true`, the field stores one value per locale, such as an English and a French synopsis. When `false`, it stores one value for all locales. Only `string` and `dataset` fields support localization."},"supportsInheritance":{"type":"boolean","description":"When `true`, a record can inherit this field's value from its parent, such as a Season from its Series."},"supportsKeywordSearch":{"type":"boolean","description":"When `true`, search supports `starts_with` on this text field as a whole-value, case-sensitive prefix match. Typical for identifier fields such as Origin Nexus ID or EIDR ID. `eq` and `ne` always compare whole values case-sensitively on text fields, whatever this flag says."},"list":{"type":"boolean","description":"When `true`, the field stores an array of values; when `false`, a single value. A `genre` field is typically a list; `release_year` is not."},"uiComponent":{"type":"string","description":"Input component the UI renders for the field. Common values: `TextInput`, `TextArea`, `NumberInput`, `ToggleSwitch`, `Date`, `DateTime`, `Time`, `Select`, `MultiSelect`, `Autocomplete`, `AutocompleteSelect`, `AutocompleteMultiSelect`, `DataGrid`, `Custom`."},"uiSpan":{"type":"number","description":"Horizontal space the UI gives the field in forms."},"propertiesAttributes":{"type":"object","description":"Open map of extra display or configuration hints for the UI. The API doesn't validate it.","additionalProperties":true}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"Dataset":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataset","description":"A dataset: a controlled vocabulary or lookup list that constrains field values. A localized dataset keys its items by locale.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"allowCustomItems":{"type":"boolean","description":"Whether users can add, update or delete items. When `false`, the dataset is locked: users can't change items, and only Fabric manages them."}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false},"items":{"type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false}},"required":["tenant"],"additionalProperties":false}},"required":["attributes","meta"],"additionalProperties":false}]},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"DatasetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetAttributes","description":"Attributes of a dataset.","type":"object","additionalProperties":false,"properties":{"dataSource":{"type":"string","description":"Who owns the dataset.\n- `fabric`: system-provisioned.\n- `custom`: tenant-created.","enum":["fabric","custom"]},"label":{"type":"string","description":"Display name."},"localized":{"type":"boolean","description":"When `true`, the dataset keys its items by locale."},"availableLocales":{"type":"array","description":"Locales a localized dataset supports.","items":{"type":"string"}},"key":{"type":"string","description":"Machine-readable identifier."},"tenantId":{"type":"string","description":"Tenant that owns the dataset."},"allowCustomItems":{"type":"boolean","description":"Whether tenants can add, update or delete items. When `false`, the dataset is locked and accepts no item changes."}},"required":["dataSource","label","key"]},"DatasetItem":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItem","description":"One entry in a dataset: a `key`, a display `value`, and a `locale` in localized datasets.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetItemAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"relationships":{"type":"object","properties":{"dataset":{"$ref":"#/components/schemas/DatasetRelationship"},"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false}},"required":["attributes","relationships"],"additionalProperties":false}]},"DatasetItemAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItemAttributes","description":"Attributes of one dataset item.","type":"object","additionalProperties":false,"properties":{"locale":{"type":"string","description":"Language and region the item belongs to, in a localized dataset."},"dataSource":{"type":"string","description":"Who created the item: Fabric or the tenant."},"key":{"type":"string","description":"Stable machine-readable identifier. Records store this key."},"value":{"type":"string","description":"Display label the UI shows."}},"required":["key","value"]},"DatasetRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetRelationship","description":"Links a resource to a dataset. `links.related` fetches the full dataset.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"TenantRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationship","description":"A relationship to a tenant","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/fields":{"post":{"summary":"Create a field","operationId":"fieldCreateOne","description":"Creates a custom field for the current tenant. A tenant can have up to 250 custom fields.\n- `key` must be unique in the tenant, and you can't change it later.\n- Answers 400 when `key` matches a system field (`dataSource: fabric`); system fields reserve those keys.\n- Link a `dataset` relationship to limit values to that dataset's items.","tags":["Fields"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldCreateOneRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get a field by ID

> Returns one field. Add \`include=dataset\` or \`include=dataset.items\` to embed the linked dataset or its items.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FieldFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldFindOneResponse","description":"One metadata field. With `include=dataset` or `include=dataset.items`, `included` holds its dataset and optionally the dataset's items.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/Field"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"included":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Dataset"},{"$ref":"#/components/schemas/DatasetItem"}]}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Field":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IField","description":"A metadata field that records in a tenant can carry. It has a display `label`, a unique `key`, a JSON Schema for its value, and a `dataset` relationship that constrains valid values.","allOf":[{"type":"object","required":["id","type","attributes","meta","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["fields"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/FieldAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","additionalProperties":false,"properties":{"tenant":{"type":"object","required":["data","links"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false}}},"dataset":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]},"meta":{"type":"object","required":["tenantId"],"properties":{"tenantId":{"type":"string"},"localized":{"type":"boolean"},"validKeys":{"type":"array","items":{"type":"string"},"description":"Valid item keys for a non-localized dataset, or the default keys for a localized one."},"validKeysByLocale":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Valid item keys per locale, for a localized dataset."}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"author":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"section":{"type":"object","additionalProperties":false,"description":"Where the field appears in the record layout. Present only when the request sets `filter.workType`.","properties":{"data":{"type":"object","required":["id","key","label"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}}}}}}}}}]},"FieldAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldAttributes","description":"Attributes of a metadata field.","type":"object","required":["label","dataSource","key","localized"],"additionalProperties":false,"properties":{"label":{"type":"string","description":"Display name the UI shows, such as `\"Release Year\"`, `\"Genre\"` or `\"Synopsis\"`."},"key":{"type":"string","description":"Stable machine-readable identifier for reading and writing record data, such as `\"release_year\"` or `\"genre\"`. You can't change it after creation."},"schema":{"type":"object","description":"JSON Schema fragment with the shape and validation rules for the field's value. The server generates it on create from `dataType`, `list`, `localized` and `dataValidation`. Read-only.","properties":{"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"field":{"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"required":["type"]}}}},"additionalProperties":false},"dataSource":{"type":"string","description":"Who owns the field.\n- `fabric`: system-provisioned and shared across all tenants. Read-only; you can't delete it.\n- `custom`: tenant-created. You can modify or delete it."},"localized":{"type":"boolean","description":"When `true`, the field stores one value per locale, such as an English and a French synopsis. When `false`, it stores one value for all locales. Only `string` and `dataset` fields support localization."},"supportsInheritance":{"type":"boolean","description":"When `true`, a record can inherit this field's value from its parent, such as a Season from its Series."},"supportsKeywordSearch":{"type":"boolean","description":"When `true`, search supports `starts_with` on this text field as a whole-value, case-sensitive prefix match. Typical for identifier fields such as Origin Nexus ID or EIDR ID. `eq` and `ne` always compare whole values case-sensitively on text fields, whatever this flag says."},"list":{"type":"boolean","description":"When `true`, the field stores an array of values; when `false`, a single value. A `genre` field is typically a list; `release_year` is not."},"uiComponent":{"type":"string","description":"Input component the UI renders for the field. Common values: `TextInput`, `TextArea`, `NumberInput`, `ToggleSwitch`, `Date`, `DateTime`, `Time`, `Select`, `MultiSelect`, `Autocomplete`, `AutocompleteSelect`, `AutocompleteMultiSelect`, `DataGrid`, `Custom`."},"uiSpan":{"type":"number","description":"Horizontal space the UI gives the field in forms."},"propertiesAttributes":{"type":"object","description":"Open map of extra display or configuration hints for the UI. The API doesn't validate it.","additionalProperties":true}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"Dataset":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataset","description":"A dataset: a controlled vocabulary or lookup list that constrains field values. A localized dataset keys its items by locale.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"allowCustomItems":{"type":"boolean","description":"Whether users can add, update or delete items. When `false`, the dataset is locked: users can't change items, and only Fabric manages them."}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false},"items":{"type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false}},"required":["tenant"],"additionalProperties":false}},"required":["attributes","meta"],"additionalProperties":false}]},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"DatasetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetAttributes","description":"Attributes of a dataset.","type":"object","additionalProperties":false,"properties":{"dataSource":{"type":"string","description":"Who owns the dataset.\n- `fabric`: system-provisioned.\n- `custom`: tenant-created.","enum":["fabric","custom"]},"label":{"type":"string","description":"Display name."},"localized":{"type":"boolean","description":"When `true`, the dataset keys its items by locale."},"availableLocales":{"type":"array","description":"Locales a localized dataset supports.","items":{"type":"string"}},"key":{"type":"string","description":"Machine-readable identifier."},"tenantId":{"type":"string","description":"Tenant that owns the dataset."},"allowCustomItems":{"type":"boolean","description":"Whether tenants can add, update or delete items. When `false`, the dataset is locked and accepts no item changes."}},"required":["dataSource","label","key"]},"DatasetItem":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItem","description":"One entry in a dataset: a `key`, a display `value`, and a `locale` in localized datasets.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetItemAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"relationships":{"type":"object","properties":{"dataset":{"$ref":"#/components/schemas/DatasetRelationship"},"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false}},"required":["attributes","relationships"],"additionalProperties":false}]},"DatasetItemAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItemAttributes","description":"Attributes of one dataset item.","type":"object","additionalProperties":false,"properties":{"locale":{"type":"string","description":"Language and region the item belongs to, in a localized dataset."},"dataSource":{"type":"string","description":"Who created the item: Fabric or the tenant."},"key":{"type":"string","description":"Stable machine-readable identifier. Records store this key."},"value":{"type":"string","description":"Display label the UI shows."}},"required":["key","value"]},"DatasetRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetRelationship","description":"Links a resource to a dataset. `links.related` fetches the full dataset.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"TenantRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationship","description":"A relationship to a tenant","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/fields/{fieldId}":{"get":{"summary":"Get a field by ID","operationId":"fieldFindOne","description":"Returns one field. Add `include=dataset` or `include=dataset.items` to embed the linked dataset or its items.","tags":["Fields"],"parameters":[{"name":"fieldId","description":"The field to return.","in":"path","required":true,"schema":{"type":"string"}},{"name":"include","description":"Related resources to embed, comma-separated.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string","enum":["dataset","dataset.items","dataset,dataset.items"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Delete field

> Deletes a custom field. You can't delete system fields (\`dataSource: fabric\`).

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"WriteMetaOnlyRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteMetaOnlyRequest","description":"An optional body with only audit metadata, for mutations that take no other body, such as deletes. Use it to send `meta.audit.source` and `meta.audit.reason`.","type":"object","additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}},"paths":{"/fields/{fieldId}":{"delete":{"summary":"Delete field","operationId":"fieldDeleteOne","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteMetaOnlyRequest"}}}},"description":"Deletes a custom field. You can't delete system fields (`dataSource: fabric`).","tags":["Fields"],"parameters":[{"name":"fieldId","description":"The field to delete.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Update a field

> Updates only the attributes you send, such as \`label\`, \`supportsInheritance\` and \`dataValidation\`. You can't change \`key\`, \`dataType\`, \`localized\` or \`list\` after creation.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"FieldUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldUpdateOneRequest","description":"Updates a metadata field. Changes only the attributes you send. `data.id` must match the `fieldId` path parameter.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["fields"]}}},{"required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"type":"object","additionalProperties":false,"properties":{"dataValidation":{"type":"object","description":"Validation constraints for the field's value. Changes only the properties you send; set one to `null` to remove that constraint.","properties":{"minLength":{"type":"number","nullable":true,"description":"Minimum characters for string fields. Can't exceed the field's maximum length: 255 for a single line text field, 6144 for a text area, 100 per entry for a text list. On a localized field, the limit applies per locale."},"maxLength":{"type":"number","nullable":true,"description":"Maximum characters for string fields. The cap is 255 for a single line text field, 6144 for a text area and 100 per entry for a text list; a higher value answers 400. Without it, the cap still applies. On a localized field, the limit applies per locale."},"minimum":{"type":"number","nullable":true,"description":"Minimum value for number fields."},"maximum":{"type":"number","nullable":true,"description":"Maximum value for number fields."},"pattern":{"type":"string","nullable":true,"description":"Regular expression the string value must match."},"format":{"type":"string","nullable":true,"description":"Named format the string value must match, such as `date`, `date-time` or `uri`."},"minItems":{"type":"number","nullable":true,"description":"Minimum items for list fields. Can't exceed the field's maximum entry count: 100 for a text list, 50 for a dataset backed list. On a localized field, the limit applies per locale."},"maxItems":{"type":"number","nullable":true,"description":"Maximum items for list fields. The cap is 100 for a text list and 50 for a dataset backed list; a higher value answers 400. Without it, the cap still applies. On a localized field, the limit applies per locale."}},"additionalProperties":false},"label":{"type":"string","description":"New display name for the field."},"supportsInheritance":{"type":"boolean","nullable":true,"description":"When `true`, a record can inherit this field's value from its parent record."}}},"relationships":{"type":"object","properties":{"dataset":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"additionalProperties":false}}}]}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"FieldFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldFindOneResponse","description":"One metadata field. With `include=dataset` or `include=dataset.items`, `included` holds its dataset and optionally the dataset's items.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/Field"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"included":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Dataset"},{"$ref":"#/components/schemas/DatasetItem"}]}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Field":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IField","description":"A metadata field that records in a tenant can carry. It has a display `label`, a unique `key`, a JSON Schema for its value, and a `dataset` relationship that constrains valid values.","allOf":[{"type":"object","required":["id","type","attributes","meta","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["fields"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/FieldAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","additionalProperties":false,"properties":{"tenant":{"type":"object","required":["data","links"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false}}},"dataset":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]},"meta":{"type":"object","required":["tenantId"],"properties":{"tenantId":{"type":"string"},"localized":{"type":"boolean"},"validKeys":{"type":"array","items":{"type":"string"},"description":"Valid item keys for a non-localized dataset, or the default keys for a localized one."},"validKeysByLocale":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Valid item keys per locale, for a localized dataset."}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"author":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"additionalProperties":false}}},"section":{"type":"object","additionalProperties":false,"description":"Where the field appears in the record layout. Present only when the request sets `filter.workType`.","properties":{"data":{"type":"object","required":["id","key","label"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"}}}}}}}}}]},"FieldAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IFieldAttributes","description":"Attributes of a metadata field.","type":"object","required":["label","dataSource","key","localized"],"additionalProperties":false,"properties":{"label":{"type":"string","description":"Display name the UI shows, such as `\"Release Year\"`, `\"Genre\"` or `\"Synopsis\"`."},"key":{"type":"string","description":"Stable machine-readable identifier for reading and writing record data, such as `\"release_year\"` or `\"genre\"`. You can't change it after creation."},"schema":{"type":"object","description":"JSON Schema fragment with the shape and validation rules for the field's value. The server generates it on create from `dataType`, `list`, `localized` and `dataValidation`. Read-only.","properties":{"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"field":{"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"required":["type"]}}}},"additionalProperties":false},"dataSource":{"type":"string","description":"Who owns the field.\n- `fabric`: system-provisioned and shared across all tenants. Read-only; you can't delete it.\n- `custom`: tenant-created. You can modify or delete it."},"localized":{"type":"boolean","description":"When `true`, the field stores one value per locale, such as an English and a French synopsis. When `false`, it stores one value for all locales. Only `string` and `dataset` fields support localization."},"supportsInheritance":{"type":"boolean","description":"When `true`, a record can inherit this field's value from its parent, such as a Season from its Series."},"supportsKeywordSearch":{"type":"boolean","description":"When `true`, search supports `starts_with` on this text field as a whole-value, case-sensitive prefix match. Typical for identifier fields such as Origin Nexus ID or EIDR ID. `eq` and `ne` always compare whole values case-sensitively on text fields, whatever this flag says."},"list":{"type":"boolean","description":"When `true`, the field stores an array of values; when `false`, a single value. A `genre` field is typically a list; `release_year` is not."},"uiComponent":{"type":"string","description":"Input component the UI renders for the field. Common values: `TextInput`, `TextArea`, `NumberInput`, `ToggleSwitch`, `Date`, `DateTime`, `Time`, `Select`, `MultiSelect`, `Autocomplete`, `AutocompleteSelect`, `AutocompleteMultiSelect`, `DataGrid`, `Custom`."},"uiSpan":{"type":"number","description":"Horizontal space the UI gives the field in forms."},"propertiesAttributes":{"type":"object","description":"Open map of extra display or configuration hints for the UI. The API doesn't validate it.","additionalProperties":true}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"Dataset":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataset","description":"A dataset: a controlled vocabulary or lookup list that constrains field values. A localized dataset keys its items by locale.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"allowCustomItems":{"type":"boolean","description":"Whether users can add, update or delete items. When `false`, the dataset is locked: users can't change items, and only Fabric manages them."}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false},"items":{"type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}},"required":["related"],"additionalProperties":false}},"additionalProperties":false}},"required":["tenant"],"additionalProperties":false}},"required":["attributes","meta"],"additionalProperties":false}]},"DatasetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetAttributes","description":"Attributes of a dataset.","type":"object","additionalProperties":false,"properties":{"dataSource":{"type":"string","description":"Who owns the dataset.\n- `fabric`: system-provisioned.\n- `custom`: tenant-created.","enum":["fabric","custom"]},"label":{"type":"string","description":"Display name."},"localized":{"type":"boolean","description":"When `true`, the dataset keys its items by locale."},"availableLocales":{"type":"array","description":"Locales a localized dataset supports.","items":{"type":"string"}},"key":{"type":"string","description":"Machine-readable identifier."},"tenantId":{"type":"string","description":"Tenant that owns the dataset."},"allowCustomItems":{"type":"boolean","description":"Whether tenants can add, update or delete items. When `false`, the dataset is locked and accepts no item changes."}},"required":["dataSource","label","key"]},"DatasetItem":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItem","description":"One entry in a dataset: a `key`, a display `value`, and a `locale` in localized datasets.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/DatasetItemAttributes"},{"$ref":"#/components/schemas/BaseResourceAttributes"}],"additionalProperties":false},"relationships":{"type":"object","properties":{"dataset":{"$ref":"#/components/schemas/DatasetRelationship"},"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false}},"required":["attributes","relationships"],"additionalProperties":false}]},"DatasetItemAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetItemAttributes","description":"Attributes of one dataset item.","type":"object","additionalProperties":false,"properties":{"locale":{"type":"string","description":"Language and region the item belongs to, in a localized dataset."},"dataSource":{"type":"string","description":"Who created the item: Fabric or the tenant."},"key":{"type":"string","description":"Stable machine-readable identifier. Records store this key."},"value":{"type":"string","description":"Display label the UI shows."}},"required":["key","value"]},"DatasetRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetRelationship","description":"Links a resource to a dataset. `links.related` fetches the full dataset.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["datasets"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"TenantRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationship","description":"A relationship to a tenant","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/fields/{fieldId}":{"patch":{"summary":"Update a field","operationId":"fieldUpdateOne","description":"Updates only the attributes you send, such as `label`, `supportsInheritance` and `dataValidation`. You can't change `key`, `dataType`, `localized` or `list` after creation.","tags":["Fields"],"parameters":[{"name":"fieldId","description":"The field to update.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldUpdateOneRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get record layouts

> Lists the tenant's record layouts. Each layout sets the groups, sections and field order of the editing screen for one work type.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RecordLayoutFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutFindManyResponse","description":"The tenant's record layouts, paginated. Each item in `data` is a full layout with its attributes (`name`, `workType`, `groups`), tenant relationship and meta.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","relationships","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recordLayouts"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLayoutAttributes"}]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"]},"links":{"$ref":"#/components/schemas/LinksRelated"}}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RecordLayoutAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutAttributes","description":"Attributes of a record layout. `workType` sets the work type the layout applies to.","type":"object","required":["name","workType","groups"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name of the layout, such as `\"Movie Layout\"` or `\"Series Default Layout\"`."},"description":{"type":"string","description":"Longer description of the layout and its purpose."},"workType":{"$ref":"#/components/schemas/WorkTypes"},"groups":{"type":"array","description":"Ordered groups of the layout. Each group is a tab or major panel in the record editor and holds sections, which hold fields.","items":{"$ref":"#/components/schemas/RecordLayoutGroup"}}}},"WorkTypes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkTypes","description":"The key of one of the tenant's work types. Every tenant has seven built-in work types:\n- `Movie`: a standalone feature-length film\n- `MovieEdit`: a variation of a Movie\n- `Series`: a TV or streaming series\n- `Season`: a season within a Series\n- `Episode`: a single episode\n- `EpisodeEdit`: a variation of an Episode\n- `Compilation`: an editorially curated collection of existing records\n\nTenants can also define custom work types; list them with `GET /workTypes`.","type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$"},"RecordLayoutGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutGroup","description":"A top-level group of sections in a record layout, usually a tab or major panel in the record editor.","type":"object","required":["key","label","type","sections"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Group id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the group, unique within the layout, such as `\"origination\"` or `\"technical_details\"`."},"label":{"type":"string","description":"Tab or panel heading in the editor, such as `\"Origination\"` or `\"Technical Details\"`."},"type":{"type":"string","enum":["fieldGroup","entityCollection"],"description":"Role of the group in the layout.\n- `fieldGroup`: editable metadata fields, arranged in sections.\n- `entityCollection`: reserved for linked entities such as contributors or credits; can't hold custom sections."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the group. Applies only to `fieldGroup` groups; you can't set it on `entityCollection` groups. You can't hide the required origination group."},"sections":{"type":"array","description":"Ordered sections of the group, each with an ordered list of fields. `entityCollection` groups must have an empty `sections` array.","items":{"$ref":"#/components/schemas/RecordLayoutSection"}}}},"RecordLayoutSection":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutSection","description":"A section of a record layout group: a labeled set of fields within the group's tab or panel in the editor.","type":"object","required":["key","label","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Section id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the section, unique within its group, such as `\"core_metadata\"` or `\"identifiers\"`."},"label":{"type":"string","description":"Section heading in the editor, such as `\"Core Metadata\"` or `\"Identifiers\"`."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the section and all its fields. You can't hide the system-required `core_metadata` section."},"fields":{"type":"array","description":"Ordered field references, each by `id` and `key`. The order sets the display order in the editor.","items":{"$ref":"#/components/schemas/RecordLayoutField"}}}},"RecordLayoutField":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutField","description":"Places a field, by `id` and `key`, at a position in a layout section. The section's `fields` array lets you group several sub-fields under one layout position.","type":"object","required":["id","key","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The field to place here. Must be an existing field in the tenant."},"key":{"type":"string","description":"Key of the field to place here, such as `\"synopsis\"` or `\"release_year\"`."}}},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/recordLayouts":{"get":{"summary":"Get record layouts","operationId":"recordLayoutFindMany","description":"Lists the tenant's record layouts. Each layout sets the groups, sections and field order of the editing screen for one work type.","tags":["Fields"],"parameters":[{"name":"tenantId","description":"The tenant whose record layouts to list. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}},{"name":"filter.workType","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"},"description":"Only the layout for this work type, such as `Movie` or `Series`."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutFindManyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Create a record layout

> Creates a record layout for one work type: an ordered hierarchy of groups, sections and field references.\
> \- \`workType\`: one of the tenant's work types (\`GET /workTypes\`).\
> \- Send \`name\` and the \`groups\` hierarchy.\
> \- Every referenced field ID must belong to the tenant.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RecordLayoutCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutCreateOneRequest","description":"Creates a record layout. `data.attributes` must include `name`, `workType` and the `groups` hierarchy.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recordLayouts"]},"attributes":{"$ref":"#/components/schemas/RecordLayoutAttributes"}}}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"RecordLayoutAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutAttributes","description":"Attributes of a record layout. `workType` sets the work type the layout applies to.","type":"object","required":["name","workType","groups"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name of the layout, such as `\"Movie Layout\"` or `\"Series Default Layout\"`."},"description":{"type":"string","description":"Longer description of the layout and its purpose."},"workType":{"$ref":"#/components/schemas/WorkTypes"},"groups":{"type":"array","description":"Ordered groups of the layout. Each group is a tab or major panel in the record editor and holds sections, which hold fields.","items":{"$ref":"#/components/schemas/RecordLayoutGroup"}}}},"WorkTypes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkTypes","description":"The key of one of the tenant's work types. Every tenant has seven built-in work types:\n- `Movie`: a standalone feature-length film\n- `MovieEdit`: a variation of a Movie\n- `Series`: a TV or streaming series\n- `Season`: a season within a Series\n- `Episode`: a single episode\n- `EpisodeEdit`: a variation of an Episode\n- `Compilation`: an editorially curated collection of existing records\n\nTenants can also define custom work types; list them with `GET /workTypes`.","type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$"},"RecordLayoutGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutGroup","description":"A top-level group of sections in a record layout, usually a tab or major panel in the record editor.","type":"object","required":["key","label","type","sections"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Group id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the group, unique within the layout, such as `\"origination\"` or `\"technical_details\"`."},"label":{"type":"string","description":"Tab or panel heading in the editor, such as `\"Origination\"` or `\"Technical Details\"`."},"type":{"type":"string","enum":["fieldGroup","entityCollection"],"description":"Role of the group in the layout.\n- `fieldGroup`: editable metadata fields, arranged in sections.\n- `entityCollection`: reserved for linked entities such as contributors or credits; can't hold custom sections."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the group. Applies only to `fieldGroup` groups; you can't set it on `entityCollection` groups. You can't hide the required origination group."},"sections":{"type":"array","description":"Ordered sections of the group, each with an ordered list of fields. `entityCollection` groups must have an empty `sections` array.","items":{"$ref":"#/components/schemas/RecordLayoutSection"}}}},"RecordLayoutSection":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutSection","description":"A section of a record layout group: a labeled set of fields within the group's tab or panel in the editor.","type":"object","required":["key","label","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Section id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the section, unique within its group, such as `\"core_metadata\"` or `\"identifiers\"`."},"label":{"type":"string","description":"Section heading in the editor, such as `\"Core Metadata\"` or `\"Identifiers\"`."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the section and all its fields. You can't hide the system-required `core_metadata` section."},"fields":{"type":"array","description":"Ordered field references, each by `id` and `key`. The order sets the display order in the editor.","items":{"$ref":"#/components/schemas/RecordLayoutField"}}}},"RecordLayoutField":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutField","description":"Places a field, by `id` and `key`, at a position in a layout section. The section's `fields` array lets you group several sub-fields under one layout position.","type":"object","required":["id","key","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The field to place here. Must be an existing field in the tenant."},"key":{"type":"string","description":"Key of the field to place here, such as `\"synopsis\"` or `\"release_year\"`."}}},"RecordLayoutFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutFindOneResponse","description":"One record layout, with `name`, `workType` and the `groups` hierarchy of groups, sections and field references that shapes the editor for its work type.","type":"object","additionalProperties":false,"required":["data","links","meta","jsonapi"],"properties":{"meta":{"$ref":"#/components/schemas/RecordLayoutMeta"},"data":{"type":"object","required":["id","type","attributes","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recordLayouts"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLayoutAttributes"}]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"]}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordLayoutMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutMeta","description":"Version of the record layout in this response.","type":"object","additionalProperties":false,"required":["writeToken"],"properties":{"writeToken":{"type":"string","description":"Opaque value that changes on every write."}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/recordLayouts":{"post":{"summary":"Create a record layout","operationId":"recordLayoutCreateOne","description":"Creates a record layout for one work type: an ordered hierarchy of groups, sections and field references.\n- `workType`: one of the tenant's work types (`GET /workTypes`).\n- Send `name` and the `groups` hierarchy.\n- Every referenced field ID must belong to the tenant.","tags":["Fields"],"parameters":[{"name":"tenantId","description":"The tenant to create the record layout for. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutCreateOneRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get a record layout

> Returns one record layout with its full structure: groups, sections and ordered field references. \`meta.writeToken\` identifies this version.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RecordLayoutFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutFindOneResponse","description":"One record layout, with `name`, `workType` and the `groups` hierarchy of groups, sections and field references that shapes the editor for its work type.","type":"object","additionalProperties":false,"required":["data","links","meta","jsonapi"],"properties":{"meta":{"$ref":"#/components/schemas/RecordLayoutMeta"},"data":{"type":"object","required":["id","type","attributes","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recordLayouts"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLayoutAttributes"}]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"]}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordLayoutMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutMeta","description":"Version of the record layout in this response.","type":"object","additionalProperties":false,"required":["writeToken"],"properties":{"writeToken":{"type":"string","description":"Opaque value that changes on every write."}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RecordLayoutAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutAttributes","description":"Attributes of a record layout. `workType` sets the work type the layout applies to.","type":"object","required":["name","workType","groups"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name of the layout, such as `\"Movie Layout\"` or `\"Series Default Layout\"`."},"description":{"type":"string","description":"Longer description of the layout and its purpose."},"workType":{"$ref":"#/components/schemas/WorkTypes"},"groups":{"type":"array","description":"Ordered groups of the layout. Each group is a tab or major panel in the record editor and holds sections, which hold fields.","items":{"$ref":"#/components/schemas/RecordLayoutGroup"}}}},"WorkTypes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkTypes","description":"The key of one of the tenant's work types. Every tenant has seven built-in work types:\n- `Movie`: a standalone feature-length film\n- `MovieEdit`: a variation of a Movie\n- `Series`: a TV or streaming series\n- `Season`: a season within a Series\n- `Episode`: a single episode\n- `EpisodeEdit`: a variation of an Episode\n- `Compilation`: an editorially curated collection of existing records\n\nTenants can also define custom work types; list them with `GET /workTypes`.","type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$"},"RecordLayoutGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutGroup","description":"A top-level group of sections in a record layout, usually a tab or major panel in the record editor.","type":"object","required":["key","label","type","sections"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Group id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the group, unique within the layout, such as `\"origination\"` or `\"technical_details\"`."},"label":{"type":"string","description":"Tab or panel heading in the editor, such as `\"Origination\"` or `\"Technical Details\"`."},"type":{"type":"string","enum":["fieldGroup","entityCollection"],"description":"Role of the group in the layout.\n- `fieldGroup`: editable metadata fields, arranged in sections.\n- `entityCollection`: reserved for linked entities such as contributors or credits; can't hold custom sections."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the group. Applies only to `fieldGroup` groups; you can't set it on `entityCollection` groups. You can't hide the required origination group."},"sections":{"type":"array","description":"Ordered sections of the group, each with an ordered list of fields. `entityCollection` groups must have an empty `sections` array.","items":{"$ref":"#/components/schemas/RecordLayoutSection"}}}},"RecordLayoutSection":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutSection","description":"A section of a record layout group: a labeled set of fields within the group's tab or panel in the editor.","type":"object","required":["key","label","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Section id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the section, unique within its group, such as `\"core_metadata\"` or `\"identifiers\"`."},"label":{"type":"string","description":"Section heading in the editor, such as `\"Core Metadata\"` or `\"Identifiers\"`."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the section and all its fields. You can't hide the system-required `core_metadata` section."},"fields":{"type":"array","description":"Ordered field references, each by `id` and `key`. The order sets the display order in the editor.","items":{"$ref":"#/components/schemas/RecordLayoutField"}}}},"RecordLayoutField":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutField","description":"Places a field, by `id` and `key`, at a position in a layout section. The section's `fields` array lets you group several sub-fields under one layout position.","type":"object","required":["id","key","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The field to place here. Must be an existing field in the tenant."},"key":{"type":"string","description":"Key of the field to place here, such as `\"synopsis\"` or `\"release_year\"`."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/recordLayouts/{recordLayoutId}":{"get":{"summary":"Get a record layout","operationId":"recordLayoutFindOne","description":"Returns one record layout with its full structure: groups, sections and ordered field references. `meta.writeToken` identifies this version.","tags":["Fields"],"parameters":[{"name":"recordLayoutId","description":"The record layout to return.","in":"path","required":true,"schema":{"type":"string"}},{"name":"tenantId","description":"The tenant that owns the record layout. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Delete a record layout

> Deletes a record layout. The fields it references stay.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"WriteMetaOnlyRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteMetaOnlyRequest","description":"An optional body with only audit metadata, for mutations that take no other body, such as deletes. Use it to send `meta.audit.source` and `meta.audit.reason`.","type":"object","additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}},"paths":{"/recordLayouts/{recordLayoutId}":{"delete":{"summary":"Delete a record layout","operationId":"recordLayoutDeleteOne","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteMetaOnlyRequest"}}}},"description":"Deletes a record layout. The fields it references stay.","tags":["Fields"],"parameters":[{"name":"recordLayoutId","description":"The record layout to delete.","in":"path","required":true,"schema":{"type":"string"}},{"name":"tenantId","description":"The tenant that owns the record layout. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Update a record layout

> Updates only the attributes you send: \`name\`, \`description\` or \`groups\`.\
> \- \`groups\` replaces the whole hierarchy, so send the complete structure.\
> \- Every referenced field ID must belong to the tenant.\
> \- Keep the required system groups, such as the origination group.\
> \- Send \`meta.writeToken\` and the server answers 409 if the layout changed since you read it.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Fields","description":"Manage a tenant's fields. A field is a data point a record can hold, such as a synopsis, genre list or release year. A field can carry a validation schema that the server enforces on save. Every tenant gets the shared system fields for standard title metadata and can add its own custom fields."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"RecordLayoutUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutUpdateOneRequest","description":"Updates a record layout, such as its `name`, `description` or the structure of groups, sections and fields. Changes only the attributes you send.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"type":"object","additionalProperties":false,"properties":{"writeToken":{"type":"string","description":"The `meta.writeToken` you last read. The save answers 409 if the layout changed since."},"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"description":{"type":"string"},"groups":{"type":"array","items":{"type":"object","required":["key","label","type","sections"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"type":{"type":"string","enum":["fieldGroup","entityCollection"]},"hidden":{"type":"boolean"},"sections":{"type":"array","items":{"type":"object","required":["id","key","label","fields"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"hidden":{"type":"boolean"},"fields":{"type":"array","items":{"type":"object","required":["id","key"],"additionalProperties":false,"properties":{"id":{"type":"string"},"key":{"type":"string"},"span":{"type":"number"}}}}}}}}}}}}}}]}}},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"RecordLayoutFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutFindOneResponse","description":"One record layout, with `name`, `workType` and the `groups` hierarchy of groups, sections and field references that shapes the editor for its work type.","type":"object","additionalProperties":false,"required":["data","links","meta","jsonapi"],"properties":{"meta":{"$ref":"#/components/schemas/RecordLayoutMeta"},"data":{"type":"object","required":["id","type","attributes","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["recordLayouts"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLayoutAttributes"}]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"]}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordLayoutMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutMeta","description":"Version of the record layout in this response.","type":"object","additionalProperties":false,"required":["writeToken"],"properties":{"writeToken":{"type":"string","description":"Opaque value that changes on every write."}}},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RecordLayoutAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutAttributes","description":"Attributes of a record layout. `workType` sets the work type the layout applies to.","type":"object","required":["name","workType","groups"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name of the layout, such as `\"Movie Layout\"` or `\"Series Default Layout\"`."},"description":{"type":"string","description":"Longer description of the layout and its purpose."},"workType":{"$ref":"#/components/schemas/WorkTypes"},"groups":{"type":"array","description":"Ordered groups of the layout. Each group is a tab or major panel in the record editor and holds sections, which hold fields.","items":{"$ref":"#/components/schemas/RecordLayoutGroup"}}}},"WorkTypes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkTypes","description":"The key of one of the tenant's work types. Every tenant has seven built-in work types:\n- `Movie`: a standalone feature-length film\n- `MovieEdit`: a variation of a Movie\n- `Series`: a TV or streaming series\n- `Season`: a season within a Series\n- `Episode`: a single episode\n- `EpisodeEdit`: a variation of an Episode\n- `Compilation`: an editorially curated collection of existing records\n\nTenants can also define custom work types; list them with `GET /workTypes`.","type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$"},"RecordLayoutGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutGroup","description":"A top-level group of sections in a record layout, usually a tab or major panel in the record editor.","type":"object","required":["key","label","type","sections"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Group id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the group, unique within the layout, such as `\"origination\"` or `\"technical_details\"`."},"label":{"type":"string","description":"Tab or panel heading in the editor, such as `\"Origination\"` or `\"Technical Details\"`."},"type":{"type":"string","enum":["fieldGroup","entityCollection"],"description":"Role of the group in the layout.\n- `fieldGroup`: editable metadata fields, arranged in sections.\n- `entityCollection`: reserved for linked entities such as contributors or credits; can't hold custom sections."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the group. Applies only to `fieldGroup` groups; you can't set it on `entityCollection` groups. You can't hide the required origination group."},"sections":{"type":"array","description":"Ordered sections of the group, each with an ordered list of fields. `entityCollection` groups must have an empty `sections` array.","items":{"$ref":"#/components/schemas/RecordLayoutSection"}}}},"RecordLayoutSection":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutSection","description":"A section of a record layout group: a labeled set of fields within the group's tab or panel in the editor.","type":"object","required":["key","label","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Section id, unique within the layout. The server assigns it on creation."},"key":{"type":"string","description":"Stable key of the section, unique within its group, such as `\"core_metadata\"` or `\"identifiers\"`."},"label":{"type":"string","description":"Section heading in the editor, such as `\"Core Metadata\"` or `\"Identifiers\"`."},"hidden":{"type":"boolean","description":"When `true`, the editor hides the section and all its fields. You can't hide the system-required `core_metadata` section."},"fields":{"type":"array","description":"Ordered field references, each by `id` and `key`. The order sets the display order in the editor.","items":{"$ref":"#/components/schemas/RecordLayoutField"}}}},"RecordLayoutField":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLayoutField","description":"Places a field, by `id` and `key`, at a position in a layout section. The section's `fields` array lets you group several sub-fields under one layout position.","type":"object","required":["id","key","fields"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The field to place here. Must be an existing field in the tenant."},"key":{"type":"string","description":"Key of the field to place here, such as `\"synopsis\"` or `\"release_year\"`."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/recordLayouts/{recordLayoutId}":{"patch":{"summary":"Update a record layout","operationId":"recordLayoutUpdateOne","description":"Updates only the attributes you send: `name`, `description` or `groups`.\n- `groups` replaces the whole hierarchy, so send the complete structure.\n- Every referenced field ID must belong to the tenant.\n- Keep the required system groups, such as the origination group.\n- Send `meta.writeToken` and the server answers 409 if the layout changed since you read it.","tags":["Fields"],"parameters":[{"name":"recordLayoutId","description":"The record layout to update.","in":"path","required":true,"schema":{"type":"string"}},{"name":"tenantId","description":"The tenant that owns the record layout. Defaults to the current tenant.","in":"query","required":false,"style":"form","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutUpdateOneRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLayoutFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: policies still reference a removed section (`meta.conflictItems`), or the layout changed since you read `meta.writeToken`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
