> 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/models.md).

# Models

## The WriteRequestMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}}}}}
```

## The AuditQueryCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AuditQueryCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditQueryCreateOneRequest","description":"An audit query to start.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["auditQueries"]},"attributes":{"type":"object","additionalProperties":false,"required":["dateFrom","dateTo"],"properties":{"dateFrom":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Start of the date range (inclusive), YYYY-MM-DD"},"dateTo":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"End of the date range (inclusive), YYYY-MM-DD"},"resourceTypes":{"type":"array","items":{"type":"string","pattern":"^KS::[A-Za-z]+$"},"description":"Resource type keys to filter by; matches any of them"},"search":{"type":"string","maxLength":200,"description":"Matches `resourceName` as a case-insensitive substring, or `rootEntityId` exactly"},"recordId":{"type":"string","maxLength":100,"description":"Scopes the query to one record's change history (exact `rootEntityId` match). Needs history access to that record, so your policy's work-type, lifecycle and security-tag scoping applies. Without `recordId`, the query covers the whole tenant (the Administration audit log) and only administrators can run it. `search` can't scope to one record: it also matches `resourceName`."}}}}}}},"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}}}}}}}}
```

## The AuditQueryCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AuditQueryCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditQueryCreateOneResponse","description":"The started audit query. Poll `GET /auditQueries/{id}` for results.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Query execution ID: pass it as the path parameter when you poll"},"type":{"type":"string","enum":["auditQueries"]},"attributes":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["RUNNING"],"description":"Always `RUNNING` for a new query"}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"}}}}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}
```

## The AuditEventAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AuditEventAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditEventAttributes","description":"Attributes of a single audit event captured from a Keystone entity change","type":"object","additionalProperties":false,"required":["rootEntityId","tenantId","timestamp","actorId","actorName","actorType","action","resourceType","resourceId","resourceName"],"properties":{"rootEntityId":{"type":"string","description":"ID of the root entity this event is grouped under"},"tenantId":{"type":"string","description":"Tenant that owns this event"},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred"},"actorId":{"type":"string","description":"ID of the user or system that triggered the change"},"actorName":{"type":"string","description":"Display name of the actor"},"actorType":{"type":"string","description":"Type of actor (e.g. user, system)"},"action":{"type":"string","description":"Cedar action that was performed (e.g. updateRecord)"},"changeSource":{"type":"string","description":"Source system or surface that triggered the change"},"changeReason":{"type":"string","description":"Optional free-text reason provided by the actor"},"resourceType":{"type":"string","description":"KS:: prefixed entity type (e.g. KS::Record)"},"resourceId":{"type":"string","description":"ID of the specific resource that changed"},"resourceName":{"type":"string","description":"Display name of the resource at the time of the event"},"changesJson":{"type":"string","description":"JSON-encoded diff of the changes made"}}}}}}
```

## The AuditEvent object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AuditEvent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditEvent","description":"JSON:API resource object for a single audit event","type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Unique event ID"},"type":{"type":"string","enum":["auditEvents"]},"attributes":{"$ref":"#/components/schemas/AuditEventAttributes"}}},"AuditEventAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditEventAttributes","description":"Attributes of a single audit event captured from a Keystone entity change","type":"object","additionalProperties":false,"required":["rootEntityId","tenantId","timestamp","actorId","actorName","actorType","action","resourceType","resourceId","resourceName"],"properties":{"rootEntityId":{"type":"string","description":"ID of the root entity this event is grouped under"},"tenantId":{"type":"string","description":"Tenant that owns this event"},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred"},"actorId":{"type":"string","description":"ID of the user or system that triggered the change"},"actorName":{"type":"string","description":"Display name of the actor"},"actorType":{"type":"string","description":"Type of actor (e.g. user, system)"},"action":{"type":"string","description":"Cedar action that was performed (e.g. updateRecord)"},"changeSource":{"type":"string","description":"Source system or surface that triggered the change"},"changeReason":{"type":"string","description":"Optional free-text reason provided by the actor"},"resourceType":{"type":"string","description":"KS:: prefixed entity type (e.g. KS::Record)"},"resourceId":{"type":"string","description":"ID of the specific resource that changed"},"resourceName":{"type":"string","description":"Display name of the resource at the time of the event"},"changesJson":{"type":"string","description":"JSON-encoded diff of the changes made"}}}}}}
```

## The AuditQueryFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AuditQueryFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditQueryFindOneResponse","description":"An audit query poll result: 202 while `RUNNING` or `FAILED`; 200 with events in `data` when `SUCCEEDED`.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"},"description":"Audit events. Empty until the status is `SUCCEEDED`."},"meta":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["QUEUED","RUNNING","SUCCEEDED","FAILED"],"description":"Current query execution state"},"hasMore":{"type":"boolean","description":"`true` when the results exceed 1,000 events. Narrow the filters to see them all."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"AuditEvent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditEvent","description":"JSON:API resource object for a single audit event","type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Unique event ID"},"type":{"type":"string","enum":["auditEvents"]},"attributes":{"$ref":"#/components/schemas/AuditEventAttributes"}}},"AuditEventAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAuditEventAttributes","description":"Attributes of a single audit event captured from a Keystone entity change","type":"object","additionalProperties":false,"required":["rootEntityId","tenantId","timestamp","actorId","actorName","actorType","action","resourceType","resourceId","resourceName"],"properties":{"rootEntityId":{"type":"string","description":"ID of the root entity this event is grouped under"},"tenantId":{"type":"string","description":"Tenant that owns this event"},"timestamp":{"type":"string","description":"ISO 8601 timestamp of when the event occurred"},"actorId":{"type":"string","description":"ID of the user or system that triggered the change"},"actorName":{"type":"string","description":"Display name of the actor"},"actorType":{"type":"string","description":"Type of actor (e.g. user, system)"},"action":{"type":"string","description":"Cedar action that was performed (e.g. updateRecord)"},"changeSource":{"type":"string","description":"Source system or surface that triggered the change"},"changeReason":{"type":"string","description":"Optional free-text reason provided by the actor"},"resourceType":{"type":"string","description":"KS:: prefixed entity type (e.g. KS::Record)"},"resourceId":{"type":"string","description":"ID of the specific resource that changed"},"resourceName":{"type":"string","description":"Display name of the resource at the time of the event"},"changesJson":{"type":"string","description":"JSON-encoded diff of the changes made"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The BaseResourceAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"}}}}}}
```

## The BackgroundJobStatus object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]}}}}
```

## The BackgroundJobAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]}}}}
```

## The LinksRelated object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}
```

## The TenantRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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},"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}}}}
```

## The UserRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UserRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRelationship","description":"A relationship to the actor behind a write, such as `author` or `updatedBy`. `data.meta.type` is the actor type: a human user, an API key or an internal service. Only human users carry `links.related`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"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}}}}
```

## The BackgroundJobFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobFindManyResponse","description":"One page of background jobs in the caller's tenant.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["backgroundJobs"]},"attributes":{"$ref":"#/components/schemas/BackgroundJobAttributes"},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"author":{"$ref":"#/components/schemas/UserRelationship"}},"additionalProperties":false}},"required":["id","type","attributes"],"additionalProperties":false}},"meta":{"type":"object","properties":{"cursor":{"type":"string","description":"Pass as `page.cursor` to get the next page."}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"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},"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},"UserRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRelationship","description":"A relationship to the actor behind a write, such as `author` or `updatedBy`. `data.meta.type` is the actor type: a human user, an API key or an internal service. Only human users carry `links.related`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The BackgroundJobFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobFindOneResponse","description":"A single background job.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["backgroundJobs"]},"attributes":{"$ref":"#/components/schemas/BackgroundJobAttributes"},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"author":{"$ref":"#/components/schemas/UserRelationship"}},"additionalProperties":false}},"required":["id","type","attributes"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"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},"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},"UserRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRelationship","description":"A relationship to the actor behind a write, such as `author` or `updatedBy`. `data.meta.type` is the actor type: a human user, an API key or an internal service. Only human users carry `links.related`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The BackgroundJobUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobUpdateOneRequest","description":"Request body that aborts a running background job.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["backgroundJobs"]},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["ABORTED"]}},"required":["status"],"additionalProperties":false}},"required":["id","type","attributes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}}
```

## The BackgroundJobGetErrorsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobGetErrorsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobGetErrorsResponse","description":"A presigned URL that downloads a zip of a background job's per-item failure files. The resource `id` is the job id.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The job that owns the error archive."},"type":{"type":"string","enum":["backgroundJobErrorArchives"]},"attributes":{"type":"object","required":["url","expiresInSeconds"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"Presigned S3 URL that downloads the zipped error archive."},"expiresInSeconds":{"type":"integer","description":"Seconds until the URL expires."}}},"links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string","description":"The endpoint that issued this URL."}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The relationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"relationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}}}}
```

## The BackgroundJobItemFailure object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobItemFailure":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobItemFailure","description":"One failed item of a background job.\n- `id`: the item key. Data ingress uses the source index; bulk edit uses the record id.\n- `errors`: one entry per cause, shaped like a JSON:API error object. Only `detail` is always present. Bulk edit copies the underlying error's `status`, `title` and `detail` verbatim. Jobs with an error-code vocabulary, such as data ingress, add a `code`.\n- `stage`: the stage that stopped the item, for multi-stage jobs. Data ingress uses `enumeration`, `mapping` or `recordWrite`; single-stage jobs omit it.","type":"object","additionalProperties":false,"required":["type","id","attributes"],"definitions":{"relationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}},"properties":{"type":{"type":"string","enum":["backgroundJobItemFailures"]},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["timestamp","errors"],"properties":{"label":{"type":"string","description":"A readable handle for the item, such as its upstream id."},"timestamp":{"type":"string","description":"When the job recorded the failure, in ISO 8601."},"stage":{"type":"string","description":"The stage that stopped the item. Single-stage jobs omit it."},"errors":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["detail"],"properties":{"status":{"type":"integer","description":"The underlying error's HTTP status code, when the failure came from one."},"code":{"type":"string","description":"A machine-readable code, from jobs with an error-code vocabulary, such as data ingress."},"title":{"type":"string","description":"A short summary of the error class."},"detail":{"type":"string","description":"A readable explanation of the failure."}}}}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/relationship"},"tenant":{"$ref":"#/components/schemas/relationship"},"record":{"$ref":"#/components/schemas/relationship"}}}}},"relationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}}}}
```

## The BackgroundJobFailuresFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"BackgroundJobFailuresFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobFailuresFindManyResponse","description":"One page of a background job's per-item failures. Leaves out each failure's `meta`; download the error archive for that detail. Page with `meta.cursor`; there is no backwards cursor.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BackgroundJobItemFailure"}},"meta":{"type":"object","properties":{"cursor":{"type":"string","description":"Pass as `page.cursor` to get the next page."}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"BackgroundJobItemFailure":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobItemFailure","description":"One failed item of a background job.\n- `id`: the item key. Data ingress uses the source index; bulk edit uses the record id.\n- `errors`: one entry per cause, shaped like a JSON:API error object. Only `detail` is always present. Bulk edit copies the underlying error's `status`, `title` and `detail` verbatim. Jobs with an error-code vocabulary, such as data ingress, add a `code`.\n- `stage`: the stage that stopped the item, for multi-stage jobs. Data ingress uses `enumeration`, `mapping` or `recordWrite`; single-stage jobs omit it.","type":"object","additionalProperties":false,"required":["type","id","attributes"],"definitions":{"relationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}},"properties":{"type":{"type":"string","enum":["backgroundJobItemFailures"]},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["timestamp","errors"],"properties":{"label":{"type":"string","description":"A readable handle for the item, such as its upstream id."},"timestamp":{"type":"string","description":"When the job recorded the failure, in ISO 8601."},"stage":{"type":"string","description":"The stage that stopped the item. Single-stage jobs omit it."},"errors":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["detail"],"properties":{"status":{"type":"integer","description":"The underlying error's HTTP status code, when the failure came from one."},"code":{"type":"string","description":"A machine-readable code, from jobs with an error-code vocabulary, such as data ingress."},"title":{"type":"string","description":"A short summary of the error class."},"detail":{"type":"string","description":"A readable explanation of the failure."}}}}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/relationship"},"tenant":{"$ref":"#/components/schemas/relationship"},"record":{"$ref":"#/components/schemas/relationship"}}}}},"relationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ContributorResourceType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorResourceType","description":"JSON:API type discriminator for contributor resources. The `type` field is always `\"contributors\"`. Used as a base for contributor request and response shapes to enforce correct JSON:API resource typing.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}}}}}}
```

## The ContributorAttributeName object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"}}}}
```

## The ContributorAttributeGender object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]}}}}
```

## The ContributorAttributeOriginRating object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"}}}}
```

## The ContributorAttributeBirthDate object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"}}}}
```

## The ContributorAttributeBirthName object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"}}}}
```

## The ContributorAttributeImage object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}}}}}
```

## The ContributorAttributeOriginNexusId object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"}}}}
```

## The ContributorAttributeImdbId object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"}}}}
```

## The ContributorAttributeDataSource object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]}}}}
```

## The ContributorAttributesInput object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]}}}}
```

## The ContributorCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorCreateOneRequest","description":"Request body for creating a new contributor. Follows the JSON:API resource creation format with `type: 'contributors'` and an `attributes` object. The `name` field is required; all other attributes are optional. Set `dataSource` to `'custom'` for manually created contributors.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/ContributorResourceType"},{"type":"object","required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/ContributorAttributesInput"},{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}}]}}}]}},"required":["data"],"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}}}}},"ContributorResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorResourceType","description":"JSON:API type discriminator for contributor resources. The `type` field is always `\"contributors\"`. Used as a base for contributor request and response shapes to enforce correct JSON:API resource typing.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}}},"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]}}}}
```

## The ContributorAttributeStatus object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]}}}}
```

## The ContributorAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributes","description":"Full set of attributes for a stored contributor, combining all editable input fields with system-managed fields (status, dataSource) and base resource timestamps. Returned in contributor read and write responses.","allOf":[{"$ref":"#/components/schemas/ContributorAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/ContributorAttributeStatus"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}}]},"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]},"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"}}},"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]}}}}
```

## The ContributorRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationships","description":"JSON:API relationship links for a contributor resource. Currently contains the owning tenant relationship.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The LinksSelf object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false}}}}
```

## The ContributorCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorCreateOneResponse","description":"Response returned after successfully creating a contributor. Contains the new contributor's ID, type, full attribute set, and relationship links to the owning tenant.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ContributorResourceType"},{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/ContributorAttributes"},"relationships":{"$ref":"#/components/schemas/ContributorRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"ContributorResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorResourceType","description":"JSON:API type discriminator for contributor resources. The `type` field is always `\"contributors\"`. Used as a base for contributor request and response shapes to enforce correct JSON:API resource typing.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}}},"ContributorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributes","description":"Full set of attributes for a stored contributor, combining all editable input fields with system-managed fields (status, dataSource) and base resource timestamps. Returned in contributor read and write responses.","allOf":[{"$ref":"#/components/schemas/ContributorAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/ContributorAttributeStatus"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}}]},"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]},"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"}}},"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]},"ContributorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationships","description":"JSON:API relationship links for a contributor resource. Currently contains the owning tenant relationship.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ContributorFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorFindOneResponse","description":"Response returned when retrieving a single contributor by ID. Contains the full contributor resource including all attributes (name, identifiers, biography descriptions, image) and relationship links to the owning tenant.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","const":"contributors"},"attributes":{"$ref":"#/components/schemas/ContributorAttributes"},"relationships":{"$ref":"#/components/schemas/ContributorRelationships"}}},"links":{"$ref":"#/components/schemas/LinksSelf"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"ContributorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributes","description":"Full set of attributes for a stored contributor, combining all editable input fields with system-managed fields (status, dataSource) and base resource timestamps. Returned in contributor read and write responses.","allOf":[{"$ref":"#/components/schemas/ContributorAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/ContributorAttributeStatus"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}}]},"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]},"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"}}},"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]},"ContributorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationships","description":"JSON:API relationship links for a contributor resource. Currently contains the owning tenant relationship.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ContributorUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorUpdateOneRequest","description":"Updates the attributes you send and leaves the rest unchanged. Set `data.type` to `contributors` and `data.id` to the contributor in the URL.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/ContributorResourceType"},{"type":"object","required":["id","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/ContributorAttributesInput"}}}]}},"required":["data"],"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}}}}},"ContributorResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorResourceType","description":"JSON:API type discriminator for contributor resources. The `type` field is always `\"contributors\"`. Used as a base for contributor request and response shapes to enforce correct JSON:API resource typing.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}}},"ContributorAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesInput","description":"Editable attributes for a contributor, used as the base for both create and update request bodies. All fields are optional to support partial updates. Includes personal metadata (name, gender, birth details), cross-platform identifiers (IMDb, TMDB, Origin, Wikidata, social handles), profile image, localized descriptions, and data source indicator.","type":"object","required":[],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"deathDate":{"type":"string","description":"The contributor's date of death, if applicable. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates."},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"},"altNames":{"type":"array","description":"A list of alternative names or known aliases for the contributor (e.g., stage names, maiden names, transliterations). Each value must be unique within the array.","items":{"type":"string"},"uniqueItems":true},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"tmdbId":{"type":"string","description":"The contributor's ID in The Movie Database (TMDB). Used for cross-referencing with TMDB person records."},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"facebookId":{"type":"string","description":"The contributor's Facebook profile identifier or username."},"instagramId":{"type":"string","description":"The contributor's Instagram handle or profile identifier."},"twitterId":{"type":"string","description":"The contributor's Twitter/X handle or profile identifier."},"freebaseMidId":{"type":"string","description":"The contributor's Freebase machine ID (MID), a stable identifier from the Freebase knowledge graph."},"freebaseId":{"type":"string","description":"The contributor's Freebase topic ID, a human-readable identifier from the Freebase knowledge graph."},"tvRageId":{"type":"string","description":"The contributor's ID on the TVRage database."},"tvMediaId":{"type":"string","description":"The contributor's ID in the TV Media database."},"wikiDataId":{"type":"string","description":"The contributor's Wikidata entity ID (e.g., `Q12345`). Used for cross-referencing with the Wikidata knowledge base."},"wikiMediaId":{"type":"string","description":"The contributor's Wikimedia Commons identifier, typically used for linking to media files hosted on Wikimedia."},"handIdentityId":{"type":"string","description":"The contributor's identifier in the HAND (Hollywood Accounting Network Database) system."},"descriptions":{"type":"array","description":"A list of localized biographical descriptions for the contributor, sourced from external providers. Each entry is keyed by a unique identifier and scoped to a locale.","items":{"type":"object","required":["key","value","locale","attribution"],"additionalProperties":false,"properties":{"key":{"type":"string","description":"A unique key identifying this description entry, typically the locale code or a provider-specific identifier."},"value":{"type":"string","description":"The biographical text content for this description."},"locale":{"type":"string","description":"BCP 47 language tag for the description's language (e.g., `en`, `fr`, `es`)."},"attribution":{"type":"string","description":"The name or identifier of the source providing this description (e.g., a data provider name)."}}}},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"}}},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]}}}}
```

## The IContributorOperator object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IContributorOperator":{"type":"string","description":"The operator to use for a search condition. eq — exact match. ne — exact exclusion; a record with NO value for the field satisfies ne. contains — substring/token match. not_contains — negation of contains, with the same 'no value satisfies the negation' semantics as ne. starts_with — prefix match. lt/lte/gt/gte — numeric or date range comparisons. exists — field has any non-null value. not_exists — field is absent or null.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IContributorCondition object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IContributorCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id","name","gender","originRating","birthDate","birthName","originNexusId","imdbId","status","dataSource"]},"operator":{"$ref":"#/components/schemas/IContributorOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `name`.\n- Omitted or `true`: a word one or two characters off still matches (\"smyth\" finds \"Smith\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IContributorOperator":{"type":"string","description":"The operator to use for a search condition. eq — exact match. ne — exact exclusion; a record with NO value for the field satisfies ne. contains — substring/token match. not_contains — negation of contains, with the same 'no value satisfies the negation' semantics as ne. starts_with — prefix match. lt/lte/gt/gte — numeric or date range comparisons. exists — field has any non-null value. not_exists — field is absent or null.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IContributorQueryGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IContributorQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IContributorCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IContributorQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"IContributorCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id","name","gender","originRating","birthDate","birthName","originNexusId","imdbId","status","dataSource"]},"operator":{"$ref":"#/components/schemas/IContributorOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `name`.\n- Omitted or `true`: a word one or two characters off still matches (\"smyth\" finds \"Smith\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IContributorOperator":{"type":"string","description":"The operator to use for a search condition. eq — exact match. ne — exact exclusion; a record with NO value for the field satisfies ne. contains — substring/token match. not_contains — negation of contains, with the same 'no value satisfies the negation' semantics as ne. starts_with — prefix match. lt/lte/gt/gte — numeric or date range comparisons. exists — field has any non-null value. not_exists — field is absent or null.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The ContributorSearchRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorSearchRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorSearchRequest","description":"Request body for searching contributors. Queries are expressed as a tree of condition groups combined with boolean operators (AND, OR, NOT). Each leaf condition targets a specific contributor field using a comparison operator and value. Nested groups allow for arbitrarily complex query logic.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["searchQueries"]},"attributes":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/IContributorQueryGroup"}},"required":["group"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"definitions":{"IContributorOperator":{"type":"string","description":"The operator to use for a search condition. eq — exact match. ne — exact exclusion; a record with NO value for the field satisfies ne. contains — substring/token match. not_contains — negation of contains, with the same 'no value satisfies the negation' semantics as ne. starts_with — prefix match. lt/lte/gt/gte — numeric or date range comparisons. exists — field has any non-null value. not_exists — field is absent or null.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]},"IContributorCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id","name","gender","originRating","birthDate","birthName","originNexusId","imdbId","status","dataSource"]},"operator":{"$ref":"#/components/schemas/IContributorOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `name`.\n- Omitted or `true`: a word one or two characters off still matches (\"smyth\" finds \"Smith\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IContributorQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IContributorCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IContributorQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"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}}}}},"IContributorQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IContributorCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IContributorQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"IContributorCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id","name","gender","originRating","birthDate","birthName","originNexusId","imdbId","status","dataSource"]},"operator":{"$ref":"#/components/schemas/IContributorOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `name`.\n- Omitted or `true`: a word one or two characters off still matches (\"smyth\" finds \"Smith\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IContributorOperator":{"type":"string","description":"The operator to use for a search condition. eq — exact match. ne — exact exclusion; a record with NO value for the field satisfies ne. contains — substring/token match. not_contains — negation of contains, with the same 'no value satisfies the negation' semantics as ne. starts_with — prefix match. lt/lte/gt/gte — numeric or date range comparisons. exists — field has any non-null value. not_exists — field is absent or null.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The ContributorAttributesOpenSearchResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorAttributesOpenSearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesOpenSearchResponse","description":"Contributor attribute fields returned in search results. Contains the core contributor metadata fields (name, gender, dates, identifiers, status) as indexed by the search engine. Used as the `attributes` object within each search result item.","allOf":[{"type":"object","required":["name","status","dataSource"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"status":{"$ref":"#/components/schemas/ContributorAttributeStatus"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"}}}]},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}}}}}
```

## The SearchSortMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SearchSortMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchSortMeta","description":"The ordering applied to the search results. Every search response carries it, whether or not the request asked for an ordering.","type":"object","properties":{"applied":{"type":"string","description":"The ordering applied, in the `sort` parameter's comma-separated syntax. Pass it back as `sort` to keep the ordering fixed across later requests."},"default":{"type":"boolean","description":"`true` when the request had no `sort` and the server chose the ordering; `false` when it reflects the `sort` you sent."}},"required":["applied","default"],"additionalProperties":false}}}}
```

## The ContributorSearchResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorSearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorSearchResponse","description":"Response returned by the contributor search endpoint. Contains a paginated array of JSON:API contributor resources with their search-indexed attributes and relationships. The `meta` object includes pagination details (total count, current page, per-page size) and optional relevance scoring metadata.","type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ContributorResourceType"},{"type":"object","required":["id","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/ContributorAttributesOpenSearchResponse"},"relationships":{"$ref":"#/components/schemas/ContributorRelationships"}}}],"additionalProperties":false},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"},"next":{"type":["string","null"]},"prev":{"type":["string","null"]}},"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"perPage":{"type":"integer"},"sort":{"$ref":"#/components/schemas/SearchSortMeta"}},"required":["total","page","perPage"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","meta","jsonapi"],"additionalProperties":false},"ContributorResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorResourceType","description":"JSON:API type discriminator for contributor resources. The `type` field is always `\"contributors\"`. Used as a base for contributor request and response shapes to enforce correct JSON:API resource typing.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}}},"ContributorAttributesOpenSearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributesOpenSearchResponse","description":"Contributor attribute fields returned in search results. Contains the core contributor metadata fields (name, gender, dates, identifiers, status) as indexed by the search engine. Used as the `attributes` object within each search result item.","allOf":[{"type":"object","required":["name","status","dataSource"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/ContributorAttributeName"},"gender":{"$ref":"#/components/schemas/ContributorAttributeGender"},"originRating":{"$ref":"#/components/schemas/ContributorAttributeOriginRating"},"birthDate":{"$ref":"#/components/schemas/ContributorAttributeBirthDate"},"birthName":{"$ref":"#/components/schemas/ContributorAttributeBirthName"},"originNexusId":{"$ref":"#/components/schemas/ContributorAttributeOriginNexusId"},"imdbId":{"$ref":"#/components/schemas/ContributorAttributeImdbId"},"status":{"$ref":"#/components/schemas/ContributorAttributeStatus"},"dataSource":{"$ref":"#/components/schemas/ContributorAttributeDataSource"},"image":{"$ref":"#/components/schemas/ContributorAttributeImage"}}}]},"ContributorAttributeName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeName","description":"The contributor's display name. For most contributors this is their full name (e.g., 'John Doe'). Required when creating a contributor.","type":"string"},"ContributorAttributeGender":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeGender","description":"The contributor's gender. Sourced from the external metadata provider when the contributor originates from Origin.","type":"string","enum":["male","female"]},"ContributorAttributeOriginRating":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginRating","description":"A normalized popularity or relevance score for the contributor as provided by the Origin metadata provider. Higher values indicate greater prominence.","type":"number"},"ContributorAttributeBirthDate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthDate","description":"The contributor's date of birth. Stored as a string to accommodate partial dates (year-only or year-month) as well as full ISO 8601 dates.","type":"string"},"ContributorAttributeBirthName":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeBirthName","description":"The contributor's birth name or legal name, if different from their primary display name (e.g., a stage name or alias is used as the primary name).","type":"string"},"ContributorAttributeOriginNexusId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeOriginNexusId","description":"The contributor's unique identifier in Origin Nexus. Used to link Origin Studio contributors to their corresponding Origin Nexus records and to sync updates.","type":"string"},"ContributorAttributeImdbId":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImdbId","description":"The contributor's IMDb person ID (e.g., 'nm0000093'). Used for cross-referencing with the Internet Movie Database.","type":"string"},"ContributorAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeStatus","description":"Lifecycle status of the contributor. `active` means the contributor is available for use. `pendingDeletion` means a delete job has been initiated and the contributor will be removed once all associated credits are cleaned up.","type":"string","enum":["active","pendingDeletion"]},"ContributorAttributeDataSource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeDataSource","description":"Indicates the origin of the contributor's data. `originNexus` means the record was ingested from Origin Nexus and may be updated by automated sync jobs. `custom` means the record was created manually by the tenant and is not subject to automated overwrites.","type":"string","enum":["originNexus","custom"]},"ContributorAttributeImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorAttributeImage","description":"A profile image for the contributor. Contains the image URL and its pixel dimensions.","type":"object","required":["url","width","height"],"additionalProperties":false,"properties":{"url":{"type":"string","format":"uri","description":"The fully qualified URL of the profile image."},"width":{"type":"number","description":"The image width in pixels."},"height":{"type":"number","description":"The image height in pixels."}}},"ContributorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationships","description":"JSON:API relationship links for a contributor resource. Currently contains the owning tenant relationship.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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},"SearchSortMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchSortMeta","description":"The ordering applied to the search results. Every search response carries it, whether or not the request asked for an ordering.","type":"object","properties":{"applied":{"type":"string","description":"The ordering applied, in the `sort` parameter's comma-separated syntax. Pass it back as `sort` to keep the ordering fixed across later requests."},"default":{"type":"boolean","description":"`true` when the request had no `sort` and the server chose the ordering; `false` when it reflects the `sort` you sent."}},"required":["applied","default"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The BaseCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"]}}}}
```

## The ContributorDeleteJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorDeleteJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorDeleteJobParameters","description":"Parameters for the `deleteContributor` background job. Specifies the unique ID of the contributor to be permanently deleted along with all associated credits.","type":"object","properties":{"contributorId":{"type":"string"}},"required":["contributorId"],"additionalProperties":false}}}}
```

## The ContributorJobCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorJobCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorJobCreateOneRequest","description":"Request body for creating a new contributor background job. Currently supports only the `deleteContributor` job type, which accepts the target contributor's ID as a parameter.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"type":"object","properties":{"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["deleteContributor"]},"parameters":{"$ref":"#/components/schemas/ContributorDeleteJobParameters"}},"required":["type","parameters"],"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"required":["data"],"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"]},"ContributorDeleteJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorDeleteJobParameters","description":"Parameters for the `deleteContributor` background job. Specifies the unique ID of the contributor to be permanently deleted along with all associated credits.","type":"object","properties":{"contributorId":{"type":"string"}},"required":["contributorId"],"additionalProperties":false}}}}
```

## The ContributorJobAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorJobAttributes","description":"Attributes of a contributor background job. Currently the only supported job type is `deleteContributor`, which asynchronously removes a contributor and all associated credit records. Extends base background job attributes with job type and parameters.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["deleteContributor"]},"parameters":{"type":"object","properties":{"contributorId":{"type":"string","description":"The ID of the contributor being deleted."},"tenantId":{"type":"string","description":"The ID of the tenant that owns the contributor."},"subject":{"type":"string","description":"Human-readable label for the job's target contributor (its name), captured server-side at job creation so the UI can display it even after the contributor is deleted. Purely presentational — not used by job processing."}},"required":["contributorId","tenantId"],"additionalProperties":false}},"required":["type","parameters"],"additionalProperties":false}],"required":["status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]}}}}
```

## The ContributorJobCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorJobCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorJobCreateOneResponse","description":"Response returned after successfully creating a contributor background job. Contains the new job's ID and its initial attributes (status, ARN, type, parameters). Poll the job status using the returned ID.","type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/ContributorJobAttributes"}},"required":["id","attributes"]}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"]},"ContributorJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorJobAttributes","description":"Attributes of a contributor background job. Currently the only supported job type is `deleteContributor`, which asynchronously removes a contributor and all associated credit records. Extends base background job attributes with job type and parameters.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["deleteContributor"]},"parameters":{"type":"object","properties":{"contributorId":{"type":"string","description":"The ID of the contributor being deleted."},"tenantId":{"type":"string","description":"The ID of the tenant that owns the contributor."},"subject":{"type":"string","description":"Human-readable label for the job's target contributor (its name), captured server-side at job creation so the UI can display it even after the contributor is deleted. Purely presentational — not used by job processing."}},"required":["contributorId","tenantId"],"additionalProperties":false}},"required":["type","parameters"],"additionalProperties":false}],"required":["status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreditsListAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAttributes","description":"Attributes of a credits list. A credits list is a named, ordered collection of credit entries for a specific record. `name` is the display name. `ranking` controls ordering when multiple lists exist. `isDefault` identifies the primary credits list for the record.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name for the credit list. For example, `\"Main Credits\"` or `\"International Credits\"`."},"ranking":{"type":"number","description":"Numeric ordering value used to sort credit lists when a record has more than one. Lower values appear first. If omitted, the list is appended after existing lists."},"isDefault":{"type":"boolean","description":"When `true`, this credit list is treated as the primary credits for the record. Only one credit list per record should be designated as the default."}}}}}}
```

## The CreditsListRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationships","description":"JSON:API relationship links for a credits list resource. Contains links to the owning tenant and the record this credits list is associated with.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false}},"required":["tenant","record"],"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},"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}}}}
```

## The CreditsListFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListFindOneResponse","description":"Response returned when retrieving a single credit list by ID. Contains the list's attributes (name, ranking, isDefault) combined with base timestamps (created, updated), plus relationship links to the owning tenant and parent record.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/CreditsListAttributes","required":["name"]}]},"relationships":{"$ref":"#/components/schemas/CreditsListRelationships"}}},"links":{"$ref":"#/components/schemas/LinksRelated"},"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"}}},"CreditsListAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAttributes","description":"Attributes of a credits list. A credits list is a named, ordered collection of credit entries for a specific record. `name` is the display name. `ranking` controls ordering when multiple lists exist. `isDefault` identifies the primary credits list for the record.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name for the credit list. For example, `\"Main Credits\"` or `\"International Credits\"`."},"ranking":{"type":"number","description":"Numeric ordering value used to sort credit lists when a record has more than one. Lower values appear first. If omitted, the list is appended after existing lists."},"isDefault":{"type":"boolean","description":"When `true`, this credit list is treated as the primary credits for the record. Only one credit list per record should be designated as the default."}}},"CreditsListRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationships","description":"JSON:API relationship links for a credits list resource. Contains links to the owning tenant and the record this credits list is associated with.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false}},"required":["tenant","record"],"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},"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}}}}
```

## The CreditsListUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListUpdateOneRequest","description":"Request body for partially updating a credits list. Only the attributes included in the request are modified. Supports updating the list's `name`, `ranking`, and `isDefault` flag.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"type":"object","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["creditsLists"]}}},{"type":"object","required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreditsListAttributes"}}}]}},"required":["data"],"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}}}}},"CreditsListAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAttributes","description":"Attributes of a credits list. A credits list is a named, ordered collection of credit entries for a specific record. `name` is the display name. `ranking` controls ordering when multiple lists exist. `isDefault` identifies the primary credits list for the record.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name for the credit list. For example, `\"Main Credits\"` or `\"International Credits\"`."},"ranking":{"type":"number","description":"Numeric ordering value used to sort credit lists when a record has more than one. Lower values appear first. If omitted, the list is appended after existing lists."},"isDefault":{"type":"boolean","description":"When `true`, this credit list is treated as the primary credits for the record. Only one credit list per record should be designated as the default."}}}}}}
```

## The CreditsListCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListCreateOneResponse","description":"Response returned after successfully creating a credit list. Contains the new resource's ID, type, and relationship links to the owning tenant and parent record. Use the returned ID to fetch the full credit list with its attributes.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]},"relationships":{"additionalProperties":false,"required":["tenant","record"],"properties":{"tenant":{"type":"object","required":["data","links"],"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"additionalProperties":false},"record":{"type":"object","required":["data","links"],"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"additionalProperties":false}}}}},"links":{"$ref":"#/components/schemas/LinksRelated"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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}}}}
```

## The CreditsListUpdateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListUpdateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListUpdateOneResponse","description":"Response returned after successfully updating a credit list. Contains the resource's ID, type, and relationship links to the owning tenant and parent record.","$ref":"#/components/schemas/CreditsListCreateOneResponse"},"CreditsListCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListCreateOneResponse","description":"Response returned after successfully creating a credit list. Contains the new resource's ID, type, and relationship links to the owning tenant and parent record. Use the returned ID to fetch the full credit list with its attributes.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]},"relationships":{"additionalProperties":false,"required":["tenant","record"],"properties":{"tenant":{"type":"object","required":["data","links"],"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"additionalProperties":false},"record":{"type":"object","required":["data","links"],"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"additionalProperties":false}}}}},"links":{"$ref":"#/components/schemas/LinksRelated"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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}}}}
```

## The CreditsListFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListFindManyResponse","description":"Response returned when listing all credit lists for a record. The `data` array contains zero or more credit list resources, each with its name, ranking, and isDefault flag. The `meta.filters` object echoes back the applied `isDefault` filter value. Use `links` for pagination navigation.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/CreditsListAttributes"}]},"relationships":{"$ref":"#/components/schemas/CreditsListRelationships"},"links":{"$ref":"#/components/schemas/LinksRelated"}}}},"meta":{"type":"object","properties":{"filters":{"type":"object","required":["isDefault"],"properties":{"isDefault":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"},"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"}}},"CreditsListAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAttributes","description":"Attributes of a credits list. A credits list is a named, ordered collection of credit entries for a specific record. `name` is the display name. `ranking` controls ordering when multiple lists exist. `isDefault` identifies the primary credits list for the record.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name for the credit list. For example, `\"Main Credits\"` or `\"International Credits\"`."},"ranking":{"type":"number","description":"Numeric ordering value used to sort credit lists when a record has more than one. Lower values appear first. If omitted, the list is appended after existing lists."},"isDefault":{"type":"boolean","description":"When `true`, this credit list is treated as the primary credits for the record. Only one credit list per record should be designated as the default."}}},"CreditsListRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationships","description":"JSON:API relationship links for a credits list resource. Contains links to the owning tenant and the record this credits list is associated with.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false}},"required":["tenant","record"],"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},"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}}}}
```

## The CreditsListCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListCreateOneRequest","description":"Request body for creating a new credit list for a record. Requires a `name` for the list. Optionally provide a client-generated `id` (16 lowercase hex characters) to control the list's identifier; re-sending the same `id` for the same record is rejected as a duplicate rather than creating a second list. Omit it to have the server generate one. Optionally set `ranking` to control sort order among multiple lists, and `isDefault` to designate this as the primary credit list for the record. The record association is determined by the `recordId` path parameter.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"type":"object","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["creditsLists"]},"id":{"type":"string","pattern":"^[a-f0-9]{16}$","description":"Optional client-generated identifier. Must be 16 lowercase hexadecimal characters. When provided, re-sending the same `id` for the same record is rejected as a duplicate. If omitted, the server generates one."}}},{"type":"object","required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/CreditsListAttributes","required":["name"]}]}}}]}},"required":["data"],"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}}}}},"CreditsListAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAttributes","description":"Attributes of a credits list. A credits list is a named, ordered collection of credit entries for a specific record. `name` is the display name. `ranking` controls ordering when multiple lists exist. `isDefault` identifies the primary credits list for the record.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name for the credit list. For example, `\"Main Credits\"` or `\"International Credits\"`."},"ranking":{"type":"number","description":"Numeric ordering value used to sort credit lists when a record has more than one. Lower values appear first. If omitted, the list is appended after existing lists."},"isDefault":{"type":"boolean","description":"When `true`, this credit list is treated as the primary credits for the record. Only one credit list per record should be designated as the default."}}}}}}
```

## The dataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"dataObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false}}}}
```

## The updateRefObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"updateRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"relationship":{"type":"string","enum":["contributors"]}},"required":["id","type","relationship"],"additionalProperties":false}}}}
```

## The updateDataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"updateDataObject":{"description":"The credit to update, as a resource object: `data.id` names it.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","id","attributes","relationships"],"additionalProperties":false}}}}
```

## The removeRefObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"removeRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]}},"required":["id","type"],"additionalProperties":false}}}}
```

## The CreditsListAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListAtomicOperationsRequest","description":"JSON:API Atomic Operations request for managing credits within a credits list. Supports `add` (create a new credit for a contributor), `update` (modify an existing credit's attributes), and `remove` (delete a credit) operations in a single transactional call.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","description":"An ordered list of credit operations to apply atomically. Each operation specifies an `op` code (`add`, `update`, or `remove`) and the relevant data or reference. All operations succeed or fail together — no partial updates are applied.","items":{"type":"object","oneOf":[{"description":"Add a new credit entry to the list. Provide the contributor relationship, job role, and optional ranking and character names.","properties":{"op":{"const":"add"},"data":{"$ref":"#/components/schemas/dataObject"}},"required":["op","data"],"additionalProperties":false},{"description":"Update an existing credit entry, named by `data.id`, with the values in `data`. A `ref` is optional; when sent, it must name the same credit, otherwise the request fails with 409. The credit is never created: if it no longer exists, the request fails with 404.","properties":{"op":{"const":"update"},"ref":{"$ref":"#/components/schemas/updateRefObject"},"data":{"$ref":"#/components/schemas/updateDataObject"}},"required":["op","data"],"additionalProperties":false},{"description":"Remove an existing credit entry from the list. Identify the credit to delete via `ref` using its ID.","properties":{"op":{"const":"remove"},"ref":{"$ref":"#/components/schemas/removeRefObject"}},"required":["op","ref"],"additionalProperties":false}]}}},"required":["atomic:operations"],"additionalProperties":false,"definitions":{"dataObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false},"updateDataObject":{"description":"The credit to update, as a resource object: `data.id` names it.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","id","attributes","relationships"],"additionalProperties":false},"updateRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"relationship":{"type":"string","enum":["contributors"]}},"required":["id","type","relationship"],"additionalProperties":false},"removeRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]}},"required":["id","type"],"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}}}}},"dataObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false},"updateRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"relationship":{"type":"string","enum":["contributors"]}},"required":["id","type","relationship"],"additionalProperties":false},"updateDataObject":{"description":"The credit to update, as a resource object: `data.id` names it.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"type":"object","properties":{"job":{"type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"ranking":{"type":"number","minimum":0},"characters":{"type":"array","items":{"type":"string"}}},"required":["job"],"additionalProperties":false},"relationships":{"type":"object","properties":{"contributor":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["contributors"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["contributor"],"additionalProperties":false}},"required":["type","id","attributes","relationships"],"additionalProperties":false},"removeRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]}},"required":["id","type"],"additionalProperties":false}}}}
```

## The CreditsAttributeJob object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]}}}}
```

## The CreditsAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributes","description":"Attributes of a single credit entry representing a contributor's involvement in a record. `job` is the contributor's role (e.g., Actor, Director). `ranking` is the billing order within the credits list. `characters` lists character names for acting credits.","type":"object","required":["job"],"additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"ranking":{"type":"number","minimum":0,"description":"Billing order of this credit within its job category. Lower values indicate higher prominence (e.g., top-billed Actor). Must be zero or greater."},"characters":{"type":"array","description":"List of character names this contributor portrays in the title. Only relevant for acting credits (e.g., Actor). May be empty for crew roles.","items":{"type":"string","minLength":1}}}},"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]}}}}
```

## The ContributorRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationship","description":"A relationship to a contributor","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}},"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}}}}
```

## The CreditsListRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsListRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationship","description":"A JSON:API relationship reference to a credit list resource. Contains the credit list's `id` and `type` (always `\"creditsLists\"`), plus a `links.related` URL to fetch the full credit list.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]}},"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}}}}
```

## The CreditsRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsRelationships","description":"JSON:API relationship links for a credit resource. Contains links to the owning tenant, the record the credit belongs to, the credits list it appears in, and the contributor being credited.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"contributor":{"$ref":"#/components/schemas/ContributorRelationship"},"creditsList":{"$ref":"#/components/schemas/CreditsListRelationship"}},"required":["tenant","record","contributor","creditsList"],"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},"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},"ContributorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationship","description":"A relationship to a contributor","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"CreditsListRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationship","description":"A JSON:API relationship reference to a credit list resource. Contains the credit list's `id` and `type` (always `\"creditsLists\"`), plus a `links.related` URL to fetch the full credit list.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false}}}}
```

## The Credit object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"Credit":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICredit","description":"A contributor's credit on a record: the job, ranking and, for acting credits, the characters played.","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/CreditsAttributes","required":["job"]}]},"relationships":{"$ref":"#/components/schemas/CreditsRelationships"},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"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"}}},"CreditsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributes","description":"Attributes of a single credit entry representing a contributor's involvement in a record. `job` is the contributor's role (e.g., Actor, Director). `ranking` is the billing order within the credits list. `characters` lists character names for acting credits.","type":"object","required":["job"],"additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"ranking":{"type":"number","minimum":0,"description":"Billing order of this credit within its job category. Lower values indicate higher prominence (e.g., top-billed Actor). Must be zero or greater."},"characters":{"type":"array","description":"List of character names this contributor portrays in the title. Only relevant for acting credits (e.g., Actor). May be empty for crew roles.","items":{"type":"string","minLength":1}}}},"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"CreditsRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsRelationships","description":"JSON:API relationship links for a credit resource. Contains links to the owning tenant, the record the credit belongs to, the credits list it appears in, and the contributor being credited.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"contributor":{"$ref":"#/components/schemas/ContributorRelationship"},"creditsList":{"$ref":"#/components/schemas/CreditsListRelationship"}},"required":["tenant","record","contributor","creditsList"],"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},"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},"ContributorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationship","description":"A relationship to a contributor","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"CreditsListRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationship","description":"A JSON:API relationship reference to a credit list resource. Contains the credit list's `id` and `type` (always `\"creditsLists\"`), plus a `links.related` URL to fetch the full credit list.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false}}}}
```

## The CreditsPageMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsPageMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsPageMeta","type":"object","required":["filters"],"properties":{"cursor":{"type":"string","description":"Opaque cursor value to pass as `page.cursor` in the next request to retrieve the following page of results. Absent when there are no more pages."},"filters":{"type":"object","description":"Pagination and filter state for the current result set.","required":["job"],"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"numberOfItems":{"type":"number","description":"Total number of credits matching the filter, if available."},"perPage":{"type":"number","description":"Maximum number of results returned per page."}},"additionalProperties":false}},"additionalProperties":false},"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]}}}}
```

## The CreditsFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreditsFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsFindManyResponse","description":"Response returned when listing credits for a credit list. The `data` array contains credit entries for the requested job role, each with ranking, character names (for acting credits), and relationship links to the contributor, record, credit list, and tenant. The `meta.filters` object echoes back the applied job filter. Supports cursor-based pagination via `meta.cursor`.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Credit"}},"meta":{"$ref":"#/components/schemas/CreditsPageMeta"},"links":{"$ref":"#/components/schemas/LinksRelated"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Credit":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICredit","description":"A contributor's credit on a record: the job, ranking and, for acting credits, the characters played.","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/CreditsAttributes","required":["job"]}]},"relationships":{"$ref":"#/components/schemas/CreditsRelationships"},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"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"}}},"CreditsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributes","description":"Attributes of a single credit entry representing a contributor's involvement in a record. `job` is the contributor's role (e.g., Actor, Director). `ranking` is the billing order within the credits list. `characters` lists character names for acting credits.","type":"object","required":["job"],"additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"ranking":{"type":"number","minimum":0,"description":"Billing order of this credit within its job category. Lower values indicate higher prominence (e.g., top-billed Actor). Must be zero or greater."},"characters":{"type":"array","description":"List of character names this contributor portrays in the title. Only relevant for acting credits (e.g., Actor). May be empty for crew roles.","items":{"type":"string","minLength":1}}}},"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"CreditsRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsRelationships","description":"JSON:API relationship links for a credit resource. Contains links to the owning tenant, the record the credit belongs to, the credits list it appears in, and the contributor being credited.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"contributor":{"$ref":"#/components/schemas/ContributorRelationship"},"creditsList":{"$ref":"#/components/schemas/CreditsListRelationship"}},"required":["tenant","record","contributor","creditsList"],"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},"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},"ContributorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationship","description":"A relationship to a contributor","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"CreditsListRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationship","description":"A JSON:API relationship reference to a credit list resource. Contains the credit list's `id` and `type` (always `\"creditsLists\"`), plus a `links.related` URL to fetch the full credit list.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"CreditsPageMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsPageMeta","type":"object","required":["filters"],"properties":{"cursor":{"type":"string","description":"Opaque cursor value to pass as `page.cursor` in the next request to retrieve the following page of results. Absent when there are no more pages."},"filters":{"type":"object","description":"Pagination and filter state for the current result set.","required":["job"],"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"numberOfItems":{"type":"number","description":"Total number of credits matching the filter, if available."},"perPage":{"type":"number","description":"Maximum number of results returned per page."}},"additionalProperties":false}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RestrictedCredit object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RestrictedCredit":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRestrictedCredit","description":"A credit you cannot read. Only its id is returned.","type":"object","required":["id","type","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"meta":{"type":"object","required":["restricted"],"additionalProperties":false,"properties":{"restricted":{"type":"boolean","enum":[true],"description":"Always `true`: you cannot read this credit."}}}}}}}}
```

## The ContributorCreditsFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ContributorCreditsFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorCreditsFindManyResponse","description":"One page of a contributor's credits for one job. A credit you cannot read comes back restricted, with only its id.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Credit"},{"$ref":"#/components/schemas/RestrictedCredit"}]}},"meta":{"$ref":"#/components/schemas/CreditsPageMeta"},"links":{"$ref":"#/components/schemas/LinksRelated"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Credit":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICredit","description":"A contributor's credit on a record: the job, ranking and, for acting credits, the characters played.","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/CreditsAttributes","required":["job"]}]},"relationships":{"$ref":"#/components/schemas/CreditsRelationships"},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"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"}}},"CreditsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributes","description":"Attributes of a single credit entry representing a contributor's involvement in a record. `job` is the contributor's role (e.g., Actor, Director). `ranking` is the billing order within the credits list. `characters` lists character names for acting credits.","type":"object","required":["job"],"additionalProperties":false,"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"ranking":{"type":"number","minimum":0,"description":"Billing order of this credit within its job category. Lower values indicate higher prominence (e.g., top-billed Actor). Must be zero or greater."},"characters":{"type":"array","description":"List of character names this contributor portrays in the title. Only relevant for acting credits (e.g., Actor). May be empty for crew roles.","items":{"type":"string","minLength":1}}}},"CreditsAttributeJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsAttributeJob","description":"The role or function a contributor performed in the production of a work. Defines the supported credit job types in Origin Studio.","type":"string","enum":["Actor","Director","Executive Producer","Producer","Creator","Writer","Editor"]},"CreditsRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsRelationships","description":"JSON:API relationship links for a credit resource. Contains links to the owning tenant, the record the credit belongs to, the credits list it appears in, and the contributor being credited.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"contributor":{"$ref":"#/components/schemas/ContributorRelationship"},"creditsList":{"$ref":"#/components/schemas/CreditsListRelationship"}},"required":["tenant","record","contributor","creditsList"],"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},"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},"ContributorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IContributorRelationship","description":"A relationship to a contributor","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["contributors"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"CreditsListRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsListRelationship","description":"A JSON:API relationship reference to a credit list resource. Contains the credit list's `id` and `type` (always `\"creditsLists\"`), plus a `links.related` URL to fetch the full credit list.","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["creditsLists"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"RestrictedCredit":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRestrictedCredit","description":"A credit you cannot read. Only its id is returned.","type":"object","required":["id","type","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["credits"]},"meta":{"type":"object","required":["restricted"],"additionalProperties":false,"properties":{"restricted":{"type":"boolean","enum":[true],"description":"Always `true`: you cannot read this credit."}}}}},"CreditsPageMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreditsPageMeta","type":"object","required":["filters"],"properties":{"cursor":{"type":"string","description":"Opaque cursor value to pass as `page.cursor` in the next request to retrieve the following page of results. Absent when there are no more pages."},"filters":{"type":"object","description":"Pagination and filter state for the current result set.","required":["job"],"properties":{"job":{"$ref":"#/components/schemas/CreditsAttributeJob"},"numberOfItems":{"type":"number","description":"Total number of credits matching the filter, if available."},"perPage":{"type":"number","description":"Maximum number of results returned per page."}},"additionalProperties":false}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryResourceType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryResourceType","description":"JSON:API resource type for data deliveries: always `\"dataDeliveries\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataDeliveries"]}}}}}}
```

## The DataDeliveryAttributesInput object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}}}}}
```

## The DataDeliveryAttributeStatus object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributeStatus","description":"Lifecycle state of a data delivery package.","type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]}}}}
```

## The DataDeliveryState object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryState":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryState","description":"Status of an export or delete job.\n- `PENDING`: ready to start.\n- `RUNNING`: in progress.\n- `PENDING_REDRIVE`: queued for retry.\n- `PARTIALLY_SUCCEEDED`: the export finished, but at least one record had errors.\n\n`SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are terminal.","type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]}}}}
```

## The DataDeliveryAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributes","description":"A data delivery's attributes. The server sets `recordCount`, `status`, `exportJobStatus` and the timestamps. `status` is the package's lifecycle state; `exportJobStatus` is the status of its most recent export job.","allOf":[{"$ref":"#/components/schemas/DataDeliveryAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["recordCount","status","exportJobStatus"],"additionalProperties":false,"properties":{"recordCount":{"type":"number","description":"Number of records in the package."},"status":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"},"exportJobStatus":{"$ref":"#/components/schemas/DataDeliveryState"},"archiveParts":{"type":"array","description":"ZIP archive parts of the exported package, in order.","items":{"type":"object","required":["partNumber","fileName","status"],"additionalProperties":false,"properties":{"partNumber":{"type":"number","description":"One-based archive part number."},"fileName":{"type":"string","description":"Archive file name (for example delivery_package1.zip)."},"status":{"type":"string","enum":["READY","FAILED"],"description":"Part generation status."},"url":{"type":"string","description":"Download URL for `READY` parts."},"expiresAt":{"type":"string","description":"ISO 8601 date-time when the archive expires (7 days after export)."},"error":{"type":"string","description":"Failure reason for `FAILED` parts."},"format":{"type":"string","enum":["csv","json"],"description":"Format of the record metadata in this archive. An export produces one archive per requested format and tags it, even when it requests only one. Absent on manifest archives and some older archives."}}}}}}]},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}},"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"}}},"DataDeliveryAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributeStatus","description":"Lifecycle state of a data delivery package.","type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]},"DataDeliveryState":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryState","description":"Status of an export or delete job.\n- `PENDING`: ready to start.\n- `RUNNING`: in progress.\n- `PENDING_REDRIVE`: queued for retry.\n- `PARTIALLY_SUCCEEDED`: the export finished, but at least one record had errors.\n\n`SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are terminal.","type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]}}}}
```

## The data object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The DataDeliveryRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRelationships","description":"Links to the data delivery's tenant and to the records in the package.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"records":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":[],"additionalProperties":false},"author":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"required":["tenant","records","author"],"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},"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},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The DataDeliveryFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryFindManyResponse","description":"A list of data deliveries.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DataDeliveryResourceType"},{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/DataDeliveryAttributes"},"relationships":{"$ref":"#/components/schemas/DataDeliveryRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"next":{"type":["string","null"]}},"additionalProperties":false},"meta":{"type":"object","properties":{"cursor":{"type":"string"},"filters":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"},"exportJobStatus":{"$ref":"#/components/schemas/DataDeliveryState"},"createdAfter":{"type":"string","format":"date-time"},"createdBefore":{"type":"string","format":"date-time"}},"additionalProperties":false}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataDeliveryResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryResourceType","description":"JSON:API resource type for data deliveries: always `\"dataDeliveries\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataDeliveries"]}}},"DataDeliveryAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributes","description":"A data delivery's attributes. The server sets `recordCount`, `status`, `exportJobStatus` and the timestamps. `status` is the package's lifecycle state; `exportJobStatus` is the status of its most recent export job.","allOf":[{"$ref":"#/components/schemas/DataDeliveryAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["recordCount","status","exportJobStatus"],"additionalProperties":false,"properties":{"recordCount":{"type":"number","description":"Number of records in the package."},"status":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"},"exportJobStatus":{"$ref":"#/components/schemas/DataDeliveryState"},"archiveParts":{"type":"array","description":"ZIP archive parts of the exported package, in order.","items":{"type":"object","required":["partNumber","fileName","status"],"additionalProperties":false,"properties":{"partNumber":{"type":"number","description":"One-based archive part number."},"fileName":{"type":"string","description":"Archive file name (for example delivery_package1.zip)."},"status":{"type":"string","enum":["READY","FAILED"],"description":"Part generation status."},"url":{"type":"string","description":"Download URL for `READY` parts."},"expiresAt":{"type":"string","description":"ISO 8601 date-time when the archive expires (7 days after export)."},"error":{"type":"string","description":"Failure reason for `FAILED` parts."},"format":{"type":"string","enum":["csv","json"],"description":"Format of the record metadata in this archive. An export produces one archive per requested format and tags it, even when it requests only one. Absent on manifest archives and some older archives."}}}}}}]},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}},"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"}}},"DataDeliveryAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributeStatus","description":"Lifecycle state of a data delivery package.","type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]},"DataDeliveryState":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryState","description":"Status of an export or delete job.\n- `PENDING`: ready to start.\n- `RUNNING`: in progress.\n- `PENDING_REDRIVE`: queued for retry.\n- `PARTIALLY_SUCCEEDED`: the export finished, but at least one record had errors.\n\n`SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are terminal.","type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]},"DataDeliveryRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRelationships","description":"Links to the data delivery's tenant and to the records in the package.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"records":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":[],"additionalProperties":false},"author":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"required":["tenant","records","author"],"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},"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},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryRecordIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryRecordIdentifier":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRecordIdentifier","description":"A record in a data delivery package, with optional per-record details in meta.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"meta":{"type":"object","properties":{"alternateRunningOrderId":{"type":"string","description":"The alternate running order used for this record in the package. Absent when none is set."}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false}}}}
```

## The DataDeliveryCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryCreateOneRequest","description":"Creates a data delivery package. Links up to 99 records in the same all-or-nothing write. Add more later through the relationship endpoints: 99 per request, at most 50000 per package.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataDeliveries"]},"attributes":{"$ref":"#/components/schemas/DataDeliveryAttributesInput"},"relationships":{"type":"object","additionalProperties":false,"properties":{"records":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DataDeliveryRecordIdentifier"},"minItems":1,"maxItems":99}}}}}}}},"required":["data"],"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}}}}},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}},"DataDeliveryRecordIdentifier":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRecordIdentifier","description":"A record in a data delivery package, with optional per-record details in meta.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"meta":{"type":"object","properties":{"alternateRunningOrderId":{"type":"string","description":"The alternate running order used for this record in the package. Absent when none is set."}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false}}}}
```

## The DataDeliveryCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryCreateOneResponse","description":"The data delivery the request created.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/DataDeliveryResourceType"},{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/DataDeliveryAttributes"},"relationships":{"$ref":"#/components/schemas/DataDeliveryRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataDeliveryResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryResourceType","description":"JSON:API resource type for data deliveries: always `\"dataDeliveries\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataDeliveries"]}}},"DataDeliveryAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributes","description":"A data delivery's attributes. The server sets `recordCount`, `status`, `exportJobStatus` and the timestamps. `status` is the package's lifecycle state; `exportJobStatus` is the status of its most recent export job.","allOf":[{"$ref":"#/components/schemas/DataDeliveryAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["recordCount","status","exportJobStatus"],"additionalProperties":false,"properties":{"recordCount":{"type":"number","description":"Number of records in the package."},"status":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"},"exportJobStatus":{"$ref":"#/components/schemas/DataDeliveryState"},"archiveParts":{"type":"array","description":"ZIP archive parts of the exported package, in order.","items":{"type":"object","required":["partNumber","fileName","status"],"additionalProperties":false,"properties":{"partNumber":{"type":"number","description":"One-based archive part number."},"fileName":{"type":"string","description":"Archive file name (for example delivery_package1.zip)."},"status":{"type":"string","enum":["READY","FAILED"],"description":"Part generation status."},"url":{"type":"string","description":"Download URL for `READY` parts."},"expiresAt":{"type":"string","description":"ISO 8601 date-time when the archive expires (7 days after export)."},"error":{"type":"string","description":"Failure reason for `FAILED` parts."},"format":{"type":"string","enum":["csv","json"],"description":"Format of the record metadata in this archive. An export produces one archive per requested format and tags it, even when it requests only one. Absent on manifest archives and some older archives."}}}}}}]},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}},"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"}}},"DataDeliveryAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributeStatus","description":"Lifecycle state of a data delivery package.","type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]},"DataDeliveryState":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryState","description":"Status of an export or delete job.\n- `PENDING`: ready to start.\n- `RUNNING`: in progress.\n- `PENDING_REDRIVE`: queued for retry.\n- `PARTIALLY_SUCCEEDED`: the export finished, but at least one record had errors.\n\n`SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are terminal.","type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]},"DataDeliveryRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRelationships","description":"Links to the data delivery's tenant and to the records in the package.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"records":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":[],"additionalProperties":false},"author":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"required":["tenant","records","author"],"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},"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},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryFindOneResponse","description":"A single data delivery.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/DataDeliveryResourceType"},{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/DataDeliveryAttributes"},"relationships":{"$ref":"#/components/schemas/DataDeliveryRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataDeliveryResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryResourceType","description":"JSON:API resource type for data deliveries: always `\"dataDeliveries\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataDeliveries"]}}},"DataDeliveryAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributes","description":"A data delivery's attributes. The server sets `recordCount`, `status`, `exportJobStatus` and the timestamps. `status` is the package's lifecycle state; `exportJobStatus` is the status of its most recent export job.","allOf":[{"$ref":"#/components/schemas/DataDeliveryAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["recordCount","status","exportJobStatus"],"additionalProperties":false,"properties":{"recordCount":{"type":"number","description":"Number of records in the package."},"status":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"},"exportJobStatus":{"$ref":"#/components/schemas/DataDeliveryState"},"archiveParts":{"type":"array","description":"ZIP archive parts of the exported package, in order.","items":{"type":"object","required":["partNumber","fileName","status"],"additionalProperties":false,"properties":{"partNumber":{"type":"number","description":"One-based archive part number."},"fileName":{"type":"string","description":"Archive file name (for example delivery_package1.zip)."},"status":{"type":"string","enum":["READY","FAILED"],"description":"Part generation status."},"url":{"type":"string","description":"Download URL for `READY` parts."},"expiresAt":{"type":"string","description":"ISO 8601 date-time when the archive expires (7 days after export)."},"error":{"type":"string","description":"Failure reason for `FAILED` parts."},"format":{"type":"string","enum":["csv","json"],"description":"Format of the record metadata in this archive. An export produces one archive per requested format and tags it, even when it requests only one. Absent on manifest archives and some older archives."}}}}}}]},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}},"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"}}},"DataDeliveryAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributeStatus","description":"Lifecycle state of a data delivery package.","type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]},"DataDeliveryState":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryState","description":"Status of an export or delete job.\n- `PENDING`: ready to start.\n- `RUNNING`: in progress.\n- `PENDING_REDRIVE`: queued for retry.\n- `PARTIALLY_SUCCEEDED`: the export finished, but at least one record had errors.\n\n`SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are terminal.","type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]},"DataDeliveryRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRelationships","description":"Links to the data delivery's tenant and to the records in the package.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"records":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":[],"additionalProperties":false},"author":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"required":["tenant","records","author"],"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},"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},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryUpdateOneRequest","description":"Updates a data delivery. You can change only its `name`. `data.id` must match the `dataDeliveryId` path parameter.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/DataDeliveryResourceType"},{"type":"object","required":["attributes"],"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/DataDeliveryAttributesInput"}}}]}},"required":["data"],"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}}}}},"DataDeliveryResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryResourceType","description":"JSON:API resource type for data deliveries: always `\"dataDeliveries\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataDeliveries"]}}},"DataDeliveryAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAttributesInput","description":"Data delivery attributes you can set. Only `name` is editable.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","maxLength":250,"description":"Name of the delivery package."}}}}}}
```

## The DataDeliveryFindRecordsRelationshipResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryFindRecordsRelationshipResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryFindRecordsRelationshipResponse","description":"The records in a data delivery package, as resource identifiers.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","description":"One resource identifier per record in the package.","items":{"$ref":"#/components/schemas/DataDeliveryRecordIdentifier"}},"links":{"type":"object","description":"JSON:API links","properties":{"self":{"type":"string","description":"Link to this relationship"}},"additionalProperties":false},"meta":{"type":"object","description":"Extra details, such as the total count.","properties":{"total":{"type":"integer","minimum":0,"description":"Total number of records in the package."}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataDeliveryRecordIdentifier":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRecordIdentifier","description":"A record in a data delivery package, with optional per-record details in meta.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"meta":{"type":"object","properties":{"alternateRunningOrderId":{"type":"string","description":"The alternate running order used for this record in the package. Absent when none is set."}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryAddRecordsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryAddRecordsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAddRecordsRelationshipRequest","description":"Links records to a data delivery package. Up to 99 records per request. The server updates the links and the package record count in one all-or-nothing write.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DataDeliveryRecordIdentifier"},"minItems":1,"maxItems":99}},"required":["data"],"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}}}}},"DataDeliveryRecordIdentifier":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRecordIdentifier","description":"A record in a data delivery package, with optional per-record details in meta.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"meta":{"type":"object","properties":{"alternateRunningOrderId":{"type":"string","description":"The alternate running order used for this record in the package. Absent when none is set."}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false}}}}
```

## The DataDeliveryAddRecordsRelationshipResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryAddRecordsRelationshipResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryAddRecordsRelationshipResponse","description":"Meta-only response to linking records: how many records the request linked and how many were already in the package.","type":"object","additionalProperties":false,"required":["meta","jsonapi"],"properties":{"meta":{"type":"object","additionalProperties":false,"required":["requestedCount","addedCount","skippedCount"],"properties":{"requestedCount":{"type":"integer","minimum":1,"description":"Number of records in the request."},"addedCount":{"type":"integer","minimum":0,"description":"Number of records the request linked."},"skippedCount":{"type":"integer","minimum":0,"description":"Number of requested records already in the package. The request skips them."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataDeliveryRemoveRecordsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryRemoveRecordsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRemoveRecordsRelationshipRequest","description":"Unlinks records from a data delivery package.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/data"},"minItems":1}},"required":["data"],"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}}}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The DataDeliveryExportJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryExportJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobParameters","description":"Parameters for a data delivery export job.\n- `dataDeliveryId`: the delivery to export.\n- `exportOptions`: what to export, any of `metadata` (record fields), `contributors` (cast and crew), `images` (poster and photo assets) and `files` (associated documents and media files).\n- `outputFormats`: formats for the record metadata: `json` (one JSON document per record) and `csv` (one flat CSV you can re-import through bulk update). The export produces one archive per format. Defaults to `[\"json\"]`.","type":"object","properties":{"dataDeliveryId":{"type":"string"},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["dataDeliveryId"],"additionalProperties":false}}}}
```

## The DataDeliveryExportSelectionJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryExportSelectionJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportSelectionJobParameters","description":"Parameters for an `exportRecordSelection` job: builds a delivery package from a Studio Library selection and exports it in one call. Takes no `dataDeliveryId`. The server creates the package, resolves `selection` to records, links them and exports the package. `exportOptions` and `outputFormats` work as on `exportDataDelivery`.","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Name of the delivery package the job creates."},"selection":{"type":"object","description":"The Studio Library selection to export.\n- With `searchGroup`: every record that matches it, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without `searchGroup`: only `includeRecordIds`.\n\nThe job skips records the requesting user can't read.","properties":{"searchGroup":{"type":"object","description":"Boolean Library search query tree, for an all-in-view or hierarchy selection. Omit it when you pick every record by hand. The server validates it when the job runs.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Records selected by hand, added to the `searchGroup` matches. At most 1000; `searchGroup` has no such limit."},"excludeRecordIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Records to drop from the selection. At most 1000."}},"required":[],"additionalProperties":false},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["name","selection"],"additionalProperties":false}}}}
```

## The DataDeliveryExportJobCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryExportJobCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobCreateOneRequest","description":"Starts a data delivery background job. `type` sets the shape of `parameters`.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"type":"object","properties":{"attributes":{"type":"object","properties":{"type":{"type":"string","description":"The job to run. Each type takes its own `parameters`:\n- `exportDataDelivery`: packages and exports an existing delivery. Takes its `dataDeliveryId`.\n- `deleteDataDelivery`: permanently deletes an existing delivery. Takes its `dataDeliveryId`.\n- `exportRecordSelection`: creates a package from a Studio Library selection and exports it in one call. Takes a `name` and a `selection`.","enum":["exportDataDelivery","deleteDataDelivery","exportRecordSelection"]},"parameters":{"description":"Job parameters. Their shape depends on `type`.","oneOf":[{"$ref":"#/components/schemas/DataDeliveryExportJobParameters"},{"$ref":"#/components/schemas/DataDeliveryExportSelectionJobParameters"}]}},"required":["type","parameters"],"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"required":["data"],"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"]},"DataDeliveryExportJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobParameters","description":"Parameters for a data delivery export job.\n- `dataDeliveryId`: the delivery to export.\n- `exportOptions`: what to export, any of `metadata` (record fields), `contributors` (cast and crew), `images` (poster and photo assets) and `files` (associated documents and media files).\n- `outputFormats`: formats for the record metadata: `json` (one JSON document per record) and `csv` (one flat CSV you can re-import through bulk update). The export produces one archive per format. Defaults to `[\"json\"]`.","type":"object","properties":{"dataDeliveryId":{"type":"string"},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["dataDeliveryId"],"additionalProperties":false},"DataDeliveryExportSelectionJobParameters":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportSelectionJobParameters","description":"Parameters for an `exportRecordSelection` job: builds a delivery package from a Studio Library selection and exports it in one call. Takes no `dataDeliveryId`. The server creates the package, resolves `selection` to records, links them and exports the package. `exportOptions` and `outputFormats` work as on `exportDataDelivery`.","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Name of the delivery package the job creates."},"selection":{"type":"object","description":"The Studio Library selection to export.\n- With `searchGroup`: every record that matches it, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without `searchGroup`: only `includeRecordIds`.\n\nThe job skips records the requesting user can't read.","properties":{"searchGroup":{"type":"object","description":"Boolean Library search query tree, for an all-in-view or hierarchy selection. Omit it when you pick every record by hand. The server validates it when the job runs.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Records selected by hand, added to the `searchGroup` matches. At most 1000; `searchGroup` has no such limit."},"excludeRecordIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Records to drop from the selection. At most 1000."}},"required":[],"additionalProperties":false},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["name","selection"],"additionalProperties":false}}}}
```

## The DataDeliveryExportJobAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryExportJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobAttributes","description":"Attributes of a data delivery background job. Job types:\n- `exportDataDelivery`: packages and exports every record in the delivery.\n- `deleteDataDelivery`: permanently deletes the delivery and its associated data.\n- `exportRecordSelection`: creates a package from a Studio Library selection and exports it.\n\nEach job reports progress against the `dataDeliveryId` it acts on. For `exportRecordSelection`, that is the package the job created.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["exportDataDelivery","deleteDataDelivery","exportRecordSelection"]},"parameters":{"type":"object","properties":{"dataDeliveryId":{"type":"string"},"tenantId":{"type":"string"},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["dataDeliveryId","tenantId"],"additionalProperties":false}},"required":["type","parameters"],"additionalProperties":false}],"required":["status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]}}}}
```

## The DataDeliveryExportJobCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryExportJobCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobCreateOneResponse","description":"The job the request started, with its ID and initial status. Track progress with `GET /backgroundJobs/{jobId}`.","type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/DataDeliveryExportJobAttributes"}},"required":["id","attributes"]}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"]},"DataDeliveryExportJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryExportJobAttributes","description":"Attributes of a data delivery background job. Job types:\n- `exportDataDelivery`: packages and exports every record in the delivery.\n- `deleteDataDelivery`: permanently deletes the delivery and its associated data.\n- `exportRecordSelection`: creates a package from a Studio Library selection and exports it.\n\nEach job reports progress against the `dataDeliveryId` it acts on. For `exportRecordSelection`, that is the package the job created.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["exportDataDelivery","deleteDataDelivery","exportRecordSelection"]},"parameters":{"type":"object","properties":{"dataDeliveryId":{"type":"string"},"tenantId":{"type":"string"},"exportOptions":{"type":"array","items":{"type":"string","enum":["metadata","contributors","images","files"]}},"outputFormats":{"type":"array","items":{"type":"string","enum":["json","csv"]}}},"required":["dataDeliveryId","tenantId"],"additionalProperties":false}},"required":["type","parameters"],"additionalProperties":false}],"required":["status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The AlternateRunningOrderAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}}}}}
```

## The RecordRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The AlternateRunningOrderRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The AlternateRunningOrder object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrder":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrder","description":"An Alternate Running Order: a re-sequencing of a record's direct Episode children for distribution. It never changes an Episode's `sequenceNumber`, `parentId` or `path`. The canonical order (the Master) has no resource: it is the Episodes sorted by `sequenceNumber`.","type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"$ref":"#/components/schemas/AlternateRunningOrderAttributes"},"relationships":{"$ref":"#/components/schemas/AlternateRunningOrderRelationships"}}},"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}},"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The DataDeliveryRecordLinkageFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataDeliveryRecordLinkageFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataDeliveryRecordLinkageFindManyResponse","description":"Links between delivery packages and records. Each linkage joins one package to one record and can name the alternate running order the package uses for that record. A linkage has relationships and no attributes. The list holds at most `page.size` entries and reports no total.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","description":"One entry per linkage, up to the page size. An empty array means nothing under the requested path belongs to a delivery package.","items":{"type":"object","required":["type","id","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataDeliveryRecordLinkages"]},"id":{"type":"string","description":"The linkage's own identifier."},"relationships":{"type":"object","description":"The delivery package and the record this linkage joins, plus the record's alternate running order when it has one.","required":["dataDelivery","record"],"additionalProperties":false,"properties":{"dataDelivery":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataDeliveries"]},"id":{"type":"string"}}}}},"record":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}}}}},"alternateRunningOrder":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["alternateRunningOrders"]},"id":{"type":"string"}}},"meta":{"type":"object","description":"Present only with `include=alternateRunningOrder` and only while the running order exists. Appears even when you can't read the running order; `included` lists only the running orders you can read.","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The running order's current name."},"position":{"type":"integer","minimum":1,"description":"The record's current 1-based position in the running order. Absent when the record is no longer part of it."}}}}}}}}}},"included":{"type":"array","description":"Present only with `include=alternateRunningOrder`: each linked alternate running order you can read, listed once.","items":{"$ref":"#/components/schemas/AlternateRunningOrder"}},"links":{"type":"object","description":"JSON:API links","additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this collection, with its filter."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"AlternateRunningOrder":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrder","description":"An Alternate Running Order: a re-sequencing of a record's direct Episode children for distribution. It never changes an Episode's `sequenceNumber`, `parentId` or `path`. The canonical order (the Master) has no resource: it is the Episodes sorted by `sequenceNumber`.","type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"$ref":"#/components/schemas/AlternateRunningOrderAttributes"},"relationships":{"$ref":"#/components/schemas/AlternateRunningOrderRelationships"}}},"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}},"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The DataIngressAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressAttributes","description":"Attributes for a data ingress execution","type":"object","additionalProperties":false,"required":["status","sourceAdapterType","totalItems","successCount","failedCount"],"properties":{"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"],"description":"Current status of the ingress execution"},"name":{"type":"string","description":"Optional name for the data ingress execution, useful for identification and tracking purposes"},"sourceAdapterType":{"type":"string","description":"Identifier of the source adapter used (e.g., 'origin-studio-api', 'generic-file')"},"payload":{"type":"object","description":"Adapter-specific configuration payload","additionalProperties":true},"totalItems":{"type":"integer","description":"Total number of items identified for import"},"successCount":{"type":"integer","description":"Number of items successfully imported"},"failedCount":{"type":"integer","description":"Number of items that failed to import"},"backgroundJobId":{"type":"string","description":"ID of the background job tracking this data ingress execution. Use it to retrieve the execution's error archive via GET /backgroundJobs/{jobId}/errors."},"output":{"type":"object","description":"Output data including errors and results","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the per-row error files."}},"additionalProperties":true},"completedAt":{"type":"string","format":"date-time","description":"Timestamp when the execution completed"},"created":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}}}}}
```

## The DataIngressFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressFindManyResponse","description":"Response for listing data ingress executions","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Data ingress execution ID"},"type":{"type":"string","enum":["dataIngress"]},"attributes":{"$ref":"#/components/schemas/DataIngressAttributes"}}}},"meta":{"type":"object","additionalProperties":false,"properties":{"cursor":{"type":"string","description":"Cursor for pagination"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataIngressAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressAttributes","description":"Attributes for a data ingress execution","type":"object","additionalProperties":false,"required":["status","sourceAdapterType","totalItems","successCount","failedCount"],"properties":{"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"],"description":"Current status of the ingress execution"},"name":{"type":"string","description":"Optional name for the data ingress execution, useful for identification and tracking purposes"},"sourceAdapterType":{"type":"string","description":"Identifier of the source adapter used (e.g., 'origin-studio-api', 'generic-file')"},"payload":{"type":"object","description":"Adapter-specific configuration payload","additionalProperties":true},"totalItems":{"type":"integer","description":"Total number of items identified for import"},"successCount":{"type":"integer","description":"Number of items successfully imported"},"failedCount":{"type":"integer","description":"Number of items that failed to import"},"backgroundJobId":{"type":"string","description":"ID of the background job tracking this data ingress execution. Use it to retrieve the execution's error archive via GET /backgroundJobs/{jobId}/errors."},"output":{"type":"object","description":"Output data including errors and results","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the per-row error files."}},"additionalProperties":true},"completedAt":{"type":"string","format":"date-time","description":"Timestamp when the execution completed"},"created":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataIngressCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressCreateOneRequest","description":"Request body for creating a new data ingress execution","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngress"]},"attributes":{"type":"object","required":["sourceAdapterType","importType","payload"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Optional name for the data ingress execution, useful for identification and tracking purposes"},"sourceAdapterType":{"type":"string","description":"Identifier of the source adapter to use (e.g., 'origin-studio-api', 'generic-file')"},"importType":{"type":"string","enum":["file","api"],"description":"Determines the import strategy: 'file' reads items from an S3 file (CSV/JSON/JSONL) using ItemReader, 'api' paginates through an external API in a loop"},"importFileType":{"type":"string","enum":["csv","json","jsonl"],"description":"Specifies the file format when 'importType' is 'file'. Required if 'importType' is 'file', ignored otherwise."},"payload":{"type":"object","description":"Adapter-specific configuration payload","additionalProperties":true}}}}}}},"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}}}}}}}}
```

## The DataIngressCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressCreateOneResponse","description":"Response for creating a new data ingress execution","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Data ingress execution ID"},"type":{"type":"string","enum":["dataIngress"]},"attributes":{"$ref":"#/components/schemas/DataIngressAttributes"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataIngressAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressAttributes","description":"Attributes for a data ingress execution","type":"object","additionalProperties":false,"required":["status","sourceAdapterType","totalItems","successCount","failedCount"],"properties":{"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"],"description":"Current status of the ingress execution"},"name":{"type":"string","description":"Optional name for the data ingress execution, useful for identification and tracking purposes"},"sourceAdapterType":{"type":"string","description":"Identifier of the source adapter used (e.g., 'origin-studio-api', 'generic-file')"},"payload":{"type":"object","description":"Adapter-specific configuration payload","additionalProperties":true},"totalItems":{"type":"integer","description":"Total number of items identified for import"},"successCount":{"type":"integer","description":"Number of items successfully imported"},"failedCount":{"type":"integer","description":"Number of items that failed to import"},"backgroundJobId":{"type":"string","description":"ID of the background job tracking this data ingress execution. Use it to retrieve the execution's error archive via GET /backgroundJobs/{jobId}/errors."},"output":{"type":"object","description":"Output data including errors and results","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the per-row error files."}},"additionalProperties":true},"completedAt":{"type":"string","format":"date-time","description":"Timestamp when the execution completed"},"created":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataIngressFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressFindOneResponse","description":"Response for getting a single data ingress execution","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Data ingress execution ID"},"type":{"type":"string","enum":["dataIngress"]},"attributes":{"$ref":"#/components/schemas/DataIngressAttributes"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataIngressAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressAttributes","description":"Attributes for a data ingress execution","type":"object","additionalProperties":false,"required":["status","sourceAdapterType","totalItems","successCount","failedCount"],"properties":{"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"],"description":"Current status of the ingress execution"},"name":{"type":"string","description":"Optional name for the data ingress execution, useful for identification and tracking purposes"},"sourceAdapterType":{"type":"string","description":"Identifier of the source adapter used (e.g., 'origin-studio-api', 'generic-file')"},"payload":{"type":"object","description":"Adapter-specific configuration payload","additionalProperties":true},"totalItems":{"type":"integer","description":"Total number of items identified for import"},"successCount":{"type":"integer","description":"Number of items successfully imported"},"failedCount":{"type":"integer","description":"Number of items that failed to import"},"backgroundJobId":{"type":"string","description":"ID of the background job tracking this data ingress execution. Use it to retrieve the execution's error archive via GET /backgroundJobs/{jobId}/errors."},"output":{"type":"object","description":"Output data including errors and results","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the per-row error files."}},"additionalProperties":true},"completedAt":{"type":"string","format":"date-time","description":"Timestamp when the execution completed"},"created":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataIngressGetUploadUrlRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressGetUploadUrlRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressGetUploadUrlRequest","description":"Request body for generating a presigned S3 upload URL for data ingress file imports","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngress"]},"attributes":{"type":"object","required":["fileName"],"additionalProperties":false,"properties":{"fileName":{"type":"string","description":"Name of the file to upload"},"contentType":{"type":"string","description":"MIME content type of the file (e.g., 'text/csv', 'application/json')","nullable":true}}}}}}},"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}}}}}}}}
```

## The DataIngressGetUploadUrlResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressGetUploadUrlResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressGetUploadUrlResponse","description":"Response containing a presigned S3 URL for uploading a data ingress file","type":"object","required":["data","jsonapi"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngressUploadUrl"]},"attributes":{"type":"object","required":["url","key","expiresInSeconds"],"additionalProperties":false,"properties":{"url":{"type":"string","description":"Presigned S3 URL for uploading the file via HTTP PUT"},"key":{"type":"string","description":"S3 object key where the file will be stored"},"expiresInSeconds":{"type":"integer","description":"Number of seconds until the presigned URL expires"}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataIngressGetDownloadUrlRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressGetDownloadUrlRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressGetDownloadUrlRequest","description":"Request body for generating a presigned S3 download URL for a data ingress file","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngress"]},"attributes":{"type":"object","required":["fileName"],"additionalProperties":false,"properties":{"fileName":{"type":"string","description":"Name of the file to download"}}}}}}},"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}}}}}}}}
```

## The DataIngressGetDownloadUrlResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressGetDownloadUrlResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressGetDownloadUrlResponse","description":"Response containing a presigned S3 URL for downloading a data ingress file","type":"object","required":["data","jsonapi"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngressDownloadUrl"]},"attributes":{"type":"object","required":["url","key","expiresInSeconds"],"additionalProperties":false,"properties":{"url":{"type":"string","description":"Presigned S3 URL for downloading the file via HTTP GET"},"key":{"type":"string","description":"S3 object key of the file"},"expiresInSeconds":{"type":"integer","description":"Number of seconds until the presigned URL expires"}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataIngressScanColumnsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressScanColumnsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressScanColumnsRequest","description":"Request body for scanning an uploaded file to discover column names and unique categorical values","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngress"]},"attributes":{"type":"object","required":["fileName"],"additionalProperties":false,"properties":{"fileName":{"type":"string","minLength":1,"description":"File name only, without any path prefix. Must match the file name used when obtaining the upload URL."}}}}}}},"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}}}}}}}}
```

## The DataIngressScanColumnsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataIngressScanColumnsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataIngressScanColumnsResponse","description":"Response from scanning an uploaded file for column names and unique categorical values","type":"object","required":["data","jsonapi"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataIngressScanColumns"]},"attributes":{"type":"object","required":["ok"],"additionalProperties":false,"properties":{"ok":{"type":"boolean","description":"Whether the scan succeeded"},"fileType":{"type":"string","enum":["csv","json","jsonl"],"description":"Format of the uploaded file"},"columns":{"type":"array","items":{"type":"string"},"description":"All column names found in the file header (CSV first row or JSON object keys)"},"uniqueValues":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Map of column name to sorted array of unique values found in that column"},"error":{"type":"string","description":"Error message when ok is false"}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataWarehouseSettingsAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSettingsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsAttributes","description":"Your data export settings","type":"object","additionalProperties":false,"required":["credentialType","format","schedule"],"properties":{"credentialType":{"type":"string","enum":["iam-role","access-key"],"description":"How your exported data is accessed in the storage bucket"},"iamRoleArn":{"type":["string","null"],"description":"The AWS IAM role allowed to read your exported data from the storage bucket. Used when credentialType is 'iam-role'. Removing it turns off exports."},"accessKeyId":{"type":["string","null"],"description":"The access key ID, shown when credentialType is 'access-key'. The matching secret is never shown here."},"format":{"type":"string","enum":["parquet","csv"],"description":"The file format for your exported data"},"schedule":{"type":"string","enum":["once-a-day","twice-a-day"],"description":"How often your data is exported"},"exportLocation":{"type":["string","null"],"description":"The S3 URI your exported data is written to, e.g. s3://your-export-bucket/. Null when this deployment has no export storage configured."},"lastExportDate":{"type":["string","null"],"format":"date-time","description":"When your data was most recently exported"},"lastExportStatus":{"type":["string","null"],"enum":["success","failure",null],"description":"Whether the most recent export succeeded or failed"},"created":{"type":"string","format":"date-time","description":"When these settings were created"},"updated":{"type":"string","format":"date-time","description":"When these settings were last updated"}}}}}}
```

## The DataWarehouseSettingsFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSettingsFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsFindManyResponse","description":"Your data export settings. Exports can only be set up once, so this contains at most one item.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The export settings ID"},"type":{"type":"string","enum":["dataWarehouseSettings"]},"attributes":{"$ref":"#/components/schemas/DataWarehouseSettingsAttributes"}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataWarehouseSettingsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsAttributes","description":"Your data export settings","type":"object","additionalProperties":false,"required":["credentialType","format","schedule"],"properties":{"credentialType":{"type":"string","enum":["iam-role","access-key"],"description":"How your exported data is accessed in the storage bucket"},"iamRoleArn":{"type":["string","null"],"description":"The AWS IAM role allowed to read your exported data from the storage bucket. Used when credentialType is 'iam-role'. Removing it turns off exports."},"accessKeyId":{"type":["string","null"],"description":"The access key ID, shown when credentialType is 'access-key'. The matching secret is never shown here."},"format":{"type":"string","enum":["parquet","csv"],"description":"The file format for your exported data"},"schedule":{"type":"string","enum":["once-a-day","twice-a-day"],"description":"How often your data is exported"},"exportLocation":{"type":["string","null"],"description":"The S3 URI your exported data is written to, e.g. s3://your-export-bucket/. Null when this deployment has no export storage configured."},"lastExportDate":{"type":["string","null"],"format":"date-time","description":"When your data was most recently exported"},"lastExportStatus":{"type":["string","null"],"enum":["success","failure",null],"description":"Whether the most recent export succeeded or failed"},"created":{"type":"string","format":"date-time","description":"When these settings were created"},"updated":{"type":"string","format":"date-time","description":"When these settings were last updated"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataWarehouseSettingsCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSettingsCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsCreateOneRequest","description":"Request body for turning on data exports","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["dataWarehouseSettings"]},"attributes":{"type":"object","required":["credentialType"],"additionalProperties":false,"properties":{"credentialType":{"type":"string","enum":["iam-role","access-key"]},"iamRoleArn":{"type":"string","description":"The AWS IAM role allowed to read your exported data. Required when credentialType is 'iam-role'."},"format":{"type":"string","enum":["parquet","csv"]},"schedule":{"type":"string","enum":["once-a-day","twice-a-day"],"description":"How often your data is exported. Defaults to once-a-day when omitted."}}}}}}},"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}}}}}}}}
```

## The DataWarehouseSettingsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSettingsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsResponse","description":"Your data export settings","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The export settings ID"},"type":{"type":"string","enum":["dataWarehouseSettings"]},"attributes":{"$ref":"#/components/schemas/DataWarehouseSettingsAttributes"}}},"meta":{"type":"object","additionalProperties":false,"description":"Included only when a new access key was issued by this request (turning on exports with credentialType 'access-key', or switching to it). The secret is shown once and never stored, so save it securely.","properties":{"accessKeyId":{"type":"string","description":"The access key ID for reading your exported data"},"accessKeySecret":{"type":"string","description":"The secret for your access key. Shown once and never stored or shown again, so save it securely."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"DataWarehouseSettingsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsAttributes","description":"Your data export settings","type":"object","additionalProperties":false,"required":["credentialType","format","schedule"],"properties":{"credentialType":{"type":"string","enum":["iam-role","access-key"],"description":"How your exported data is accessed in the storage bucket"},"iamRoleArn":{"type":["string","null"],"description":"The AWS IAM role allowed to read your exported data from the storage bucket. Used when credentialType is 'iam-role'. Removing it turns off exports."},"accessKeyId":{"type":["string","null"],"description":"The access key ID, shown when credentialType is 'access-key'. The matching secret is never shown here."},"format":{"type":"string","enum":["parquet","csv"],"description":"The file format for your exported data"},"schedule":{"type":"string","enum":["once-a-day","twice-a-day"],"description":"How often your data is exported"},"exportLocation":{"type":["string","null"],"description":"The S3 URI your exported data is written to, e.g. s3://your-export-bucket/. Null when this deployment has no export storage configured."},"lastExportDate":{"type":["string","null"],"format":"date-time","description":"When your data was most recently exported"},"lastExportStatus":{"type":["string","null"],"enum":["success","failure",null],"description":"Whether the most recent export succeeded or failed"},"created":{"type":"string","format":"date-time","description":"When these settings were created"},"updated":{"type":"string","format":"date-time","description":"When these settings were last updated"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataWarehouseSettingsUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSettingsUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSettingsUpdateOneRequest","description":"Request body for updating your data export settings. Send only the fields you want to change.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dataWarehouseSettings"]},"attributes":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"credentialType":{"type":"string","enum":["iam-role","access-key"]},"iamRoleArn":{"type":["string","null"],"description":"Set to null to remove access and turn off exports"},"format":{"type":"string","enum":["parquet","csv"]},"schedule":{"type":"string","enum":["once-a-day","twice-a-day"]}}}}}}},"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}}}}}}}}
```

## The DataWarehouseCredentialsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseCredentialsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseCredentialsResponse","description":"Returned when you turn on exports or replace your access key. Contains the new access key ID and secret. The secret is shown only once and is never stored or shown again, so save it securely.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The ID of the export settings these credentials belong to"},"type":{"type":"string","enum":["dataWarehouseCredentials"]},"attributes":{"type":"object","additionalProperties":false,"required":["accessKeyId","accessKeySecret"],"properties":{"accessKeyId":{"type":"string","description":"The IAM access key ID for reading your exported data"},"accessKeySecret":{"type":"string","description":"The secret for your access key. Shown only in this response and never stored or shown again, so save it securely."}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The DataWarehouseSchemaResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"DataWarehouseSchemaResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDataWarehouseSchemaResponse","description":"The current layout of your exported data. One entry per table, listing its columns and their data types.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Table name"},"type":{"type":"string","enum":["dataWarehouseSchemaTable"]},"attributes":{"type":"object","additionalProperties":false,"required":["table","columns"],"properties":{"table":{"type":"string","description":"Table name"},"columns":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","type"],"properties":{"name":{"type":"string","description":"Column name"},"type":{"type":"string","description":"The column's data type as reported by information_schema"}}}}}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The BaseResource object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}
```

## The DatasetAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"]}}}}
```

## The Dataset object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"]},"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"}}}}}}
```

## The GetDatasetsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetDatasetsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGetDatasetsResponse","description":"All datasets in the tenant, with their attributes and relationship links.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"]},"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}}}}
```

## The CreateDatasetRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateDatasetRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetCreateRequest","description":"Creates a dataset. Add its items afterwards with `datasetAtomicOperations`.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"key":{"type":"string","description":"Unique key for the dataset"},"label":{"type":"string","description":"Label of the dataset"},"dataSource":{"type":"string","description":"Who owns the dataset.\n- `custom`: tenant-created.\n- `fabric`: system-provisioned.","enum":["custom","fabric"]},"localized":{"type":"boolean","description":"When `true`, each item has a `locale`."}},"required":["key","label","dataSource"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"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}}}}}}}}
```

## The CreateDatasetResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateDatasetResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IDatasetCreateResponse","description":"The new dataset, with its server-assigned ID, attributes and relationship links.","type":"object","required":["data","links","jsonapi"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Dataset"},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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"]},"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}}}}
```

## The GetDatasetResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetDatasetResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGetDatasetResponse","description":"One dataset, with its attributes, relationship links and a self link.","type":"object","required":["data","links","jsonapi"],"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Dataset"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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"]},"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}}}}
```

## The WriteMetaOnlyRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}}}}}
```

## The PatchDatasetRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PatchDatasetRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPatchDatasetRequest","description":"Updates a dataset. Changes only the attributes in `data.attributes`. `data.id` must match the `datasetId` path parameter.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"required":["id","attributes"],"additionalProperties":false,"properties":{"attributes":{"type":"object","properties":{"label":{"type":"string"}},"additionalProperties":false}}}]}},"required":["data"],"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}}}}
```

## The DatasetItemAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"]}}}}
```

## The DatasetRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}
```

## The DatasetItem object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}]},"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},"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"]},"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"}}},"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}}}}
```

## The GetDatasetItemsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetDatasetItemsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGetDatasetItemsResponse","description":"The items in a dataset, paginated. Each item carries `key`, `value` and `locale` attributes and relationship links to its dataset.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DatasetItem"},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","links","jsonapi"],"additionalProperties":false},"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}]},"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},"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"]},"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"}}},"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}}}}
```

## The AddDatasetItemOperation object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AddDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAddDatasetItemOperation","description":"The new dataset item for an `add` operation: `key`, `value` and an optional `locale`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"key":{"type":"string","description":"Machine-readable identifier that records store when they reference the item. 2 to 50 letters, digits, underscores and hyphens, starting with a letter or digit.","minLength":2,"maxLength":50},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}}}}
```

## The UpdateDatasetItemOperation object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateDatasetItemOperation","description":"Payload of an `update` operation on a dataset item: the item's id and type, and the new `value`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}}}}
```

## The ExecuteDatasetOperationRequestData object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ExecuteDatasetOperationRequestData":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IExecuteDatasetOperationRequestData","description":"One operation.\n- `op`: `add`, `update` or `remove`.\n- `ref`: the target item, for `update` and `remove`.\n- `data`: the item payload, for `add` and `update`.","type":"object","properties":{"op":{"type":"string","enum":["add","remove","update"]},"ref":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"relationship":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"data":{"anyOf":[{"$ref":"#/components/schemas/AddDatasetItemOperation"},{"$ref":"#/components/schemas/UpdateDatasetItemOperation"}]}},"required":["op","ref"],"additionalProperties":false},"AddDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAddDatasetItemOperation","description":"The new dataset item for an `add` operation: `key`, `value` and an optional `locale`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"key":{"type":"string","description":"Machine-readable identifier that records store when they reference the item. 2 to 50 letters, digits, underscores and hyphens, starting with a letter or digit.","minLength":2,"maxLength":50},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false},"UpdateDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateDatasetItemOperation","description":"Payload of an `update` operation on a dataset item: the item's id and type, and the new `value`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}}}}
```

## The ExecuteDatasetOperationRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ExecuteDatasetOperationRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IExecuteDatasetOperationRequest","description":"Adds, updates and removes dataset items in one all-or-nothing request (JSON:API Atomic Operations).\n- At most 99 operations per request.\n- One item can't appear in conflicting operations, such as both `add` and `remove`.\n- Only datasets with `allowCustomItems: true` accept item changes.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","items":{"$ref":"#/components/schemas/ExecuteDatasetOperationRequestData"}}},"required":["atomic:operations"],"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}}}}},"ExecuteDatasetOperationRequestData":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IExecuteDatasetOperationRequestData","description":"One operation.\n- `op`: `add`, `update` or `remove`.\n- `ref`: the target item, for `update` and `remove`.\n- `data`: the item payload, for `add` and `update`.","type":"object","properties":{"op":{"type":"string","enum":["add","remove","update"]},"ref":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"relationship":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"data":{"anyOf":[{"$ref":"#/components/schemas/AddDatasetItemOperation"},{"$ref":"#/components/schemas/UpdateDatasetItemOperation"}]}},"required":["op","ref"],"additionalProperties":false},"AddDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAddDatasetItemOperation","description":"The new dataset item for an `add` operation: `key`, `value` and an optional `locale`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"key":{"type":"string","description":"Machine-readable identifier that records store when they reference the item. 2 to 50 letters, digits, underscores and hyphens, starting with a letter or digit.","minLength":2,"maxLength":50},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false},"UpdateDatasetItemOperation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateDatasetItemOperation","description":"Payload of an `update` operation on a dataset item: the item's id and type, and the new `value`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}}}}
```

## The FieldAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}}}}}}
```

## The Field object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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"}}}}}}
```

## The FieldFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The FieldCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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"]}}}}
```

## The FieldFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The FieldUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The WorkTypes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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}$"}}}}
```

## The RecordLayoutField object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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\"`."}}}}}}
```

## The RecordLayoutSection object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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\"`."}}}}}}
```

## The RecordLayoutGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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\"`."}}}}}}
```

## The RecordLayoutAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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\"`."}}}}}}
```

## The RecordLayoutFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The RecordLayoutCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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\"`."}}}}}}
```

## The RecordLayoutMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"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."}}}}}}
```

## The RecordLayoutFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The RecordLayoutUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"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}}}}
```

## The IGlobalMetadataOperator object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IGlobalMetadataOperator":{"type":"string","enum":["eq","ne","contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IGlobalMetadataCondition object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IGlobalMetadataCondition":{"type":"object","properties":{"field":{"type":"string","enum":["tenantId","parentId","externalId","provider","status","workType","workStatus","primaryTitle","synopses.key","synopses.value","synopses.type","synopses.attribution","synopses.locale","synopses.characterCount","genres.key","genres.value","genres.locale","keywords.key","keywords.value","keywords.locale","tagline.key","tagline.value","tagline.locale","runLength","releaseYear","altIdentifiers.key","altIdentifiers.value","countriesOfOrigin.key","countriesOfOrigin.value","primarySpokenLanguage","ratings.key","ratings.value","ratings.authority","ratings.reason","releaseDate","pictureColorType","originalLanguage","alternateReleaseDates.key","alternateReleaseDates.value","parentInfo.seasonNumber","parentInfo.episodeNumber","parentInfo.seasonId","parentInfo.seriesId","contributors.name","contributors.id","contributors.originNexusId","contributors.imdbId","contributors.job","contributors.characters","contributors.billingOrder","originRating","originMovieType"]},"operator":{"$ref":"#/components/schemas/IGlobalMetadataOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `primaryTitle`.\n- Omitted or `true`: a word one or two characters off still matches (\"clevelnd\" finds \"Cleveland\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IGlobalMetadataOperator":{"type":"string","enum":["eq","ne","contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IGlobalMetadataQueryGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IGlobalMetadataQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"IGlobalMetadataCondition":{"type":"object","properties":{"field":{"type":"string","enum":["tenantId","parentId","externalId","provider","status","workType","workStatus","primaryTitle","synopses.key","synopses.value","synopses.type","synopses.attribution","synopses.locale","synopses.characterCount","genres.key","genres.value","genres.locale","keywords.key","keywords.value","keywords.locale","tagline.key","tagline.value","tagline.locale","runLength","releaseYear","altIdentifiers.key","altIdentifiers.value","countriesOfOrigin.key","countriesOfOrigin.value","primarySpokenLanguage","ratings.key","ratings.value","ratings.authority","ratings.reason","releaseDate","pictureColorType","originalLanguage","alternateReleaseDates.key","alternateReleaseDates.value","parentInfo.seasonNumber","parentInfo.episodeNumber","parentInfo.seasonId","parentInfo.seriesId","contributors.name","contributors.id","contributors.originNexusId","contributors.imdbId","contributors.job","contributors.characters","contributors.billingOrder","originRating","originMovieType"]},"operator":{"$ref":"#/components/schemas/IGlobalMetadataOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `primaryTitle`.\n- Omitted or `true`: a word one or two characters off still matches (\"clevelnd\" finds \"Cleveland\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IGlobalMetadataOperator":{"type":"string","enum":["eq","ne","contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The GlobalMetadataSearchRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataSearchRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataSearchRequest","description":"Request body for searching global (cross-tenant, provider-sourced) metadata records. Supports the same boolean query group model as contributor search, with conditions targeting global record fields such as titles, genres, contributors, release dates, identifiers, and Origin-specific fields.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["searchQueries"]},"attributes":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/IGlobalMetadataQueryGroup"}},"required":["group"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"definitions":{"IGlobalMetadataOperator":{"type":"string","enum":["eq","ne","contains","starts_with","lt","lte","gt","gte","exists","not_exists"]},"IGlobalMetadataCondition":{"type":"object","properties":{"field":{"type":"string","enum":["tenantId","parentId","externalId","provider","status","workType","workStatus","primaryTitle","synopses.key","synopses.value","synopses.type","synopses.attribution","synopses.locale","synopses.characterCount","genres.key","genres.value","genres.locale","keywords.key","keywords.value","keywords.locale","tagline.key","tagline.value","tagline.locale","runLength","releaseYear","altIdentifiers.key","altIdentifiers.value","countriesOfOrigin.key","countriesOfOrigin.value","primarySpokenLanguage","ratings.key","ratings.value","ratings.authority","ratings.reason","releaseDate","pictureColorType","originalLanguage","alternateReleaseDates.key","alternateReleaseDates.value","parentInfo.seasonNumber","parentInfo.episodeNumber","parentInfo.seasonId","parentInfo.seriesId","contributors.name","contributors.id","contributors.originNexusId","contributors.imdbId","contributors.job","contributors.characters","contributors.billingOrder","originRating","originMovieType"]},"operator":{"$ref":"#/components/schemas/IGlobalMetadataOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `primaryTitle`.\n- Omitted or `true`: a word one or two characters off still matches (\"clevelnd\" finds \"Cleveland\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IGlobalMetadataQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"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}}}}},"IGlobalMetadataQueryGroup":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataCondition"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IGlobalMetadataQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"IGlobalMetadataCondition":{"type":"object","properties":{"field":{"type":"string","enum":["tenantId","parentId","externalId","provider","status","workType","workStatus","primaryTitle","synopses.key","synopses.value","synopses.type","synopses.attribution","synopses.locale","synopses.characterCount","genres.key","genres.value","genres.locale","keywords.key","keywords.value","keywords.locale","tagline.key","tagline.value","tagline.locale","runLength","releaseYear","altIdentifiers.key","altIdentifiers.value","countriesOfOrigin.key","countriesOfOrigin.value","primarySpokenLanguage","ratings.key","ratings.value","ratings.authority","ratings.reason","releaseDate","pictureColorType","originalLanguage","alternateReleaseDates.key","alternateReleaseDates.value","parentInfo.seasonNumber","parentInfo.episodeNumber","parentInfo.seasonId","parentInfo.seriesId","contributors.name","contributors.id","contributors.originNexusId","contributors.imdbId","contributors.job","contributors.characters","contributors.billingOrder","originRating","originMovieType"]},"operator":{"$ref":"#/components/schemas/IGlobalMetadataOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"fuzzy":{"type":"boolean","description":"Typo tolerance for `contains` and `not_contains` on `primaryTitle`.\n- Omitted or `true`: a word one or two characters off still matches (\"clevelnd\" finds \"Cleveland\").\n- `false`: the words must match exactly."}},"required":["field","operator"],"additionalProperties":false},"IGlobalMetadataOperator":{"type":"string","enum":["eq","ne","contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The GlobalImage object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}}}
```

## The GlobalRecordContributor object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GlobalBaseRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GlobalOriginRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalOriginRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalOriginRecord","description":"A global metadata record from Origin Nexus. Adds these fields to the base record:\n- `originRating`: normalized popularity rating\n- `originMovieType`: movie type classification\n- `originCollectionIds`: collection groups the record belongs to\n- `originTags` and `originMicroGenres`: subject tags and micro-genres","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"},{"type":"object","properties":{"originRating":{"type":"integer"},"originMovieType":{"type":"string"},"originCollectionIds":{"type":"array","items":{"type":"string"}},"originTags":{"type":"array","description":"Program-level subject tags from the Origin Nexus `Tags` field, as short phrases such as \"space travel\" or \"father daughter relationship\". Not the same as `images[].tags`, which describe image content.","items":{"type":"string"}},"originMicroGenres":{"type":"array","description":"Structured micro-genres from the Origin Nexus `MicroGenres` field. Each entry has a label and attribution. WikiData-attributed entries also carry `sourceId` (a Q-id) and `aliases`; Wikipedia-attributed entries may have neither.","items":{"type":"object","properties":{"label":{"type":"string"},"sourceId":{"type":"string"},"attribution":{"type":"string"},"aliases":{"type":"array","items":{"type":"string"}}},"required":["label","attribution"],"additionalProperties":false}}},"additionalProperties":false}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GlobalMetadataSearchResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataSearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataSearchResponse","description":"Response returned by the global metadata search endpoint. Contains a paginated array of JSON:API resources, each representing an Origin global record. The `meta` object provides pagination context (total, page, perPage, start, limit).","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/GlobalOriginRecord"}},"required":["id","type","attributes"],"additionalProperties":false}},"links":{"type":"object","properties":{"self":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"perPage":{"type":"integer"},"start":{"type":"integer"},"limit":{"type":"integer"},"sort":{"$ref":"#/components/schemas/SearchSortMeta"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"GlobalOriginRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalOriginRecord","description":"A global metadata record from Origin Nexus. Adds these fields to the base record:\n- `originRating`: normalized popularity rating\n- `originMovieType`: movie type classification\n- `originCollectionIds`: collection groups the record belongs to\n- `originTags` and `originMicroGenres`: subject tags and micro-genres","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"},{"type":"object","properties":{"originRating":{"type":"integer"},"originMovieType":{"type":"string"},"originCollectionIds":{"type":"array","items":{"type":"string"}},"originTags":{"type":"array","description":"Program-level subject tags from the Origin Nexus `Tags` field, as short phrases such as \"space travel\" or \"father daughter relationship\". Not the same as `images[].tags`, which describe image content.","items":{"type":"string"}},"originMicroGenres":{"type":"array","description":"Structured micro-genres from the Origin Nexus `MicroGenres` field. Each entry has a label and attribution. WikiData-attributed entries also carry `sourceId` (a Q-id) and `aliases`; Wikipedia-attributed entries may have neither.","items":{"type":"object","properties":{"label":{"type":"string"},"sourceId":{"type":"string"},"attribution":{"type":"string"},"aliases":{"type":"array","items":{"type":"string"}}},"required":["label","attribution"],"additionalProperties":false}}},"additionalProperties":false}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false},"SearchSortMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchSortMeta","description":"The ordering applied to the search results. Every search response carries it, whether or not the request asked for an ordering.","type":"object","properties":{"applied":{"type":"string","description":"The ordering applied, in the `sort` parameter's comma-separated syntax. Pass it back as `sort` to keep the ordering fixed across later requests."},"default":{"type":"boolean","description":"`true` when the request had no `sort` and the server chose the ordering; `false` when it reflects the `sort` you sent."}},"required":["applied","default"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GlobalImdbRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalImdbRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImdbRecord","description":"A global metadata record from IMDb. Adds IMDb fields to the shared base record: rating, taglines, keywords, filming locations and the imdb.com link. Get one with `GET /global/imdb/{id}` and an IMDb title ID, for example `tt0816692`.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"},{"type":"object","properties":{"keywords":{"description":"Subject keywords for the title, each with a stable key, display value and locale.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"tagline":{"description":"Marketing taglines, localized when available.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"pictureColorType":{"description":"Color presentation, for example Color or Black and White, when IMDb provides it.","type":"string"},"imdbUrl":{"description":"The title's IMDb web URL.","type":"string"},"isAdult":{"description":"Whether IMDb classifies the title as adult content.","type":"boolean"},"imdbRating":{"description":"IMDb aggregate user rating and vote count.","type":"object","properties":{"rating":{"description":"Average rating on the IMDb scale (typically 1-10).","type":"number"},"numberOfVotes":{"description":"Number of user votes behind the rating.","type":"number"}},"additionalProperties":false},"locations":{"description":"Filming locations and scene notes, when IMDb provides them.","type":"array","items":{"type":"object","properties":{"place":{"description":"Filming location name.","type":"string"},"scenes":{"description":"Scene descriptions for this location.","type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GlobalMetadataGetImdbResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataGetImdbResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataGetImdbResponse","description":"One global record from IMDb, by IMDb title ID. `data.attributes` holds the full IMDb record, including rating and location fields.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"Origin Studio's internal ID for this record.","type":"string"},"type":{"description":"JSON:API resource type for global metadata records.","type":"string"},"attributes":{"$ref":"#/components/schemas/GlobalImdbRecord"}},"required":["id","type","attributes"],"additionalProperties":false},"links":{"description":"Links for this resource.","type":"object","properties":{"self":{"description":"URL of this resource.","type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","links","jsonapi"],"additionalProperties":false},"GlobalImdbRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImdbRecord","description":"A global metadata record from IMDb. Adds IMDb fields to the shared base record: rating, taglines, keywords, filming locations and the imdb.com link. Get one with `GET /global/imdb/{id}` and an IMDb title ID, for example `tt0816692`.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"},{"type":"object","properties":{"keywords":{"description":"Subject keywords for the title, each with a stable key, display value and locale.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"tagline":{"description":"Marketing taglines, localized when available.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"pictureColorType":{"description":"Color presentation, for example Color or Black and White, when IMDb provides it.","type":"string"},"imdbUrl":{"description":"The title's IMDb web URL.","type":"string"},"isAdult":{"description":"Whether IMDb classifies the title as adult content.","type":"boolean"},"imdbRating":{"description":"IMDb aggregate user rating and vote count.","type":"object","properties":{"rating":{"description":"Average rating on the IMDb scale (typically 1-10).","type":"number"},"numberOfVotes":{"description":"Number of user votes behind the rating.","type":"number"}},"additionalProperties":false},"locations":{"description":"Filming locations and scene notes, when IMDb provides them.","type":"array","items":{"type":"object","properties":{"place":{"description":"Filming location name.","type":"string"},"scenes":{"description":"Scene descriptions for this location.","type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GlobalEidrRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalEidrRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalEIDRRecord","description":"A global metadata record from the Entertainment Identifier Registry (EIDR). Uses only the shared base record fields. Get one with `GET /global/eidr/{id}` and a full EIDR ID, for example `10.5240/5BC6-2FA3-4F64-B17E-0B7D-H`.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GlobalMetadataGetEidrResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataGetEidrResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataGetEidrResponse","description":"One global record from EIDR, by registry ID. `data.attributes` holds the shared base record fields. Alternate identifiers can include cross-references such as IMDb IDs.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"Origin Studio's internal ID for this record.","type":"string"},"type":{"description":"JSON:API resource type for global metadata records.","type":"string"},"attributes":{"$ref":"#/components/schemas/GlobalEidrRecord"}},"required":["id","type","attributes"],"additionalProperties":false},"links":{"description":"Links for this resource.","type":"object","properties":{"self":{"description":"URL of this resource.","type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","links","jsonapi"],"additionalProperties":false},"GlobalEidrRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalEIDRRecord","description":"A global metadata record from the Entertainment Identifier Registry (EIDR). Uses only the shared base record fields. Get one with `GET /global/eidr/{id}` and a full EIDR ID, for example `10.5240/5BC6-2FA3-4F64-B17E-0B7D-H`.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GracenoteVideoDescriptorAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GracenoteVideoDescriptorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorAttributes","description":"Attributes of a Gracenote video descriptor from the tenant's cached taxonomy. The `parent` and `ancestors` relationships carry the hierarchy; `path` renders the same chain as readable text.","type":"object","properties":{"name":{"description":"Human-readable descriptor name, for example `Heist`.","type":"string"},"typeName":{"description":"Taxonomy category the descriptor belongs to, for example `Theme` or `Mood`.","type":"string"},"path":{"description":"Readable taxonomy path from the resolved root down to this descriptor, joined with ` > `, for example `Theme > Crime > Heist`. Stops at the resolved portion when an ancestor is missing from the tenant's cached taxonomy.","type":"string"}},"required":["name"],"additionalProperties":false}}}}
```

## The GracenoteVideoDescriptorRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GracenoteVideoDescriptorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorRelationships","description":"Hierarchy of a Gracenote video descriptor. `parent` is the parent descriptor in the taxonomy tree, not a record's `parentId` (the EIDR content-hierarchy parent). A root descriptor has neither member. A member appears only when its descriptor resolves in the tenant's cached taxonomy, so linkage never dangles. Request `include=ancestors` to get the referenced descriptors in `included`.","type":"object","properties":{"parent":{"description":"The descriptor's immediate parent.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"ancestors":{"description":"Resolved ancestors, from the taxonomy root down to the immediate parent. Stops at the resolved portion when the chain hits an id missing from the taxonomy, a cycle, or the maximum walk depth.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"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}}}}
```

## The GracenoteVideoDescriptor object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GracenoteVideoDescriptor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptor","description":"One entry of the tenant's cached Gracenote video descriptor taxonomy: the controlled vocabulary (genre, mood and theme tags) that a program's descriptors reference. The resource id is the Gracenote descriptor id. Primary data of `GET /global/gracenote/taxonomy/videoDescriptors`, and part of `included` in any document that sideloads it.","type":"object","properties":{"id":{"description":"Gracenote video descriptor id.","type":"string"},"type":{"description":"Resource type for Gracenote taxonomy descriptors.","type":"string","enum":["globalMetadataTaxonomyDescriptors"]},"attributes":{"$ref":"#/components/schemas/GracenoteVideoDescriptorAttributes"},"relationships":{"$ref":"#/components/schemas/GracenoteVideoDescriptorRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["id","type","attributes"],"additionalProperties":false},"GracenoteVideoDescriptorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorAttributes","description":"Attributes of a Gracenote video descriptor from the tenant's cached taxonomy. The `parent` and `ancestors` relationships carry the hierarchy; `path` renders the same chain as readable text.","type":"object","properties":{"name":{"description":"Human-readable descriptor name, for example `Heist`.","type":"string"},"typeName":{"description":"Taxonomy category the descriptor belongs to, for example `Theme` or `Mood`.","type":"string"},"path":{"description":"Readable taxonomy path from the resolved root down to this descriptor, joined with ` > `, for example `Theme > Crime > Heist`. Stops at the resolved portion when an ancestor is missing from the tenant's cached taxonomy.","type":"string"}},"required":["name"],"additionalProperties":false},"GracenoteVideoDescriptorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorRelationships","description":"Hierarchy of a Gracenote video descriptor. `parent` is the parent descriptor in the taxonomy tree, not a record's `parentId` (the EIDR content-hierarchy parent). A root descriptor has neither member. A member appears only when its descriptor resolves in the tenant's cached taxonomy, so linkage never dangles. Request `include=ancestors` to get the referenced descriptors in `included`.","type":"object","properties":{"parent":{"description":"The descriptor's immediate parent.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"ancestors":{"description":"Resolved ancestors, from the taxonomy root down to the immediate parent. Stops at the resolved portion when the chain hits an id missing from the taxonomy, a cycle, or the maximum walk depth.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"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},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false}}}}
```

## The GlobalMetadataGetGracenoteTaxonomyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataGetGracenoteTaxonomyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataGetGracenoteTaxonomyResponse","description":"Entries of the tenant's cached Gracenote video descriptor taxonomy: the controlled vocabulary behind a program's video descriptors. The `parent` and `ancestors` relationships carry the hierarchy; request `include=ancestors` to get those descriptors in `included`, deduplicated across the page. Cursor-paginated: follow `links.next`, or pass `meta.cursor` as `page.cursor`, until it is absent. Returns an empty `data` array before the first taxonomy poll or when the tenant has no Gracenote config.","type":"object","properties":{"data":{"description":"A page of taxonomy descriptors.\n- Browse: ordered by descriptor id, lexicographically (not numeric order for ids of different lengths).\n- `filter.ids`: in the order you requested them. Never paginated.","type":"array","items":{"$ref":"#/components/schemas/GracenoteVideoDescriptor"}},"included":{"description":"Descriptors that the page's `parent` and `ancestors` relationships reference, deduplicated across the page. Present only when you request it with `include`.","type":"array","items":{"$ref":"#/components/schemas/GracenoteVideoDescriptor"}},"meta":{"description":"Meta for this page.","type":"object","properties":{"cursor":{"description":"Opaque cursor: pass it as `page.cursor` to get the next page. Absent on the last page.","type":"string"},"perPage":{"description":"Maximum descriptors per page for this request: the effective `page.size`. Present only on the browse path; `filter.ids` never paginates.","type":"number"},"total":{"description":"Number of descriptors that match the request across all pages, not this page's size (`data.length`). Zero before the first taxonomy poll or when the tenant hasn't enabled the provider.","type":"number"}},"required":["total"],"additionalProperties":false},"links":{"description":"Pagination links.","type":"object","properties":{"self":{"description":"URL of this page, with the query parameters that produced it.","type":"string"},"next":{"description":"URL of the following page. Absent on the last page.","type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","meta","links","jsonapi"],"additionalProperties":false},"GracenoteVideoDescriptor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptor","description":"One entry of the tenant's cached Gracenote video descriptor taxonomy: the controlled vocabulary (genre, mood and theme tags) that a program's descriptors reference. The resource id is the Gracenote descriptor id. Primary data of `GET /global/gracenote/taxonomy/videoDescriptors`, and part of `included` in any document that sideloads it.","type":"object","properties":{"id":{"description":"Gracenote video descriptor id.","type":"string"},"type":{"description":"Resource type for Gracenote taxonomy descriptors.","type":"string","enum":["globalMetadataTaxonomyDescriptors"]},"attributes":{"$ref":"#/components/schemas/GracenoteVideoDescriptorAttributes"},"relationships":{"$ref":"#/components/schemas/GracenoteVideoDescriptorRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["id","type","attributes"],"additionalProperties":false},"GracenoteVideoDescriptorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorAttributes","description":"Attributes of a Gracenote video descriptor from the tenant's cached taxonomy. The `parent` and `ancestors` relationships carry the hierarchy; `path` renders the same chain as readable text.","type":"object","properties":{"name":{"description":"Human-readable descriptor name, for example `Heist`.","type":"string"},"typeName":{"description":"Taxonomy category the descriptor belongs to, for example `Theme` or `Mood`.","type":"string"},"path":{"description":"Readable taxonomy path from the resolved root down to this descriptor, joined with ` > `, for example `Theme > Crime > Heist`. Stops at the resolved portion when an ancestor is missing from the tenant's cached taxonomy.","type":"string"}},"required":["name"],"additionalProperties":false},"GracenoteVideoDescriptorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorRelationships","description":"Hierarchy of a Gracenote video descriptor. `parent` is the parent descriptor in the taxonomy tree, not a record's `parentId` (the EIDR content-hierarchy parent). A root descriptor has neither member. A member appears only when its descriptor resolves in the tenant's cached taxonomy, so linkage never dangles. Request `include=ancestors` to get the referenced descriptors in `included`.","type":"object","properties":{"parent":{"description":"The descriptor's immediate parent.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"ancestors":{"description":"Resolved ancestors, from the taxonomy root down to the immediate parent. Stops at the resolved portion when the chain hits an id missing from the taxonomy, a cycle, or the maximum walk depth.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"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},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GlobalGracenoteRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalGracenoteRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalGracenoteRecord","description":"A global metadata record from the tenant's own licensed Gracenote entitlement. Uses the shared base record fields. Video descriptors sit in the `videoDescriptors` relationship, not in attributes; request `include=videoDescriptors` to resolve them. The data is per-tenant: a lookup returns only the calling tenant's cached copy. Get one with `GET /global/gracenote/{id}` and a Gracenote TMSId.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false}}}}
```

## The GracenoteRecordRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GracenoteRecordRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteRecordRelationships","description":"Relationships of a Gracenote record. `videoDescriptors` links the program to entries of the tenant's cached video descriptor taxonomy; each member's `meta` holds `ord` (its order on this program) and `weight` (its relevance).","type":"object","properties":{"videoDescriptors":{"description":"Descriptors on this program, in the provider's order. Omitted when the program has none. `links.related` resolves the linked ids in one call through `filter.ids` on the taxonomy endpoint; the response omits it when the program has more descriptors than `filter.ids` accepts in one request. The linkage `data` is always complete.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]},"meta":{"type":"object","properties":{"ord":{"description":"The provider's ordinal for this descriptor in the program's list.","type":"number"},"weight":{"description":"The provider's relevance weight for this descriptor on this program.","type":"number"},"resolved":{"description":"False when the tenant's cached taxonomy lacks this descriptor id. The linkage still appears, but `included` has no matching resource.","type":"boolean"}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"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}}}}
```

## The GlobalMetadataGetGracenoteResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataGetGracenoteResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataGetGracenoteResponse","description":"One Gracenote record from the tenant's licensed cache, by TMSId. `data.attributes` holds the record fields. `data.relationships.videoDescriptors` links the program's video descriptors, with `ord` and `weight` in each member's `meta`. Request `include=videoDescriptors` to get the resolved descriptors (name, category, hierarchy and readable `path`) in `included`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"Origin Studio's internal ID for this record.","type":"string"},"type":{"description":"JSON:API resource type for global metadata records.","type":"string"},"attributes":{"$ref":"#/components/schemas/GlobalGracenoteRecord"},"relationships":{"$ref":"#/components/schemas/GracenoteRecordRelationships"}},"required":["id","type","attributes"],"additionalProperties":false},"included":{"description":"Descriptors that `data.relationships.videoDescriptors` references, plus their ancestors with `include=videoDescriptors.ancestors`. Deduplicated. Present only when you request it with `include`.","type":"array","items":{"$ref":"#/components/schemas/GracenoteVideoDescriptor"}},"links":{"description":"Links for this resource.","type":"object","properties":{"self":{"description":"URL of this resource.","type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","links","jsonapi"],"additionalProperties":false},"GlobalGracenoteRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalGracenoteRecord","description":"A global metadata record from the tenant's own licensed Gracenote entitlement. Uses the shared base record fields. Video descriptors sit in the `videoDescriptors` relationship, not in attributes; request `include=videoDescriptors` to resolve them. The data is per-tenant: a lookup returns only the calling tenant's cached copy. Get one with `GET /global/gracenote/{id}` and a Gracenote TMSId.","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false},"GracenoteRecordRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteRecordRelationships","description":"Relationships of a Gracenote record. `videoDescriptors` links the program to entries of the tenant's cached video descriptor taxonomy; each member's `meta` holds `ord` (its order on this program) and `weight` (its relevance).","type":"object","properties":{"videoDescriptors":{"description":"Descriptors on this program, in the provider's order. Omitted when the program has none. `links.related` resolves the linked ids in one call through `filter.ids` on the taxonomy endpoint; the response omits it when the program has more descriptors than `filter.ids` accepts in one request. The linkage `data` is always complete.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]},"meta":{"type":"object","properties":{"ord":{"description":"The provider's ordinal for this descriptor in the program's list.","type":"number"},"weight":{"description":"The provider's relevance weight for this descriptor on this program.","type":"number"},"resolved":{"description":"False when the tenant's cached taxonomy lacks this descriptor id. The linkage still appears, but `included` has no matching resource.","type":"boolean"}},"additionalProperties":false}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"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},"GracenoteVideoDescriptor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptor","description":"One entry of the tenant's cached Gracenote video descriptor taxonomy: the controlled vocabulary (genre, mood and theme tags) that a program's descriptors reference. The resource id is the Gracenote descriptor id. Primary data of `GET /global/gracenote/taxonomy/videoDescriptors`, and part of `included` in any document that sideloads it.","type":"object","properties":{"id":{"description":"Gracenote video descriptor id.","type":"string"},"type":{"description":"Resource type for Gracenote taxonomy descriptors.","type":"string","enum":["globalMetadataTaxonomyDescriptors"]},"attributes":{"$ref":"#/components/schemas/GracenoteVideoDescriptorAttributes"},"relationships":{"$ref":"#/components/schemas/GracenoteVideoDescriptorRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["id","type","attributes"],"additionalProperties":false},"GracenoteVideoDescriptorAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorAttributes","description":"Attributes of a Gracenote video descriptor from the tenant's cached taxonomy. The `parent` and `ancestors` relationships carry the hierarchy; `path` renders the same chain as readable text.","type":"object","properties":{"name":{"description":"Human-readable descriptor name, for example `Heist`.","type":"string"},"typeName":{"description":"Taxonomy category the descriptor belongs to, for example `Theme` or `Mood`.","type":"string"},"path":{"description":"Readable taxonomy path from the resolved root down to this descriptor, joined with ` > `, for example `Theme > Crime > Heist`. Stops at the resolved portion when an ancestor is missing from the tenant's cached taxonomy.","type":"string"}},"required":["name"],"additionalProperties":false},"GracenoteVideoDescriptorRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGracenoteVideoDescriptorRelationships","description":"Hierarchy of a Gracenote video descriptor. `parent` is the parent descriptor in the taxonomy tree, not a record's `parentId` (the EIDR content-hierarchy parent). A root descriptor has neither member. A member appears only when its descriptor resolves in the tenant's cached taxonomy, so linkage never dangles. Request `include=ancestors` to get the referenced descriptors in `included`.","type":"object","properties":{"parent":{"description":"The descriptor's immediate parent.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"ancestors":{"description":"Resolved ancestors, from the taxonomy root down to the immediate parent. Stops at the resolved portion when the chain hits an id missing from the taxonomy, a cycle, or the maximum walk depth.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["globalMetadataTaxonomyDescriptors"]}},"required":["id","type"],"additionalProperties":false}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}},"additionalProperties":false},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GlobalMetadataGetOriginResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GlobalMetadataGetOriginResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalMetadataGetOriginResponse","description":"One global record, fetched directly from Origin Nexus by its provider-assigned ID. `data.attributes` holds the full Origin Nexus record, including `originRating`, `originMovieType` and `originCollectionIds`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/GlobalOriginRecord"}},"required":["id","type","attributes"],"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","links","jsonapi"],"additionalProperties":false},"GlobalOriginRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalOriginRecord","description":"A global metadata record from Origin Nexus. Adds these fields to the base record:\n- `originRating`: normalized popularity rating\n- `originMovieType`: movie type classification\n- `originCollectionIds`: collection groups the record belongs to\n- `originTags` and `originMicroGenres`: subject tags and micro-genres","allOf":[{"$ref":"#/components/schemas/GlobalBaseRecord"},{"type":"object","properties":{"originRating":{"type":"integer"},"originMovieType":{"type":"string"},"originCollectionIds":{"type":"array","items":{"type":"string"}},"originTags":{"type":"array","description":"Program-level subject tags from the Origin Nexus `Tags` field, as short phrases such as \"space travel\" or \"father daughter relationship\". Not the same as `images[].tags`, which describe image content.","items":{"type":"string"}},"originMicroGenres":{"type":"array","description":"Structured micro-genres from the Origin Nexus `MicroGenres` field. Each entry has a label and attribution. WikiData-attributed entries also carry `sourceId` (a Q-id) and `aliases`; Wikipedia-attributed entries may have neither.","items":{"type":"object","properties":{"label":{"type":"string"},"sourceId":{"type":"string"},"attribution":{"type":"string"},"aliases":{"type":"array","items":{"type":"string"}}},"required":["label","attribution"],"additionalProperties":false}}},"additionalProperties":false}]},"GlobalBaseRecord":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalBaseRecord","description":"Fields shared by every global metadata record from an external provider (currently Origin Nexus). Provider-specific records, such as `IGlobalOriginRecord`, extend it.","type":"object","properties":{"externalId":{"type":"string"},"tenantId":{"type":"string"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"]},"parentId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workStatus":{"type":"string"},"primaryTitle":{"type":"string"},"titles":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"synopses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"attribution":{"type":"string"},"locale":{"type":"string"},"characterCount":{"type":"integer"}},"required":["key","value","locale"],"additionalProperties":false}},"genres":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"}},"required":["key","value","locale"],"additionalProperties":false}},"runLength":{"type":"integer","description":"Total run length in **seconds**. Ingest converts provider minutes (Origin Nexus, IMDb, Gracenote) and ISO durations (EIDR): a 30-minute episode is 1800, not 30."},"releaseYear":{"type":"integer"},"altIdentifiers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"alternateReleaseDates":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"country":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"countriesOfOrigin":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"associatedOrganizations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"ratings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"authority":{"type":"string"},"reason":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"releaseDate":{"type":"string","format":"date-time"},"originalLanguage":{"type":"string"},"primarySpokenLanguage":{"type":"string"},"coverImage":{"$ref":"#/components/schemas/GlobalImage"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"}},"parentInfo":{"type":"object","properties":{"seasonNumber":{"type":"integer"},"episodeNumber":{"type":"integer"},"seasonId":{"type":"string"},"seriesId":{"type":"string"}},"additionalProperties":false},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/GlobalRecordContributor"}},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}},"required":["externalId","workType","primaryTitle"],"additionalProperties":false},"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}$"},"GlobalImage":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalImage","description":"An image of a global metadata record. The provider assigns `key`; `value` holds the image URL or identifier. `violence` and `sexuality` are content rating scores, and `official` marks the provider's official images.","type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"imageType":{"type":"string"},"height":{"type":"integer"},"width":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"violence":{"type":"integer"},"sexuality":{"type":"integer"},"official":{"type":"boolean"},"locale":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"GlobalRecordContributor":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGlobalRecordContributor","description":"A contributor credit on a global metadata record, such as an actor or director. The provider assigns `key`; `id`, `originNexusId` and `imdbId` identify the person when known. `job` is the role, `characters` the character names and `billingOrder` the billing position.","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"originNexusId":{"type":"string"},"imdbId":{"type":"string"},"job":{"type":"string"},"characters":{"type":"array","items":{"type":"string"}},"billingOrder":{"type":"integer"}},"required":["key","name","job"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The LicensedMetadataFeedHealth object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}}}}}
```

## The LicensedMetadataConfigAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}}}}}
```

## The LicensedMetadataConfigFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"LicensedMetadataConfigFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigFindManyResponse","description":"The tenant's licensed metadata provider configs.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/LicensedMetadataConfigAttributes"}]},"meta":{"type":"object","description":"`seedJobId`: the seed job. Check it with `GET /backgroundJobs/{jobId}`.","properties":{"seedJobId":{"type":"string","description":"The background job that ran, or is running, the initial seed. Present once a seed has started."}},"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateLicensedMetadataConfigAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateLicensedMetadataConfigAttributes","description":"Enables a licensed metadata provider for the tenant. Requires the tenant's own provider API key: Fabric never shares a key across tenants.","type":"object","additionalProperties":false,"required":["provider","apiKey","programsPollingIntervalMinutes","taxonomyPollingInterval"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider to enable."},"apiKey":{"type":"string","description":"Write-only. The tenant's own provider API key. The server stores it as a per-tenant secret and never returns it."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up. Each poll spends the tenant's own provider API quota. No default."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes. The taxonomy is small and rarely changes. Each check spends the tenant's own API quota. No default."}}}}}}
```

## The CreateLicensedMetadataConfigRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateLicensedMetadataConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateLicensedMetadataConfigRequest","description":"Enables a licensed metadata provider for the tenant. A tenant can have one config per provider.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["licensedMetadataConfigs"]},"attributes":{"$ref":"#/components/schemas/CreateLicensedMetadataConfigAttributes"}}}}},"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}}}}},"CreateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateLicensedMetadataConfigAttributes","description":"Enables a licensed metadata provider for the tenant. Requires the tenant's own provider API key: Fabric never shares a key across tenants.","type":"object","additionalProperties":false,"required":["provider","apiKey","programsPollingIntervalMinutes","taxonomyPollingInterval"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider to enable."},"apiKey":{"type":"string","description":"Write-only. The tenant's own provider API key. The server stores it as a per-tenant secret and never returns it."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up. Each poll spends the tenant's own provider API quota. No default."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes. The taxonomy is small and rarely changes. Each check spends the tenant's own API quota. No default."}}}}}}
```

## The LicensedMetadataConfigCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"LicensedMetadataConfigCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"ILicensedMetadataConfigCreateOneResponse","description":"The licensed metadata provider config you just enabled, with its self link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/LicensedMetadataConfigAttributes"}]},"meta":{"type":"object","description":"`seedJobId`: the seed job. Check it with `GET /backgroundJobs/{jobId}`.","properties":{"seedJobId":{"type":"string","description":"The background job that ran, or is running, the initial seed. Present once a seed has started."}},"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UpdateLicensedMetadataConfigAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateLicensedMetadataConfigAttributes","description":"Attributes to change on a licensed metadata provider config. Send only what you want to change. You can't change the provider.","type":"object","additionalProperties":false,"properties":{"apiKey":{"type":"string","description":"Write-only. A new provider API key to rotate to. The server stores it as a per-tenant secret, overwrites the old one and never returns it. Rotating keeps the existing cache."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"`true` pauses steady-state polling, `false` resumes it. Pausing stops both feeds' schedules and stops a steady-state drain in flight at its next page; an initial seed job already running still finishes. Pausing deletes nothing: cursors, cached data and the cadence stay, and resuming continues where polling stopped. Changing the cadence while paused keeps polling paused."}}}}}}
```

## The UpdateLicensedMetadataConfigRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateLicensedMetadataConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateLicensedMetadataConfigRequest","description":"Updates a licensed metadata provider config, for example to rotate the API key. The path parameter identifies the config; the body carries only the attributes to change.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["licensedMetadataConfigs"]},"attributes":{"$ref":"#/components/schemas/UpdateLicensedMetadataConfigAttributes"}}}}},"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}}}}},"UpdateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateLicensedMetadataConfigAttributes","description":"Attributes to change on a licensed metadata provider config. Send only what you want to change. You can't change the provider.","type":"object","additionalProperties":false,"properties":{"apiKey":{"type":"string","description":"Write-only. A new provider API key to rotate to. The server stores it as a per-tenant secret, overwrites the old one and never returns it. Rotating keeps the existing cache."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"`true` pauses steady-state polling, `false` resumes it. Pausing stops both feeds' schedules and stops a steady-state drain in flight at its next page; an initial seed job already running still finishes. Pausing deletes nothing: cursors, cached data and the cadence stay, and resuming continues where polling stopped. Changing the cadence while paused keeps polling paused."}}}}}}
```

## The MediaStorageFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaStorageFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaStorageFindOneResponse","description":"Returns the media storage information for a tenant","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["mediaStorage"]},"attributes":{"type":"object","additionalProperties":false,"required":["committedBytes","limitBytes"],"properties":{"committedBytes":{"type":"integer","description":"The number of bytes currently committed/used by the tenant"},"limitBytes":{"type":"integer","description":"The maximum number of bytes allowed for the tenant"},"availableBytes":{"type":"integer","description":"The number of bytes available for the tenant (limitBytes - committedBytes)"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}}}},"links":{"$ref":"#/components/schemas/LinksSelf"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The MediaAttributeMediaType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAttributeMediaType":{"$id":"media_attribute_media_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMediaType","description":"High-level media category. `image` is a raster image (JPEG, PNG, etc.). `file` is a document or other non-image file (PDF, Office document, CSV). `archive` is a compressed collection of files.","type":"string","enum":["image","file","archive"]}}}}
```

## The MediaAttributeMimeType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAttributeMimeType":{"$id":"media_attribute_mime_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMimeType","description":"MIME type of the uploaded file. Only types in this enum are accepted by the platform. Supported formats include common image formats (JPEG, PNG, GIF, WebP, TIFF, AVIF, PSD), PDF, illustration and design formats (AI, INDD), and Office/spreadsheet documents.","type":"string","enum":["image/jpeg","image/png","image/vnd.adobe.photoshop","image/gif","image/avif","image/webp","image/tiff","application/pdf","text/csv","application/illustrator","application/x-indesign","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]}}}}
```

## The MediaAttributeImageType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAttributeImageType":{"$id":"media_attribute_image_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeImageType","description":"Editorial classification for an image asset associated with a record. Used to distinguish between general photos, talent portraits, theatrical marketing posters, and tile/thumbnail formats.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]}}}}
```

## The MediaAttributeSource object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAttributeSource":{"$id":"media_attribute_source","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeSource","description":"Origin of a media file. `UserUpload` means the file was uploaded directly by a tenant user. `OriginImport` means the file was imported from the Origin metadata provider during a data sync.","type":"string","enum":["UserUpload","OriginImport"]}}}}
```

## The MediaAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAttributes":{"$id":"media_attributes","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributes","description":"Attributes of a media file attached to a record. Covers file identity (`fileName`, `originalFileName`, `fileExtension`, `fileSize`, `fileUrl`), content classification (`mediaType`, `mimeType`), image-specific metadata (`imageType`, `imageWidth`, `imageHeight`), and tags for organization. `source` distinguishes user-uploaded files from those imported from Origin.","type":"object","required":["mimeType","fileName","originalFileName"],"additionalProperties":false,"properties":{"mediaType":{"$ref":"#/components/schemas/MediaAttributeMediaType"},"mimeType":{"$ref":"#/components/schemas/MediaAttributeMimeType"},"originalFileName":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileExtension":{"type":"string","minLength":1},"fileSize":{"type":"number","minimum":0},"fileUrl":{"type":"string"},"key":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"},"imageWidth":{"type":"number","minimum":0},"imageHeight":{"type":"number","minimum":0},"source":{"$ref":"#/components/schemas/MediaAttributeSource"}}},"MediaAttributeMediaType":{"$id":"media_attribute_media_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMediaType","description":"High-level media category. `image` is a raster image (JPEG, PNG, etc.). `file` is a document or other non-image file (PDF, Office document, CSV). `archive` is a compressed collection of files.","type":"string","enum":["image","file","archive"]},"MediaAttributeMimeType":{"$id":"media_attribute_mime_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMimeType","description":"MIME type of the uploaded file. Only types in this enum are accepted by the platform. Supported formats include common image formats (JPEG, PNG, GIF, WebP, TIFF, AVIF, PSD), PDF, illustration and design formats (AI, INDD), and Office/spreadsheet documents.","type":"string","enum":["image/jpeg","image/png","image/vnd.adobe.photoshop","image/gif","image/avif","image/webp","image/tiff","application/pdf","text/csv","application/illustrator","application/x-indesign","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]},"MediaAttributeImageType":{"$id":"media_attribute_image_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeImageType","description":"Editorial classification for an image asset associated with a record. Used to distinguish between general photos, talent portraits, theatrical marketing posters, and tile/thumbnail formats.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"MediaAttributeSource":{"$id":"media_attribute_source","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeSource","description":"Origin of a media file. `UserUpload` means the file was uploaded directly by a tenant user. `OriginImport` means the file was imported from the Origin metadata provider during a data sync.","type":"string","enum":["UserUpload","OriginImport"]}}}}
```

## The MediaRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaRelationships","description":"JSON:API relationship links for a media resource. Contains relationships to both the owning tenant and the record this media file is attached to.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant","record"],"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},"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},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]}}}}
```

## The MediaFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaFindManyResponse","description":"Returns the media of one type for a given record. `meta.filters.mediaType` is the type listed.","type":"object","additionalProperties":false,"required":["data","meta","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":["media"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/MediaAttributes"}]},"relationships":{"$ref":"#/components/schemas/MediaRelationships"},"links":{"$ref":"#/components/schemas/LinksRelated"}}}},"meta":{"type":"object","required":["filters","expiresAt"],"properties":{"filters":{"type":"object","required":["mediaType"],"properties":{"mediaType":{"$ref":"#/components/schemas/MediaAttributeMediaType"},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"}},"additionalProperties":false},"expiresAt":{"type":"string"}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksSelf"},"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"}}},"MediaAttributes":{"$id":"media_attributes","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributes","description":"Attributes of a media file attached to a record. Covers file identity (`fileName`, `originalFileName`, `fileExtension`, `fileSize`, `fileUrl`), content classification (`mediaType`, `mimeType`), image-specific metadata (`imageType`, `imageWidth`, `imageHeight`), and tags for organization. `source` distinguishes user-uploaded files from those imported from Origin.","type":"object","required":["mimeType","fileName","originalFileName"],"additionalProperties":false,"properties":{"mediaType":{"$ref":"#/components/schemas/MediaAttributeMediaType"},"mimeType":{"$ref":"#/components/schemas/MediaAttributeMimeType"},"originalFileName":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileExtension":{"type":"string","minLength":1},"fileSize":{"type":"number","minimum":0},"fileUrl":{"type":"string"},"key":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"},"imageWidth":{"type":"number","minimum":0},"imageHeight":{"type":"number","minimum":0},"source":{"$ref":"#/components/schemas/MediaAttributeSource"}}},"MediaAttributeMediaType":{"$id":"media_attribute_media_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMediaType","description":"High-level media category. `image` is a raster image (JPEG, PNG, etc.). `file` is a document or other non-image file (PDF, Office document, CSV). `archive` is a compressed collection of files.","type":"string","enum":["image","file","archive"]},"MediaAttributeMimeType":{"$id":"media_attribute_mime_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeMimeType","description":"MIME type of the uploaded file. Only types in this enum are accepted by the platform. Supported formats include common image formats (JPEG, PNG, GIF, WebP, TIFF, AVIF, PSD), PDF, illustration and design formats (AI, INDD), and Office/spreadsheet documents.","type":"string","enum":["image/jpeg","image/png","image/vnd.adobe.photoshop","image/gif","image/avif","image/webp","image/tiff","application/pdf","text/csv","application/illustrator","application/x-indesign","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]},"MediaAttributeImageType":{"$id":"media_attribute_image_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeImageType","description":"Editorial classification for an image asset associated with a record. Used to distinguish between general photos, talent portraits, theatrical marketing posters, and tile/thumbnail formats.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"MediaAttributeSource":{"$id":"media_attribute_source","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeSource","description":"Origin of a media file. `UserUpload` means the file was uploaded directly by a tenant user. `OriginImport` means the file was imported from the Origin metadata provider during a data sync.","type":"string","enum":["UserUpload","OriginImport"]},"MediaRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaRelationships","description":"JSON:API relationship links for a media resource. Contains relationships to both the owning tenant and the record this media file is attached to.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant","record"],"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},"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},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The MediaArchiveRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaArchiveRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaArchiveRelationships","description":"Relationships for a media archive operation. Contains the list of media resource IDs that should be included in the archive.","type":"object","properties":{"media":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","enum":["media"]},"id":{"type":"string"}}}}}}},"required":["media"],"additionalProperties":false}}}}
```

## The MediaArchiveManyRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaArchiveManyRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaArchiveManyRequest","description":"Request body for archiving multiple media files in a single operation. Specifies the media resource IDs to be archived via the `relationships.media` linkage array. Archived media are soft-deleted and no longer accessible via normal media endpoints.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["archives"]},"relationships":{"$ref":"#/components/schemas/MediaArchiveRelationships"}}}},"required":["data"],"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}}}}},"MediaArchiveRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaArchiveRelationships","description":"Relationships for a media archive operation. Contains the list of media resource IDs that should be included in the archive.","type":"object","properties":{"media":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","enum":["media"]},"id":{"type":"string"}}}}}}},"required":["media"],"additionalProperties":false}}}}
```

## The MediaArchiveManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaArchiveManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaArchiveManyResponse","description":"The response for a media download many zip request.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["type","id","attributes","relationships"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["archives"]},"id":{"type":"string"},"attributes":{"type":"object","required":["url","expiresAt"],"properties":{"url":{"type":"string"},"expiresAt":{"type":"string"}},"additionalProperties":false},"relationships":{"allOf":[{"$ref":"#/components/schemas/MediaRelationships"},{"$ref":"#/components/schemas/MediaArchiveRelationships"}]}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"MediaRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaRelationships","description":"JSON:API relationship links for a media resource. Contains relationships to both the owning tenant and the record this media file is attached to.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"record":{"$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant","record"],"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},"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},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"MediaArchiveRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaArchiveRelationships","description":"Relationships for a media archive operation. Contains the list of media resource IDs that should be included in the archive.","type":"object","properties":{"media":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","enum":["media"]},"id":{"type":"string"}}}}}}},"required":["media"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The dataObjectMediaAdd object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"dataObjectMediaAdd":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":["originalFileName"],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"description":"Editorial classification applied to the image once the upload completes. Applies to images only and is ignored for other file types. Defaults to `Photo` when omitted.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"originalFileName":{"type":"string"},"fileSize":{"type":"integer","minimum":0,"description":"Size of the file in bytes. When supplied, the request is refused with a 413 if the files would not fit in the storage still available to the tenant, so the upload is never started. Omit it when the size is not known up front; the allowance is still enforced when the uploaded file is recorded."}}}},"required":["type","attributes"],"additionalProperties":false}}}}
```

## The updateRefObjectMedia object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"updateRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"additionalProperties":false}}}}
```

## The dataObjectMediaUpdate object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"dataObjectMediaUpdate":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":[],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"fileName":{"type":"string"}}}},"required":["type","id","attributes"],"additionalProperties":false}}}}
```

## The removeRefObjectMedia object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"removeRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"additionalProperties":false}}}}
```

## The MediaAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAtomicOperationsRequest","description":"JSON:API Atomic Operations request for managing media attached to a record. Supports `add` (register a new media file for upload), `update` (modify metadata of an existing media file), and `remove` (delete a media file) operations in a single request. Operations are applied sequentially.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","items":{"type":"object","oneOf":[{"properties":{"op":{"const":"add"},"data":{"$ref":"#/components/schemas/dataObjectMediaAdd"}},"required":["op","data"],"additionalProperties":false},{"properties":{"op":{"const":"update"},"ref":{"$ref":"#/components/schemas/updateRefObjectMedia"},"data":{"$ref":"#/components/schemas/dataObjectMediaUpdate"}},"required":["op","data"],"additionalProperties":false},{"properties":{"op":{"const":"remove"},"ref":{"$ref":"#/components/schemas/removeRefObjectMedia"}},"required":["op","ref"],"additionalProperties":false}]}}},"required":["atomic:operations"],"additionalProperties":false,"definitions":{"dataObjectMediaAdd":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":["originalFileName"],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"description":"Editorial classification applied to the image once the upload completes. Applies to images only and is ignored for other file types. Defaults to `Photo` when omitted.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"originalFileName":{"type":"string"},"fileSize":{"type":"integer","minimum":0,"description":"Size of the file in bytes. When supplied, the request is refused with a 413 if the files would not fit in the storage still available to the tenant, so the upload is never started. Omit it when the size is not known up front; the allowance is still enforced when the uploaded file is recorded."}}}},"required":["type","attributes"],"additionalProperties":false},"dataObjectMediaUpdate":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":[],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"fileName":{"type":"string"}}}},"required":["type","id","attributes"],"additionalProperties":false},"updateRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"additionalProperties":false},"removeRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"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}}}}},"dataObjectMediaAdd":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":["originalFileName"],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"description":"Editorial classification applied to the image once the upload completes. Applies to images only and is ignored for other file types. Defaults to `Photo` when omitted.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"originalFileName":{"type":"string"},"fileSize":{"type":"integer","minimum":0,"description":"Size of the file in bytes. When supplied, the request is refused with a 413 if the files would not fit in the storage still available to the tenant, so the upload is never started. Omit it when the size is not known up front; the allowance is still enforced when the uploaded file is recorded."}}}},"required":["type","attributes"],"additionalProperties":false},"updateRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"additionalProperties":false},"dataObjectMediaUpdate":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]},"attributes":{"type":"object","required":[],"additionalProperties":false,"properties":{"languages":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"imageType":{"type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"fileName":{"type":"string"}}}},"required":["type","id","attributes"],"additionalProperties":false},"removeRefObjectMedia":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["media"]}},"required":["id","type"],"additionalProperties":false}}}}
```

## The MediaAtomicOperationsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"MediaAtomicOperationsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAtomicOperationsResponse","description":"Response to a media atomic operations request. Each result in `atomic:results` corresponds to one operation. For `add` operations, the result includes a pre-signed S3 upload URL (`fileUrl`) and its expiration time — the client must upload the file bytes to this URL directly before the URL expires.","type":"object","properties":{"atomic:results":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"const":"uploads"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"originalFileName":{"type":"string"},"fileUrl":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}},"required":["originalFileName","fileUrl","expiresAt"],"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["atomic:results","jsonapi"],"additionalProperties":true},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordAttributes","description":"A record's attributes: timestamps, lifecycle state and, as additional properties, custom field values.","type":"object","required":["created","updated","lifecycleStatus","lifecyclePhase"],"additionalProperties":true,"properties":{"created":{"type":"string","format":"date-time","description":"When the record was created."},"updated":{"type":"string","format":"date-time","description":"When the record was last updated."},"deletedAt":{"type":"string","format":"date-time","description":"When the record was soft-deleted, if it was."},"lifecycleStatus":{"type":"string","description":"The current lifecycle status, such as draft, in-review or published."},"lifecyclePhase":{"type":"string","enum":["drafting","published"],"description":"The lifecycle phase used for authorization"}}}}}}
```

## The SecurityTagsRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagsRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationship","description":"A relationship to one or more security tags","type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]}}}}
```

## The RecordFindManyByIdsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordFindManyByIdsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordFindManyByIdsResponse","description":"Core attributes and ancestry for a batch of records, by id. Doesn't include field values: use `POST /records/search` for many records, or `GET /records/{recordId}` for one record in full.\n- Leaves out of `data` the ids not found in the tenant. Absence never means not allowed.\n- If you can't read even one of the requested records, the whole request answers 403.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","description":"One entry per record found, not in request order.","items":{"type":"object","additionalProperties":false,"required":["id","type","attributes","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"attributes":{"$ref":"#/components/schemas/RecordAttributes"},"meta":{"type":"object","additionalProperties":false,"required":["path","status"],"properties":{"path":{"type":"array","description":"The record's ancestry, root first, ending with the record itself. Carries only `id`, without ancestor titles: use `GET /records/{recordId}` for titles.","items":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"},"primaryTitle":{"type":"string"}}}},"status":{"type":"string","enum":["ACTIVE","DELETED"],"description":"The record's lifecycle status. `DELETED` means soft-deleted: the record still exists."}}},"relationships":{"type":"object","additionalProperties":false,"description":"`securityTags` is always present, with at least one tag. `parent` appears only when the record has one; top-level records such as a Movie or Series omit it.","properties":{"parent":{"$ref":"#/components/schemas/RecordRelationship"},"securityTags":{"$ref":"#/components/schemas/SecurityTagsRelationship"}},"required":["securityTags"]}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordAttributes","description":"A record's attributes: timestamps, lifecycle state and, as additional properties, custom field values.","type":"object","required":["created","updated","lifecycleStatus","lifecyclePhase"],"additionalProperties":true,"properties":{"created":{"type":"string","format":"date-time","description":"When the record was created."},"updated":{"type":"string","format":"date-time","description":"When the record was last updated."},"deletedAt":{"type":"string","format":"date-time","description":"When the record was soft-deleted, if it was."},"lifecycleStatus":{"type":"string","description":"The current lifecycle status, such as draft, in-review or published."},"lifecyclePhase":{"type":"string","enum":["drafting","published"],"description":"The lifecycle phase used for authorization"}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"SecurityTagsRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationship","description":"A relationship to one or more security tags","type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordMetadataAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordMetadataAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordMetadataAttributes","description":"Custom field values on a record, keyed by the field's `key`. Each value is a string, number, boolean, object or array, as the field defines.","type":"object","patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number","nullable":true},{"type":"boolean","nullable":true},{"type":"array","items":{"type":"string"},"nullable":true},{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":false}]}},"properties":{"primaryTitle":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status, such as draft, in-review or published."},"lifecyclePhase":{"type":"string","enum":["drafting","published"],"description":"The lifecycle phase used for authorization"},"sequenceNumber":{"type":"integer","minimum":1},"genres":{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"runLength":{"type":"number"},"releaseYear":{"type":"number"},"releaseDate":{"type":"string"},"countriesOfOrigin":{"type":"array","items":{"type":"string"}},"primarySpokenLanguage":{"type":"string"},"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}}},"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}$"}}}}
```

## The SecurityTagsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationshipRequest","description":"The security tags to set on a record. At least one is required.","type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]}}}}
```

## The NewRecordCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"NewRecordCreateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"INewRecordCreateRequest","description":"Creates a record in the v2 format, with its work type, initial metadata, and optional parent and security tags.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"attributes":{"$ref":"#/components/schemas/RecordMetadataAttributes","required":["workType","primaryTitle"]},"relationships":{"description":"Relationships to set on creation.","type":"object","properties":{"parent":{"description":"The parent record, such as a Season's Series. Omit it for a standalone record: a Movie, MovieEdit, Series, Compilation, or a limited-series Episode created directly under its Series.","$ref":"#/components/schemas/RecordRelationship"},"securityTags":{"description":"Security tags (permission groups) to apply. Defaults to the tenant's default security tag.","$ref":"#/components/schemas/SecurityTagsRelationshipRequest"},"collections":{"description":"Existing collection records, such as Compilations, to add this record to as a member. A record that is not of a collection work type answers 400. At most 99 linkages in total across `collections` and `collectionMembers`, fewer when the request also writes field values.","type":"array","maxItems":99,"items":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"collectionMembers":{"description":"This record's initial members. Only a record of a collection work type, such as `Compilation`, takes members: a non-empty list on any other answers 400. `ranking` sets each member's sort order. At most 99 linkages in total across `collections` and `collectionMembers`, fewer when the request also writes field values.","type":"array","maxItems":99,"items":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"ranking":{"type":"number"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}},"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"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}}}}},"RecordMetadataAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordMetadataAttributes","description":"Custom field values on a record, keyed by the field's `key`. Each value is a string, number, boolean, object or array, as the field defines.","type":"object","patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number","nullable":true},{"type":"boolean","nullable":true},{"type":"array","items":{"type":"string"},"nullable":true},{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":false}]}},"properties":{"primaryTitle":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status, such as draft, in-review or published."},"lifecyclePhase":{"type":"string","enum":["drafting","published"],"description":"The lifecycle phase used for authorization"},"sequenceNumber":{"type":"integer","minimum":1},"genres":{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"runLength":{"type":"number"},"releaseYear":{"type":"number"},"releaseDate":{"type":"string"},"countriesOfOrigin":{"type":"array","items":{"type":"string"}},"primarySpokenLanguage":{"type":"string"},"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}}},"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}$"},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"SecurityTagsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationshipRequest","description":"The security tags to set on a record. At least one is required.","type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]}}}}
```

## The RecordRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationships","description":"JSON:API relationships for a record resource.","type":"object","properties":{"parent":{"description":"The parent record in the hierarchy, such as an Episode's Season or a Season's Series. Absent for top-level records such as a Movie or Series.","$ref":"#/components/schemas/RecordRelationship"},"collections":{"description":"The collections this record is a member of. Fetch with `GET /records/{recordId}/collections`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"collectionMembers":{"description":"This record's collection members. Present only when the record's work type is a collection, such as `Compilation`. Fetch with `GET /records/{recordId}/collectionMembers`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"securityTags":{"description":"The security tags (permission groups) that control access to this record. Always at least one.","$ref":"#/components/schemas/SecurityTagsRelationship"},"creditLists":{"description":"The record's credit lists (cast and crew).","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"poster":{"description":"The record's poster media asset, if it has one. Follow `links.related` for the full media resource. In search responses, `meta` carries a poster summary for thumbnails; it is absent when the record has no poster.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}},"meta":{"description":"Summary of the poster media resource. Each field matches the same-named attribute there.","type":"object","properties":{"fileUrl":{"description":"URL of the poster image.","type":"string"},"imageWidth":{"description":"Width of the poster image in pixels.","type":"number","minimum":0},"imageHeight":{"description":"Height of the poster image in pixels.","type":"number","minimum":0}},"required":["fileUrl"],"additionalProperties":false}},"required":["links"],"additionalProperties":false},"tenant":{"description":"The tenant that owns this record.","$ref":"#/components/schemas/TenantRelationship"},"prevRecord":{"description":"The previous sibling under the same parent by `sequenceNumber`, such as the prior Episode in a Season. Absent for the first sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"},"nextRecord":{"description":"The next sibling under the same parent by `sequenceNumber`, such as the following Episode in a Season. Absent for the last sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant"],"additionalProperties":false},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"SecurityTagsRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationship","description":"A relationship to one or more security tags","type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]},"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}}}}
```

## The NewRecordMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"NewRecordMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"INewRecordMeta","description":"Meta for v2 record responses, including `path`: the record's ancestors from the root down to this record.","type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"primaryTitle":{"type":"string"},"workType":{"type":"string","description":"The ancestor's work type key. Absent, with its title, for a restricted ancestor."},"restricted":{"type":"boolean","enum":[true],"description":"Set when you cannot read this ancestor. Its title is omitted."}},"required":["id"],"additionalProperties":false}},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"availableLocales":{"type":"array","items":{"type":"string"}},"viewingLocale":{"type":"string","description":"The locale that decides which sections and fields the response redacts. Echoes the `viewingLocale` query parameter, default `en`. It doesn't filter content: the response always carries all locales."},"redactions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"reason":{"type":"string","enum":["unauthorized","stale"]}}}},"permissions":{"type":"object","additionalProperties":false,"description":"Hints for disabling UI actions on this record. Not an authorization decision: the server checks every action again when it runs.","properties":{"history":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean","description":"Whether you may read this record's change history."}}},"move":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean","description":"Whether you may move this record to another parent."}}}}}},"required":["path","status","availableLocales"],"additionalProperties":false}}}}
```

## The NewRecordFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"NewRecordFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"INewRecordFindOneResponse","description":"One record in the v2 format, with its hierarchy path in `meta` and a self link.","type":"object","required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"type":{"type":"string","const":"records"},"attributes":{"$ref":"#/components/schemas/RecordMetadataAttributes","required":["workType","primaryTitle"]},"relationships":{"$ref":"#/components/schemas/RecordRelationships","required":["tenant"],"additionalProperties":false}},"required":["attributes","relationships"],"additionalProperties":false}]},"meta":{"$ref":"#/components/schemas/NewRecordMeta"},"links":{"type":"object","properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"RecordMetadataAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordMetadataAttributes","description":"Custom field values on a record, keyed by the field's `key`. Each value is a string, number, boolean, object or array, as the field defines.","type":"object","patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number","nullable":true},{"type":"boolean","nullable":true},{"type":"array","items":{"type":"string"},"nullable":true},{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":false}]}},"properties":{"primaryTitle":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status, such as draft, in-review or published."},"lifecyclePhase":{"type":"string","enum":["drafting","published"],"description":"The lifecycle phase used for authorization"},"sequenceNumber":{"type":"integer","minimum":1},"genres":{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"runLength":{"type":"number"},"releaseYear":{"type":"number"},"releaseDate":{"type":"string"},"countriesOfOrigin":{"type":"array","items":{"type":"string"}},"primarySpokenLanguage":{"type":"string"},"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}}},"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}$"},"RecordRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationships","description":"JSON:API relationships for a record resource.","type":"object","properties":{"parent":{"description":"The parent record in the hierarchy, such as an Episode's Season or a Season's Series. Absent for top-level records such as a Movie or Series.","$ref":"#/components/schemas/RecordRelationship"},"collections":{"description":"The collections this record is a member of. Fetch with `GET /records/{recordId}/collections`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"collectionMembers":{"description":"This record's collection members. Present only when the record's work type is a collection, such as `Compilation`. Fetch with `GET /records/{recordId}/collectionMembers`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"securityTags":{"description":"The security tags (permission groups) that control access to this record. Always at least one.","$ref":"#/components/schemas/SecurityTagsRelationship"},"creditLists":{"description":"The record's credit lists (cast and crew).","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"poster":{"description":"The record's poster media asset, if it has one. Follow `links.related` for the full media resource. In search responses, `meta` carries a poster summary for thumbnails; it is absent when the record has no poster.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}},"meta":{"description":"Summary of the poster media resource. Each field matches the same-named attribute there.","type":"object","properties":{"fileUrl":{"description":"URL of the poster image.","type":"string"},"imageWidth":{"description":"Width of the poster image in pixels.","type":"number","minimum":0},"imageHeight":{"description":"Height of the poster image in pixels.","type":"number","minimum":0}},"required":["fileUrl"],"additionalProperties":false}},"required":["links"],"additionalProperties":false},"tenant":{"description":"The tenant that owns this record.","$ref":"#/components/schemas/TenantRelationship"},"prevRecord":{"description":"The previous sibling under the same parent by `sequenceNumber`, such as the prior Episode in a Season. Absent for the first sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"},"nextRecord":{"description":"The next sibling under the same parent by `sequenceNumber`, such as the following Episode in a Season. Absent for the last sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant"],"additionalProperties":false},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"SecurityTagsRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationship","description":"A relationship to one or more security tags","type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]},"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},"NewRecordMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"INewRecordMeta","description":"Meta for v2 record responses, including `path`: the record's ancestors from the root down to this record.","type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"primaryTitle":{"type":"string"},"workType":{"type":"string","description":"The ancestor's work type key. Absent, with its title, for a restricted ancestor."},"restricted":{"type":"boolean","enum":[true],"description":"Set when you cannot read this ancestor. Its title is omitted."}},"required":["id"],"additionalProperties":false}},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"availableLocales":{"type":"array","items":{"type":"string"}},"viewingLocale":{"type":"string","description":"The locale that decides which sections and fields the response redacts. Echoes the `viewingLocale` query parameter, default `en`. It doesn't filter content: the response always carries all locales."},"redactions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"reason":{"type":"string","enum":["unauthorized","stale"]}}}},"permissions":{"type":"object","additionalProperties":false,"description":"Hints for disabling UI actions on this record. Not an authorization decision: the server checks every action again when it runs.","properties":{"history":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean","description":"Whether you may read this record's change history."}}},"move":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean","description":"Whether you may move this record to another parent."}}}}}},"required":["path","status","availableLocales"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The NewRecordUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"NewRecordUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"INewRecordUpdateOneRequest","description":"Partially updates a record in the v2 format: core attributes, its security tags, or both.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"attributes":{"description":"Attributes to change: `primaryTitle`, `sequenceNumber`, `lifecycleStatus`, and the field keys in the tenant's record layout. Any other attribute, such as `workType`, `parentId`, `status` or timestamps, returns `400`.\n- `workType` can't change after creation.\n- To change the parent, move the record.\n- To change security tags, use `relationships.securityTags`.","type":"object","additionalProperties":true,"minProperties":1,"patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number","nullable":true},{"type":"null"},{"type":"boolean","nullable":true},{"type":"array","items":{"type":"string"},"nullable":true},{"type":"object","minProperties":1,"patternProperties":{"^.*$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"additionalProperties":false}]}},"properties":{"primaryTitle":{"type":"string","nullable":true},"workTypeDetail":{"type":"string","nullable":true},"lifecycleStatus":{"type":"string","description":"The lifecycle status, such as draft, in-review or published.","nullable":true},"sequenceNumber":{"type":"integer","nullable":true,"minimum":1},"genres":{"type":"object","minProperties":1,"nullable":true,"patternProperties":{"^.*$":{"oneOf":[{"type":"array","nullable":true,"items":{"type":"string"}},{"type":"null"}]}},"additionalProperties":false},"runLength":{"type":"number","nullable":true},"releaseYear":{"type":"number","nullable":true},"releaseDate":{"type":"string","nullable":true},"countriesOfOrigin":{"type":"array","items":{"type":"string"},"nullable":true},"primarySpokenLanguage":{"type":"string","nullable":true},"originNexusId":{"type":"string","nullable":true},"eidrId":{"type":"string","nullable":true},"imdbId":{"type":"string","nullable":true},"gracenoteId":{"type":"string","nullable":true},"tmdbId":{"type":"string","nullable":true},"wikidataId":{"type":"string","nullable":true},"wikipediaId":{"type":"string","nullable":true},"facebookId":{"type":"string","nullable":true},"xId":{"type":"string","nullable":true},"instagramId":{"type":"string","nullable":true}}},"relationships":{"description":"Relationships to replace on the record.","type":"object","additionalProperties":false,"properties":{"securityTags":{"description":"Replaces all the record's security tags with this list; `POST .../relationships/securityTags` appends instead. The list may drop tags that were since deleted. At least one existing tag must remain.","$ref":"#/components/schemas/SecurityTagsRelationshipRequest"}}}}}}},"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}}}}},"SecurityTagsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationshipRequest","description":"The security tags to set on a record. At least one is required.","type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]}}}}
```

## The ITenantLibrarySearchOperator object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ITenantLibrarySearchOperator":{"type":"string","description":"Comparison for one condition.\n- `eq`: exact match.\n- `ne`: not equal; records without a value match.\n- `contains`: token match on text fields; exact match on keyword fields such as `genres` and `path`. Prefer `eq` or `starts_with` on keyword fields.\n- `not_contains`: negation of `contains`; records without a value match.\n- `starts_with`: prefix match. Not on numeric fields, or on text fields without keyword search enabled.\n- `lt`, `lte`, `gt`, `gte`: number or date range.\n- `exists`: the field has a value.\n- `not_exists`: the field is absent or null. Use it to test for absence; `ne` also matches absent fields.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The ITenantLibrarySearchCondition object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ITenantLibrarySearchCondition":{"type":"object","properties":{"field":{"description":"A system field name or a tenant custom field key. Any name not in the enum is a custom field key; get valid keys from `GET /fields`.\n- `genres`: matched in the request's `filter.locale` (default `en`), like a localized custom field.\n- `parentId`: matches the immediate parent only.\n- `path`: the full ancestor chain, including the record's own id, joined with `|`. To match a whole subtree at any depth, such as every Season and Episode under a Series, use `starts_with` with the ancestor's record id.","oneOf":[{"type":"string","enum":["workType","workTypeDetail","primaryTitle","originNexusId","upstreamId","genres","releaseYear","sequenceNumber","created","updated","deletedAt","tenantId","recordId","status","lifecycleStatus","lifecyclePhase","parentId","path","securityTagIds","dataDeliveryPackages","workingSets","eidrId","imdbId","gracenoteId","tmdbId","wikidataId","wikipediaId","facebookId","xId","instagramId"]},{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,49}$","description":"Tenant custom field key"}]},"operator":{"$ref":"#/components/schemas/ITenantLibrarySearchOperator"},"value":{"description":"The value to match. An array with `eq` matches any of its values, not the exact array. Omit for `exists` and `not_exists`.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["field","operator"],"additionalProperties":false},"ITenantLibrarySearchOperator":{"type":"string","description":"Comparison for one condition.\n- `eq`: exact match.\n- `ne`: not equal; records without a value match.\n- `contains`: token match on text fields; exact match on keyword fields such as `genres` and `path`. Prefer `eq` or `starts_with` on keyword fields.\n- `not_contains`: negation of `contains`; records without a value match.\n- `starts_with`: prefix match. Not on numeric fields, or on text fields without keyword search enabled.\n- `lt`, `lte`, `gt`, `gte`: number or date range.\n- `exists`: the field has a value.\n- `not_exists`: the field is absent or null. Use it to test for absence; `ne` also matches absent fields.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The ITenantLibrarySearchQueryGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ITenantLibrarySearchQueryGroup":{"type":"object","properties":{"operator":{"type":"string","description":"How this node's conditions and groups combine.\n- `AND`: all must match.\n- `OR`: at least one must match.\n- `NOT`: ANDs them, then negates the result. To negate one condition alone, put it in its own `NOT` group.","enum":["AND","OR","NOT"]},"conditions":{"type":"array","description":"Leaf filters at this node, combined by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchCondition"}},"groups":{"type":"array","description":"Nested groups, combined with this node's `conditions` by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"ITenantLibrarySearchCondition":{"type":"object","properties":{"field":{"description":"A system field name or a tenant custom field key. Any name not in the enum is a custom field key; get valid keys from `GET /fields`.\n- `genres`: matched in the request's `filter.locale` (default `en`), like a localized custom field.\n- `parentId`: matches the immediate parent only.\n- `path`: the full ancestor chain, including the record's own id, joined with `|`. To match a whole subtree at any depth, such as every Season and Episode under a Series, use `starts_with` with the ancestor's record id.","oneOf":[{"type":"string","enum":["workType","workTypeDetail","primaryTitle","originNexusId","upstreamId","genres","releaseYear","sequenceNumber","created","updated","deletedAt","tenantId","recordId","status","lifecycleStatus","lifecyclePhase","parentId","path","securityTagIds","dataDeliveryPackages","workingSets","eidrId","imdbId","gracenoteId","tmdbId","wikidataId","wikipediaId","facebookId","xId","instagramId"]},{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,49}$","description":"Tenant custom field key"}]},"operator":{"$ref":"#/components/schemas/ITenantLibrarySearchOperator"},"value":{"description":"The value to match. An array with `eq` matches any of its values, not the exact array. Omit for `exists` and `not_exists`.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["field","operator"],"additionalProperties":false},"ITenantLibrarySearchOperator":{"type":"string","description":"Comparison for one condition.\n- `eq`: exact match.\n- `ne`: not equal; records without a value match.\n- `contains`: token match on text fields; exact match on keyword fields such as `genres` and `path`. Prefer `eq` or `starts_with` on keyword fields.\n- `not_contains`: negation of `contains`; records without a value match.\n- `starts_with`: prefix match. Not on numeric fields, or on text fields without keyword search enabled.\n- `lt`, `lte`, `gt`, `gte`: number or date range.\n- `exists`: the field has a value.\n- `not_exists`: the field is absent or null. Use it to test for absence; `ne` also matches absent fields.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The TenantLibrarySearchRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantLibrarySearchRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantLibrarySearchRequest","type":"object","description":"A tenant library search. `data.attributes.group` is a boolean tree of filters. See ITenantLibrarySearchQueryGroup and ITenantLibrarySearchCondition for fields and operators, and the examples for nested AND/OR/NOT, genres and hierarchy traversal.","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["searchQueries"]},"attributes":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/ITenantLibrarySearchQueryGroup"}},"required":["group"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"definitions":{"ITenantLibrarySearchOperator":{"type":"string","description":"Comparison for one condition.\n- `eq`: exact match.\n- `ne`: not equal; records without a value match.\n- `contains`: token match on text fields; exact match on keyword fields such as `genres` and `path`. Prefer `eq` or `starts_with` on keyword fields.\n- `not_contains`: negation of `contains`; records without a value match.\n- `starts_with`: prefix match. Not on numeric fields, or on text fields without keyword search enabled.\n- `lt`, `lte`, `gt`, `gte`: number or date range.\n- `exists`: the field has a value.\n- `not_exists`: the field is absent or null. Use it to test for absence; `ne` also matches absent fields.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]},"ITenantLibrarySearchCondition":{"type":"object","properties":{"field":{"description":"A system field name or a tenant custom field key. Any name not in the enum is a custom field key; get valid keys from `GET /fields`.\n- `genres`: matched in the request's `filter.locale` (default `en`), like a localized custom field.\n- `parentId`: matches the immediate parent only.\n- `path`: the full ancestor chain, including the record's own id, joined with `|`. To match a whole subtree at any depth, such as every Season and Episode under a Series, use `starts_with` with the ancestor's record id.","oneOf":[{"type":"string","enum":["workType","workTypeDetail","primaryTitle","originNexusId","upstreamId","genres","releaseYear","sequenceNumber","created","updated","deletedAt","tenantId","recordId","status","lifecycleStatus","lifecyclePhase","parentId","path","securityTagIds","dataDeliveryPackages","workingSets","eidrId","imdbId","gracenoteId","tmdbId","wikidataId","wikipediaId","facebookId","xId","instagramId"]},{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,49}$","description":"Tenant custom field key"}]},"operator":{"$ref":"#/components/schemas/ITenantLibrarySearchOperator"},"value":{"description":"The value to match. An array with `eq` matches any of its values, not the exact array. Omit for `exists` and `not_exists`.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["field","operator"],"additionalProperties":false},"ITenantLibrarySearchQueryGroup":{"type":"object","properties":{"operator":{"type":"string","description":"How this node's conditions and groups combine.\n- `AND`: all must match.\n- `OR`: at least one must match.\n- `NOT`: ANDs them, then negates the result. To negate one condition alone, put it in its own `NOT` group.","enum":["AND","OR","NOT"]},"conditions":{"type":"array","description":"Leaf filters at this node, combined by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchCondition"}},"groups":{"type":"array","description":"Nested groups, combined with this node's `conditions` by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"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}}}}},"ITenantLibrarySearchQueryGroup":{"type":"object","properties":{"operator":{"type":"string","description":"How this node's conditions and groups combine.\n- `AND`: all must match.\n- `OR`: at least one must match.\n- `NOT`: ANDs them, then negates the result. To negate one condition alone, put it in its own `NOT` group.","enum":["AND","OR","NOT"]},"conditions":{"type":"array","description":"Leaf filters at this node, combined by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchCondition"}},"groups":{"type":"array","description":"Nested groups, combined with this node's `conditions` by its `operator`.","items":{"$ref":"#/components/schemas/ITenantLibrarySearchQueryGroup"}}},"required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false},"ITenantLibrarySearchCondition":{"type":"object","properties":{"field":{"description":"A system field name or a tenant custom field key. Any name not in the enum is a custom field key; get valid keys from `GET /fields`.\n- `genres`: matched in the request's `filter.locale` (default `en`), like a localized custom field.\n- `parentId`: matches the immediate parent only.\n- `path`: the full ancestor chain, including the record's own id, joined with `|`. To match a whole subtree at any depth, such as every Season and Episode under a Series, use `starts_with` with the ancestor's record id.","oneOf":[{"type":"string","enum":["workType","workTypeDetail","primaryTitle","originNexusId","upstreamId","genres","releaseYear","sequenceNumber","created","updated","deletedAt","tenantId","recordId","status","lifecycleStatus","lifecyclePhase","parentId","path","securityTagIds","dataDeliveryPackages","workingSets","eidrId","imdbId","gracenoteId","tmdbId","wikidataId","wikipediaId","facebookId","xId","instagramId"]},{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,49}$","description":"Tenant custom field key"}]},"operator":{"$ref":"#/components/schemas/ITenantLibrarySearchOperator"},"value":{"description":"The value to match. An array with `eq` matches any of its values, not the exact array. Omit for `exists` and `not_exists`.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"required":["field","operator"],"additionalProperties":false},"ITenantLibrarySearchOperator":{"type":"string","description":"Comparison for one condition.\n- `eq`: exact match.\n- `ne`: not equal; records without a value match.\n- `contains`: token match on text fields; exact match on keyword fields such as `genres` and `path`. Prefer `eq` or `starts_with` on keyword fields.\n- `not_contains`: negation of `contains`; records without a value match.\n- `starts_with`: prefix match. Not on numeric fields, or on text fields without keyword search enabled.\n- `lt`, `lte`, `gt`, `gte`: number or date range.\n- `exists`: the field has a value.\n- `not_exists`: the field is absent or null. Use it to test for absence; `ne` also matches absent fields.","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The OpenSearchTenantLibraryCommonFields object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"OpenSearchTenantLibraryCommonFields":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IOpenSearchTenantLibraryCommonFields","description":"Fields every library search index entry shares: timestamps, work type, lifecycle state and primary title.","type":"object","properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"workType":{"type":"string"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status"},"lifecyclePhase":{"type":"string","description":"The current lifecycle phase"},"primaryTitle":{"type":"string"},"sequenceNumber":{"type":"integer"},"releaseYear":{"type":"integer"}},"additionalProperties":false}}}}
```

## The RecordCommonIdentifierAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordCommonIdentifierAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCommonIdentifierAttributes","description":"Identifier attributes common to all records.","type":"object","properties":{"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}},"additionalProperties":false}}}}
```

## The TenantLibraryRecordAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantLibraryRecordAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantLibraryRecordAttributes","description":"A record's fields in a library search result. Empty when you cannot read the record.","type":"object","allOf":[{"$ref":"#/components/schemas/OpenSearchTenantLibraryCommonFields"},{"$ref":"#/components/schemas/RecordCommonIdentifierAttributes"},{"type":"object","properties":{"genres":{"type":"object","patternProperties":{"^.*$":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}]},"OpenSearchTenantLibraryCommonFields":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IOpenSearchTenantLibraryCommonFields","description":"Fields every library search index entry shares: timestamps, work type, lifecycle state and primary title.","type":"object","properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"workType":{"type":"string"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status"},"lifecyclePhase":{"type":"string","description":"The current lifecycle phase"},"primaryTitle":{"type":"string"},"sequenceNumber":{"type":"integer"},"releaseYear":{"type":"integer"}},"additionalProperties":false},"RecordCommonIdentifierAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCommonIdentifierAttributes","description":"Identifier attributes common to all records.","type":"object","properties":{"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}},"additionalProperties":false}}}}
```

## The RecordMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordMeta","description":"Record metadata outside its attributes. `path` is the record's ancestry, such as Series, then Season, for an Episode.","type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"primaryTitle":{"type":"string"},"restricted":{"type":"boolean","enum":[true],"description":"Set when you cannot read this ancestor. Its title is omitted."}},"required":["id"],"additionalProperties":false}},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"availableLocales":{"type":"array","items":{"type":"string"}},"tenantId":{"type":"string"},"childrenStats":{"type":"object","properties":{"count":{"type":"object","additionalProperties":{"type":"number"}}},"additionalProperties":false},"redactions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"reason":{"type":"string","enum":["unauthorized"]}}}}},"required":["path","status","availableLocales"],"additionalProperties":false}}}}
```

## The TenantLibrarySearchResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantLibrarySearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantLibrarySearchResponse","description":"A page of matching records, with the total count in `meta`.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"attributes":{"$ref":"#/components/schemas/TenantLibraryRecordAttributes"},"relationships":{"$ref":"#/components/schemas/RecordRelationships"},"meta":{"$ref":"#/components/schemas/RecordMeta"},"links":{"$ref":"#/components/schemas/LinksSelf"}}},"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"perPage":{"type":"integer"},"unauthorizedCount":{"type":"integer"},"sort":{"$ref":"#/components/schemas/SearchSortMeta"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","meta","jsonapi"],"additionalProperties":false},"TenantLibraryRecordAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantLibraryRecordAttributes","description":"A record's fields in a library search result. Empty when you cannot read the record.","type":"object","allOf":[{"$ref":"#/components/schemas/OpenSearchTenantLibraryCommonFields"},{"$ref":"#/components/schemas/RecordCommonIdentifierAttributes"},{"type":"object","properties":{"genres":{"type":"object","patternProperties":{"^.*$":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}]},"OpenSearchTenantLibraryCommonFields":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IOpenSearchTenantLibraryCommonFields","description":"Fields every library search index entry shares: timestamps, work type, lifecycle state and primary title.","type":"object","properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"workType":{"type":"string"},"workTypeDetail":{"type":"string"},"lifecycleStatus":{"type":"string","description":"The current lifecycle status"},"lifecyclePhase":{"type":"string","description":"The current lifecycle phase"},"primaryTitle":{"type":"string"},"sequenceNumber":{"type":"integer"},"releaseYear":{"type":"integer"}},"additionalProperties":false},"RecordCommonIdentifierAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCommonIdentifierAttributes","description":"Identifier attributes common to all records.","type":"object","properties":{"originNexusId":{"type":"string"},"eidrId":{"type":"string"},"imdbId":{"type":"string"},"gracenoteId":{"type":"string"},"tmdbId":{"type":"string"},"wikidataId":{"type":"string"},"wikipediaId":{"type":"string"},"facebookId":{"type":"string"},"xId":{"type":"string"},"instagramId":{"type":"string"},"upstreamId":{"type":"string"}},"additionalProperties":false},"RecordRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationships","description":"JSON:API relationships for a record resource.","type":"object","properties":{"parent":{"description":"The parent record in the hierarchy, such as an Episode's Season or a Season's Series. Absent for top-level records such as a Movie or Series.","$ref":"#/components/schemas/RecordRelationship"},"collections":{"description":"The collections this record is a member of. Fetch with `GET /records/{recordId}/collections`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"collectionMembers":{"description":"This record's collection members. Present only when the record's work type is a collection, such as `Compilation`. Fetch with `GET /records/{recordId}/collectionMembers`.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"securityTags":{"description":"The security tags (permission groups) that control access to this record. Always at least one.","$ref":"#/components/schemas/SecurityTagsRelationship"},"creditLists":{"description":"The record's credit lists (cast and crew).","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["links"],"additionalProperties":false},"poster":{"description":"The record's poster media asset, if it has one. Follow `links.related` for the full media resource. In search responses, `meta` carries a poster summary for thumbnails; it is absent when the record has no poster.","type":"object","properties":{"links":{"type":"object","properties":{"related":{"type":"string"}}},"meta":{"description":"Summary of the poster media resource. Each field matches the same-named attribute there.","type":"object","properties":{"fileUrl":{"description":"URL of the poster image.","type":"string"},"imageWidth":{"description":"Width of the poster image in pixels.","type":"number","minimum":0},"imageHeight":{"description":"Height of the poster image in pixels.","type":"number","minimum":0}},"required":["fileUrl"],"additionalProperties":false}},"required":["links"],"additionalProperties":false},"tenant":{"description":"The tenant that owns this record.","$ref":"#/components/schemas/TenantRelationship"},"prevRecord":{"description":"The previous sibling under the same parent by `sequenceNumber`, such as the prior Episode in a Season. Absent for the first sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"},"nextRecord":{"description":"The next sibling under the same parent by `sequenceNumber`, such as the following Episode in a Season. Absent for the last sibling or a record without siblings.","$ref":"#/components/schemas/RecordRelationship"}},"required":["tenant"],"additionalProperties":false},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"SecurityTagsRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagsRelationship","description":"A relationship to one or more security tags","type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}},"additionalProperties":false,"required":["data"]},"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},"RecordMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordMeta","description":"Record metadata outside its attributes. `path` is the record's ancestry, such as Series, then Season, for an Episode.","type":"object","properties":{"path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"primaryTitle":{"type":"string"},"restricted":{"type":"boolean","enum":[true],"description":"Set when you cannot read this ancestor. Its title is omitted."}},"required":["id"],"additionalProperties":false}},"status":{"type":"string","enum":["ACTIVE","DELETED"]},"availableLocales":{"type":"array","items":{"type":"string"}},"tenantId":{"type":"string"},"childrenStats":{"type":"object","properties":{"count":{"type":"object","additionalProperties":{"type":"number"}}},"additionalProperties":false},"redactions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"reason":{"type":"string","enum":["unauthorized"]}}}}},"required":["path","status","availableLocales"],"additionalProperties":false},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"SearchSortMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchSortMeta","description":"The ordering applied to the search results. Every search response carries it, whether or not the request asked for an ordering.","type":"object","properties":{"applied":{"type":"string","description":"The ordering applied, in the `sort` parameter's comma-separated syntax. Pass it back as `sort` to keep the ordering fixed across later requests."},"default":{"type":"boolean","description":"`true` when the request had no `sort` and the server chose the ordering; `false` when it reflects the `sort` you sent."}},"required":["applied","default"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The IRecordIdJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordIdJobParameters":{"type":"object","description":"Parameters for `deleteRecord`, `restoreRecord` and `permanentlyDeleteRecord`: the target record id only.","properties":{"recordId":{"type":"string"}},"required":["recordId"],"additionalProperties":false}}}}
```

## The IRecordCreateFromScratchLeafRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"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}$"}}}}
```

## The IRecordCreateFromScratchChildRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordCreateFromScratchChildRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchLeafRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"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}$"},"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false}}}}
```

## The IRecordCreateFromScratchRecord object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordCreateFromScratchRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchChildRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"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}$"},"IRecordCreateFromScratchChildRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchLeafRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false}}}}
```

## The IRecordCreateRecordFromScratchJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordCreateRecordFromScratchJobParameters":{"description":"Creates records and the records under them, up to three levels: `records`, their `children`, and those children's `children`.","type":"object","properties":{"parentRecordId":{"description":"An existing record to create `records` under. Required when `records` holds more than one record.","type":"string"},"collections":{"description":"Collections every record in `records` joins. Records below them join none.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}},"records":{"description":"The top-level records: one, or several under `parentRecordId`. Every record in the tree counts toward the limit of 500.","type":"array","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/IRecordCreateFromScratchRecord"}}},"required":["records"],"additionalProperties":false},"IRecordCreateFromScratchRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchChildRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"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}$"},"IRecordCreateFromScratchChildRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchLeafRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false}}}}
```

## The IRecordCreateMediaFromUrlJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordCreateMediaFromUrlJobParameters":{"type":"object","properties":{"urls":{"description":"Media URLs to fetch and attach, at least one. Each must be `https` on an approved media host; the job rejects any other URL without fetching it, reports each rejection, and still runs the other URLs.","type":"array","items":{"type":"string","format":"uri"},"maxItems":100},"recordId":{"type":"string"},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"},"locale":{"description":"BCP 47 language tag of the fetched media, such as `en`, `pt-br` or `zh-Hans`. Applies to every URL in `urls`. The server maps it to a supported locale and drops an unrecognized value rather than defaulting it.","type":"string"}},"required":["urls","recordId","imageType"],"additionalProperties":false},"MediaAttributeImageType":{"$id":"media_attribute_image_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeImageType","description":"Editorial classification for an image asset associated with a record. Used to distinguish between general photos, talent portraits, theatrical marketing posters, and tile/thumbnail formats.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]}}}}
```

## The IRecordMigrateLifecycleStatusJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordMigrateLifecycleStatusJobParameters":{"type":"object","properties":{"oldLifecycleStatus":{"type":"string"},"newLifecycleStatus":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"}},"required":["oldLifecycleStatus","newLifecycleStatus","workType"],"additionalProperties":false},"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}$"}}}}
```

## The IImportSeriesOriginNexusJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IImportSeriesOriginNexusJobParameters":{"type":"object","properties":{"seriesId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls Origin Nexus import depth and series-level media/credits.","properties":{"seriesOnly":{"type":"boolean","description":"`true` imports the series record only, without seasons and episodes. Defaults to the full hierarchy."},"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["seriesId"],"additionalProperties":false}}}}
```

## The IImportMoviesOriginNexusJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IImportMoviesOriginNexusJobParameters":{"type":"object","properties":{"movieId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls movie-level media/credits import.","properties":{"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["movieId"],"additionalProperties":false}}}}
```

## The IRecordBulkEditJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordBulkEditJobParameters":{"type":"object","description":"Applies the same field edits, in one locale, to every record the selection matches. The server resolves the selection to record ids, then edits each record.","properties":{"locale":{"type":"string","description":"The locale all edits target, such as `en`. Required only when an edit targets a localized field; without it, that field's edit fails."},"edits":{"type":"array","minItems":1,"description":"Field edits applied to every selected record.\n- `overwrite`: replaces the field value in the job locale. Needs `value`.\n- `delete`: clears it.","items":{"type":"object","properties":{"fieldKey":{"type":"string"},"action":{"type":"string","enum":["overwrite","delete"]},"value":{"description":"New value for `overwrite`; `delete` ignores it. Any JSON; the server validates it against the field on write."}},"required":["fieldKey","action"],"additionalProperties":false}},"selection":{"type":"object","description":"The Library selection to edit.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["edits","selection"],"additionalProperties":false}}}}
```

## The IDeleteAlternateRunningOrderJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IDeleteAlternateRunningOrderJobParameters":{"type":"object","description":"Identifies one alternate running order to delete.","additionalProperties":false,"required":["recordId","alternateRunningOrderId"],"properties":{"recordId":{"type":"string","description":"The parent Season, or seasonless Series, that owns the running order."},"alternateRunningOrderId":{"type":"string","description":"The alternate running order to delete."}}}}}}
```

## The IMoveRecordJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IMoveRecordJobParameters":{"type":"object","description":"Moves one or more records that share a parent, together with every record below them, under another parent.","additionalProperties":false,"required":["recordIds","targetParentId"],"properties":{"recordIds":{"type":"array","description":"The records to move, at most 25. They must all have the same current parent. Their descendants move with them.","items":{"type":"string"},"minItems":1,"maxItems":25,"uniqueItems":true},"targetParentId":{"type":"string","description":"The new parent. It must be an active record whose work type may hold every moved record's work type, and it cannot be one of the moved records, one of their descendants, or their current parent."}}}}}}
```

## The IRecordBulkEditPermissionGroupsJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IRecordBulkEditPermissionGroupsJobParameters":{"type":"object","description":"Adds and removes permission groups on every record the selection matches. The server resolves the selection to record ids, then changes each record. Groups not listed stay as they are, including groups you can't read. A record you can't edit, one that would end with no group or more than 100, or one deleted before the job reaches it is skipped and reported.","properties":{"addSecurityTagIds":{"type":"array","description":"Permission groups to add to every selected record. A record that already has one is left as it is for that group. Send `[]` to add none.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"removeSecurityTagIds":{"type":"array","description":"Permission groups to remove from every selected record. A record without one is left as it is for that group. Send `[]` to remove none. A group can't be in both lists.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"selection":{"type":"object","description":"The Library selection to change.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["addSecurityTagIds","removeSecurityTagIds","selection"],"additionalProperties":false}}}}
```

## The CreateRecordJobRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateRecordJobRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCreateJobRequest","description":"Starts a record background job. Set `type` and its `parameters`, then poll `GET /backgroundJobs/{jobId}`.","type":"object","definitions":{"IRecordIdJobParameters":{"type":"object","description":"Parameters for `deleteRecord`, `restoreRecord` and `permanentlyDeleteRecord`: the target record id only.","properties":{"recordId":{"type":"string"}},"required":["recordId"],"additionalProperties":false},"IRecordCreateRecordFromScratchJobParameters":{"description":"Creates records and the records under them, up to three levels: `records`, their `children`, and those children's `children`.","type":"object","properties":{"parentRecordId":{"description":"An existing record to create `records` under. Required when `records` holds more than one record.","type":"string"},"collections":{"description":"Collections every record in `records` joins. Records below them join none.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}},"records":{"description":"The top-level records: one, or several under `parentRecordId`. Every record in the tree counts toward the limit of 500.","type":"array","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/IRecordCreateFromScratchRecord"}}},"required":["records"],"additionalProperties":false},"IRecordCreateFromScratchRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchChildRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateFromScratchChildRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchLeafRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateMediaFromUrlJobParameters":{"type":"object","properties":{"urls":{"description":"Media URLs to fetch and attach, at least one. Each must be `https` on an approved media host; the job rejects any other URL without fetching it, reports each rejection, and still runs the other URLs.","type":"array","items":{"type":"string","format":"uri"},"maxItems":100},"recordId":{"type":"string"},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"},"locale":{"description":"BCP 47 language tag of the fetched media, such as `en`, `pt-br` or `zh-Hans`. Applies to every URL in `urls`. The server maps it to a supported locale and drops an unrecognized value rather than defaulting it.","type":"string"}},"required":["urls","recordId","imageType"],"additionalProperties":false},"IRecordMigrateLifecycleStatusJobParameters":{"type":"object","properties":{"oldLifecycleStatus":{"type":"string"},"newLifecycleStatus":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"}},"required":["oldLifecycleStatus","newLifecycleStatus","workType"],"additionalProperties":false},"IImportSeriesOriginNexusJobParameters":{"type":"object","properties":{"seriesId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls Origin Nexus import depth and series-level media/credits.","properties":{"seriesOnly":{"type":"boolean","description":"`true` imports the series record only, without seasons and episodes. Defaults to the full hierarchy."},"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["seriesId"],"additionalProperties":false},"IImportMoviesOriginNexusJobParameters":{"type":"object","properties":{"movieId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls movie-level media/credits import.","properties":{"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["movieId"],"additionalProperties":false},"IRecordBulkEditJobParameters":{"type":"object","description":"Applies the same field edits, in one locale, to every record the selection matches. The server resolves the selection to record ids, then edits each record.","properties":{"locale":{"type":"string","description":"The locale all edits target, such as `en`. Required only when an edit targets a localized field; without it, that field's edit fails."},"edits":{"type":"array","minItems":1,"description":"Field edits applied to every selected record.\n- `overwrite`: replaces the field value in the job locale. Needs `value`.\n- `delete`: clears it.","items":{"type":"object","properties":{"fieldKey":{"type":"string"},"action":{"type":"string","enum":["overwrite","delete"]},"value":{"description":"New value for `overwrite`; `delete` ignores it. Any JSON; the server validates it against the field on write."}},"required":["fieldKey","action"],"additionalProperties":false}},"selection":{"type":"object","description":"The Library selection to edit.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["edits","selection"],"additionalProperties":false},"IRecordBulkEditPermissionGroupsJobParameters":{"type":"object","description":"Adds and removes permission groups on every record the selection matches. The server resolves the selection to record ids, then changes each record. Groups not listed stay as they are, including groups you can't read. A record you can't edit, one that would end with no group or more than 100, or one deleted before the job reaches it is skipped and reported.","properties":{"addSecurityTagIds":{"type":"array","description":"Permission groups to add to every selected record. A record that already has one is left as it is for that group. Send `[]` to add none.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"removeSecurityTagIds":{"type":"array","description":"Permission groups to remove from every selected record. A record without one is left as it is for that group. Send `[]` to remove none. A group can't be in both lists.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"selection":{"type":"object","description":"The Library selection to change.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["addSecurityTagIds","removeSecurityTagIds","selection"],"additionalProperties":false},"IDeleteAlternateRunningOrderJobParameters":{"type":"object","description":"Identifies one alternate running order to delete.","additionalProperties":false,"required":["recordId","alternateRunningOrderId"],"properties":{"recordId":{"type":"string","description":"The parent Season, or seasonless Series, that owns the running order."},"alternateRunningOrderId":{"type":"string","description":"The alternate running order to delete."}}},"IMoveRecordJobParameters":{"type":"object","description":"Moves one or more records that share a parent, together with every record below them, under another parent.","additionalProperties":false,"required":["recordIds","targetParentId"],"properties":{"recordIds":{"type":"array","description":"The records to move, at most 25. They must all have the same current parent. Their descendants move with them.","items":{"type":"string"},"minItems":1,"maxItems":25,"uniqueItems":true},"targetParentId":{"type":"string","description":"The new parent. It must be an active record whose work type may hold every moved record's work type, and it cannot be one of the moved records, one of their descendants, or their current parent."}}}},"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"type":"object","properties":{"attributes":{"type":"object","properties":{"type":{"type":"string","description":"The job to run; it decides the shape of `parameters`.\n- `deleteRecord`: deletes the record and its whole hierarchy (a Series with its Seasons and Episodes). Takes `recordId`.\n- `restoreRecord`: restores that hierarchy. Takes `recordId`.\n- `permanentlyDeleteRecord`: deletes the record and its whole hierarchy for good; you can't undo it. Takes `recordId`.\n- `createRecordFromScratch`: creates records with the records under them (up to three levels), optionally under an existing parent and in collections.\n- `createMediaFromUrl`: fetches media from external URLs and attaches it.\n- `migrateRecordLifecycleStatus`: moves every record of a work type from one lifecycle status to another.\n- `importSeriesOriginNexus`, `importMoviesOriginNexus`: imports a Series or Movie, with its hierarchy, from Origin Nexus by its Origin Nexus id.\n- `deleteAlternateRunningOrder`: deletes one alternate running order and all its Episode entries for good. Takes `recordId` (the parent Season or seasonless Series) and `alternateRunningOrderId`. Deletes no Episode record and leaves the canonical order unchanged.\n- `moveRecord`: moves `recordIds` (records that share a parent) and their whole hierarchies under `targetParentId`, keeping every id, field value, sequence number and relationship.\n- `bulkEditPermissionGroups`: adds `addSecurityTagIds` to, and removes `removeSecurityTagIds` from, the permission groups of every record in `selection`.","enum":["deleteRecord","restoreRecord","permanentlyDeleteRecord","createRecordFromScratch","createMediaFromUrl","migrateRecordLifecycleStatus","importSeriesOriginNexus","importMoviesOriginNexus","bulkEditRecords","deleteAlternateRunningOrder","moveRecord","bulkEditPermissionGroups"]},"parameters":{"description":"Job parameters; the shape depends on `type`.","oneOf":[{"$ref":"#/components/schemas/IRecordIdJobParameters"},{"$ref":"#/components/schemas/IRecordCreateRecordFromScratchJobParameters"},{"$ref":"#/components/schemas/IRecordCreateMediaFromUrlJobParameters"},{"$ref":"#/components/schemas/IRecordMigrateLifecycleStatusJobParameters"},{"$ref":"#/components/schemas/IImportSeriesOriginNexusJobParameters"},{"$ref":"#/components/schemas/IImportMoviesOriginNexusJobParameters"},{"$ref":"#/components/schemas/IRecordBulkEditJobParameters"},{"$ref":"#/components/schemas/IDeleteAlternateRunningOrderJobParameters"},{"$ref":"#/components/schemas/IMoveRecordJobParameters"},{"$ref":"#/components/schemas/IRecordBulkEditPermissionGroupsJobParameters"}]}},"required":["type","parameters"],"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"required":["data"],"additionalProperties":false},"IRecordCreateFromScratchRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchChildRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"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}$"},"IRecordCreateFromScratchChildRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}},"children":{"description":"Records to create under this one. Each child's work type must list this record's work type among its valid parents.","type":"array","items":{"$ref":"#/components/schemas/IRecordCreateFromScratchLeafRecord"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"IRecordCreateFromScratchLeafRecord":{"type":"object","properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string","minLength":1},"sequenceNumber":{"description":"Sequence No. among this record's siblings of the same work type, for a numbered work type (Season, Episode, or a numbered custom type). Defaults to the next free number.","type":"integer","minimum":0},"releaseYear":{"type":"number"},"workTypeDetail":{"type":"string"},"securityTags":{"description":"Permission group ids. Defaults to the parent's: the record above it, or `parentRecordId` for a top-level record, or the main catalog without a parent.","type":"array","items":{"type":"string"}},"editClass":{"description":"Built-in work types only.","type":"string"},"intendedTerritories":{"description":"Built-in work types only.","type":"array","items":{"type":"string"}}},"required":["workType","primaryTitle"],"additionalProperties":false},"MediaAttributeImageType":{"$id":"media_attribute_image_type","$schema":"http://json-schema.org/draft-07/schema#","title":"IMediaAttributeImageType","description":"Editorial classification for an image asset associated with a record. Used to distinguish between general photos, talent portraits, theatrical marketing posters, and tile/thumbnail formats.","type":"string","enum":["Photo","Portrait","Poster","Theatrical Poster","Tile"]},"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"]},"IRecordIdJobParameters":{"type":"object","description":"Parameters for `deleteRecord`, `restoreRecord` and `permanentlyDeleteRecord`: the target record id only.","properties":{"recordId":{"type":"string"}},"required":["recordId"],"additionalProperties":false},"IRecordCreateRecordFromScratchJobParameters":{"description":"Creates records and the records under them, up to three levels: `records`, their `children`, and those children's `children`.","type":"object","properties":{"parentRecordId":{"description":"An existing record to create `records` under. Required when `records` holds more than one record.","type":"string"},"collections":{"description":"Collections every record in `records` joins. Records below them join none.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}},"records":{"description":"The top-level records: one, or several under `parentRecordId`. Every record in the tree counts toward the limit of 500.","type":"array","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/IRecordCreateFromScratchRecord"}}},"required":["records"],"additionalProperties":false},"IRecordCreateMediaFromUrlJobParameters":{"type":"object","properties":{"urls":{"description":"Media URLs to fetch and attach, at least one. Each must be `https` on an approved media host; the job rejects any other URL without fetching it, reports each rejection, and still runs the other URLs.","type":"array","items":{"type":"string","format":"uri"},"maxItems":100},"recordId":{"type":"string"},"imageType":{"$ref":"#/components/schemas/MediaAttributeImageType"},"locale":{"description":"BCP 47 language tag of the fetched media, such as `en`, `pt-br` or `zh-Hans`. Applies to every URL in `urls`. The server maps it to a supported locale and drops an unrecognized value rather than defaulting it.","type":"string"}},"required":["urls","recordId","imageType"],"additionalProperties":false},"IRecordMigrateLifecycleStatusJobParameters":{"type":"object","properties":{"oldLifecycleStatus":{"type":"string"},"newLifecycleStatus":{"type":"string"},"workType":{"$ref":"#/components/schemas/WorkTypes"}},"required":["oldLifecycleStatus","newLifecycleStatus","workType"],"additionalProperties":false},"IImportSeriesOriginNexusJobParameters":{"type":"object","properties":{"seriesId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls Origin Nexus import depth and series-level media/credits.","properties":{"seriesOnly":{"type":"boolean","description":"`true` imports the series record only, without seasons and episodes. Defaults to the full hierarchy."},"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["seriesId"],"additionalProperties":false},"IImportMoviesOriginNexusJobParameters":{"type":"object","properties":{"movieId":{"type":"string"},"securityTags":{"type":"array","items":{"type":"string"}},"importOptions":{"type":"object","description":"Controls movie-level media/credits import.","properties":{"importCredits":{"type":"boolean","description":"`false` skips credits and linked contributors from Origin Nexus. Defaults to importing them."},"importImages":{"type":"boolean","description":"`false` skips poster and cover images. Defaults to importing them."}},"additionalProperties":false}},"required":["movieId"],"additionalProperties":false},"IRecordBulkEditJobParameters":{"type":"object","description":"Applies the same field edits, in one locale, to every record the selection matches. The server resolves the selection to record ids, then edits each record.","properties":{"locale":{"type":"string","description":"The locale all edits target, such as `en`. Required only when an edit targets a localized field; without it, that field's edit fails."},"edits":{"type":"array","minItems":1,"description":"Field edits applied to every selected record.\n- `overwrite`: replaces the field value in the job locale. Needs `value`.\n- `delete`: clears it.","items":{"type":"object","properties":{"fieldKey":{"type":"string"},"action":{"type":"string","enum":["overwrite","delete"]},"value":{"description":"New value for `overwrite`; `delete` ignores it. Any JSON; the server validates it against the field on write."}},"required":["fieldKey","action"],"additionalProperties":false}},"selection":{"type":"object","description":"The Library selection to edit.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["edits","selection"],"additionalProperties":false},"IDeleteAlternateRunningOrderJobParameters":{"type":"object","description":"Identifies one alternate running order to delete.","additionalProperties":false,"required":["recordId","alternateRunningOrderId"],"properties":{"recordId":{"type":"string","description":"The parent Season, or seasonless Series, that owns the running order."},"alternateRunningOrderId":{"type":"string","description":"The alternate running order to delete."}}},"IMoveRecordJobParameters":{"type":"object","description":"Moves one or more records that share a parent, together with every record below them, under another parent.","additionalProperties":false,"required":["recordIds","targetParentId"],"properties":{"recordIds":{"type":"array","description":"The records to move, at most 25. They must all have the same current parent. Their descendants move with them.","items":{"type":"string"},"minItems":1,"maxItems":25,"uniqueItems":true},"targetParentId":{"type":"string","description":"The new parent. It must be an active record whose work type may hold every moved record's work type, and it cannot be one of the moved records, one of their descendants, or their current parent."}}},"IRecordBulkEditPermissionGroupsJobParameters":{"type":"object","description":"Adds and removes permission groups on every record the selection matches. The server resolves the selection to record ids, then changes each record. Groups not listed stay as they are, including groups you can't read. A record you can't edit, one that would end with no group or more than 100, or one deleted before the job reaches it is skipped and reported.","properties":{"addSecurityTagIds":{"type":"array","description":"Permission groups to add to every selected record. A record that already has one is left as it is for that group. Send `[]` to add none.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"removeSecurityTagIds":{"type":"array","description":"Permission groups to remove from every selected record. A record without one is left as it is for that group. Send `[]` to remove none. A group can't be in both lists.","items":{"type":"string"},"maxItems":100,"uniqueItems":true},"selection":{"type":"object","description":"The Library selection to change.\n- With `searchGroup`: every matching record, minus `excludeRecordIds`, plus `includeRecordIds`.\n- Without it: only `includeRecordIds`.","properties":{"searchGroup":{"type":"object","description":"Boolean query tree (ITenantLibrarySearchQueryGroup) for an all-in-view or hierarchy selection; omit it for a manual selection. The job validates it when it runs the search.","additionalProperties":true},"includeRecordIds":{"type":"array","items":{"type":"string"}},"excludeRecordIds":{"type":"array","items":{"type":"string"}}},"required":[],"additionalProperties":false}},"required":["addSecurityTagIds","removeSecurityTagIds","selection"],"additionalProperties":false}}}}
```

## The RecordJob object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordJob","description":"A record background job: the base job attributes plus a record job `type` and its `parameters`.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["deleteRecord","restoreRecord","permanentlyDeleteRecord","createRecordFromScratch","createMediaFromUrl","migrateRecordLifecycleStatus","importSeriesOriginNexus","importMoviesOriginNexus","bulkEditRecords","deleteAlternateRunningOrder","moveRecord","bulkEditPermissionGroups"]},"parameters":{"type":"object","oneOf":[{"properties":{"recordId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation, so it stays readable after a delete. Display only."}},"required":["recordId","tenantId"],"additionalProperties":false},{"properties":{"seriesId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the primary title of the Origin Nexus record to import, at job creation. Display only."}},"required":["seriesId","tenantId"],"additionalProperties":false},{"properties":{"movieId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the primary title of the Origin Nexus record to import, at job creation. Display only."}},"required":["movieId","tenantId"],"additionalProperties":false},{"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation. Display only."}},"required":["recordId","workType","tenantId"],"additionalProperties":false},{"properties":{"tenantId":{"type":"string"},"recordId":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation. Display only."}},"required":["urls","tenantId","recordId"],"additionalProperties":false},{"properties":{"tenantId":{"type":"string"},"oldLifecycleStatus":{"type":"string"},"newLifecycleStatus":{"type":"string"}},"required":["tenantId","oldLifecycleStatus","newLifecycleStatus"],"additionalProperties":false},{"description":"`bulkEditRecords` parameters as stored on the job, including the server-set `tenantId` and `jobId`.","properties":{"tenantId":{"type":"string"},"jobId":{"type":"string"},"locale":{"type":"string"},"edits":{"type":"array","items":{"type":"object","properties":{"fieldKey":{"type":"string"},"action":{"type":"string","enum":["overwrite","delete"]},"value":{}},"required":["fieldKey","action"],"additionalProperties":false}},"selection":{"type":"object","additionalProperties":true}},"required":["tenantId","edits","selection"],"additionalProperties":true},{"properties":{"targetParentId":{"type":"string"},"previousParentId":{"type":"string","description":"The moved records' shared parent before the move."},"moves":{"type":"array","description":"One entry per moved record.","items":{"type":"object","properties":{"recordId":{"type":"string"},"previousPath":{"type":"string","description":"The record's hierarchy path (ancestor ids, root first) before the move."},"newPath":{"type":"string","description":"The record's hierarchy path once the move completes."}},"required":["recordId","previousPath","newPath"],"additionalProperties":false}},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the first moved record's primary title plus the count of the others, at job creation. Display only."}},"required":["targetParentId","previousParentId","moves","tenantId"],"additionalProperties":false},{"description":"`bulkEditPermissionGroups` parameters as stored on the job: the permission groups added and removed. The selection is not stored.","properties":{"addSecurityTagIds":{"type":"array","items":{"type":"string"}},"removeSecurityTagIds":{"type":"array","items":{"type":"string"}}},"required":["addSecurityTagIds","removeSecurityTagIds"],"additionalProperties":false}]}},"required":["type","parameters"],"additionalProperties":false}],"required":["arn","status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"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}$"}}}}
```

## The CreateRecordJobResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateRecordJobResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateRecordJobResponse","description":"The created job, with its id and initial status.","type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/RecordJob"}},"required":["id","attributes"]}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"]},"RecordJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordJob","description":"A record background job: the base job attributes plus a record job `type` and its `parameters`.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["deleteRecord","restoreRecord","permanentlyDeleteRecord","createRecordFromScratch","createMediaFromUrl","migrateRecordLifecycleStatus","importSeriesOriginNexus","importMoviesOriginNexus","bulkEditRecords","deleteAlternateRunningOrder","moveRecord","bulkEditPermissionGroups"]},"parameters":{"type":"object","oneOf":[{"properties":{"recordId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation, so it stays readable after a delete. Display only."}},"required":["recordId","tenantId"],"additionalProperties":false},{"properties":{"seriesId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the primary title of the Origin Nexus record to import, at job creation. Display only."}},"required":["seriesId","tenantId"],"additionalProperties":false},{"properties":{"movieId":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the primary title of the Origin Nexus record to import, at job creation. Display only."}},"required":["movieId","tenantId"],"additionalProperties":false},{"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"primaryTitle":{"type":"string"},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation. Display only."}},"required":["recordId","workType","tenantId"],"additionalProperties":false},{"properties":{"tenantId":{"type":"string"},"recordId":{"type":"string"},"urls":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","description":"Display label: the target record's primary title at job creation. Display only."}},"required":["urls","tenantId","recordId"],"additionalProperties":false},{"properties":{"tenantId":{"type":"string"},"oldLifecycleStatus":{"type":"string"},"newLifecycleStatus":{"type":"string"}},"required":["tenantId","oldLifecycleStatus","newLifecycleStatus"],"additionalProperties":false},{"description":"`bulkEditRecords` parameters as stored on the job, including the server-set `tenantId` and `jobId`.","properties":{"tenantId":{"type":"string"},"jobId":{"type":"string"},"locale":{"type":"string"},"edits":{"type":"array","items":{"type":"object","properties":{"fieldKey":{"type":"string"},"action":{"type":"string","enum":["overwrite","delete"]},"value":{}},"required":["fieldKey","action"],"additionalProperties":false}},"selection":{"type":"object","additionalProperties":true}},"required":["tenantId","edits","selection"],"additionalProperties":true},{"properties":{"targetParentId":{"type":"string"},"previousParentId":{"type":"string","description":"The moved records' shared parent before the move."},"moves":{"type":"array","description":"One entry per moved record.","items":{"type":"object","properties":{"recordId":{"type":"string"},"previousPath":{"type":"string","description":"The record's hierarchy path (ancestor ids, root first) before the move."},"newPath":{"type":"string","description":"The record's hierarchy path once the move completes."}},"required":["recordId","previousPath","newPath"],"additionalProperties":false}},"tenantId":{"type":"string"},"subject":{"type":"string","description":"Display label: the first moved record's primary title plus the count of the others, at job creation. Display only."}},"required":["targetParentId","previousParentId","moves","tenantId"],"additionalProperties":false},{"description":"`bulkEditPermissionGroups` parameters as stored on the job: the permission groups added and removed. The selection is not stored.","properties":{"addSecurityTagIds":{"type":"array","items":{"type":"string"}},"removeSecurityTagIds":{"type":"array","items":{"type":"string"}}},"required":["addSecurityTagIds","removeSecurityTagIds"],"additionalProperties":false}]}},"required":["type","parameters"],"additionalProperties":false}],"required":["arn","status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"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}$"},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordGetDeletedAncestorsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordGetDeletedAncestorsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordGetDeletedAncestorsResponse","description":"A record's ancestors, top-down. Filter by status with `filter.status`, for example `filter.status=DELETED`. Empty when no ancestor matches.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]},"attributes":{"type":"object","properties":{"primaryTitle":{"type":"string"},"workType":{"type":"string"},"sequenceNumber":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","DELETED"]}},"additionalProperties":false,"required":["primaryTitle","workType","sequenceNumber","status"]},"relationships":{"type":"object","properties":{"parent":{"description":"This ancestor's parent, one level up. Absent for the root ancestor.","$ref":"#/components/schemas/RecordRelationship"}},"additionalProperties":false}},"additionalProperties":false,"required":["id","type","attributes"]}},"meta":{"type":"object","properties":{"workTypeCounts":{"type":"object","description":"Number of returned ancestors per work type.","additionalProperties":{"type":"integer"}}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The RecordChildrenFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordChildrenFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordChildrenFindManyResponse","description":"Identifiers of the parent's direct active children. Excludes collection members: use `GET /records/{recordId}/collectionMembers`. Empty when the parent has no hierarchical children, such as a Movie, a leaf Episode or a Compilation.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"additionalProperties":false,"required":["id","type"]}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordCollectionMemberFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordCollectionMemberFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCollectionMemberFindManyResponse","description":"The member records of a collection.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["collectionLinkageItems"]},"attributes":{"type":"object","properties":{"ranking":{"type":"number"}},"additionalProperties":false,"required":["ranking"]},"relationships":{"type":"object","properties":{"record":{"description":"The member record.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this collection membership.","$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false,"required":["record","tenant"]}},"additionalProperties":false,"required":["id","type","attributes","relationships"]},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The RecordCollectionFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordCollectionFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCollectionFindManyResponse","description":"The collections a record belongs to.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["collectionLinkageItems"]},"attributes":{"type":"object","properties":{"ranking":{"type":"number"}},"additionalProperties":false,"required":["ranking"]},"relationships":{"type":"object","properties":{"collection":{"description":"The collection this record is a member of.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this collection membership.","$ref":"#/components/schemas/TenantRelationship"}},"additionalProperties":false,"required":["collection","tenant"]}},"additionalProperties":false,"required":["id","type","attributes","relationships"]},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The collectionLinkageItemDataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"collectionLinkageItemDataObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false},"relationships":{"description":"The record to add as a collection member.","type":"object","properties":{"record":{"description":"An existing record to add, by type and id. This call doesn't create it.","type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["record"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false}}}}
```

## The collectionLinkageItemRefObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"collectionLinkageItemRefObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}}}}
```

## The collectionLinkageItemUpdateDataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"collectionLinkageItemUpdateDataObject":{"type":"object","description":"The member to re-rank, as a resource object. `type` and `id` must equal the operation's `ref`.","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false}}}}
```

## The CollectionMembersAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CollectionMembersAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICollectionMembersAtomicOperationsRequest","description":"Adds, reorders and removes collection members in one transactional call.\n- `add`: adds a record as a new member.\n- `update`: changes a member's `ranking`.\n- `remove`: removes a member.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","items":{"type":"object","oneOf":[{"type":"object","description":"Adds a record as a new collection member. Fails if it is already a member: use `update` to change its ranking, not remove and re-add.","properties":{"op":{"const":"add"},"data":{"$ref":"#/components/schemas/collectionLinkageItemDataObject"}},"required":["op","data"],"additionalProperties":false},{"type":"object","description":"Changes a member's ranking, by its linkage-item id in `ref`, without changing membership. Use it to reorder members.","properties":{"op":{"const":"update"},"ref":{"$ref":"#/components/schemas/collectionLinkageItemRefObject"},"data":{"$ref":"#/components/schemas/collectionLinkageItemUpdateDataObject"}},"required":["op","ref","data"],"additionalProperties":false},{"type":"object","description":"Remove an existing member by its own linkage-item id.","properties":{"op":{"const":"remove"},"ref":{"$ref":"#/components/schemas/collectionLinkageItemRefObject"}},"required":["op","ref"],"additionalProperties":false}]}}},"required":["atomic:operations"],"additionalProperties":false,"definitions":{"collectionLinkageItemDataObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false},"relationships":{"description":"The record to add as a collection member.","type":"object","properties":{"record":{"description":"An existing record to add, by type and id. This call doesn't create it.","type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["record"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false},"collectionLinkageItemUpdateDataObject":{"type":"object","description":"The member to re-rank, as a resource object. `type` and `id` must equal the operation's `ref`.","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false},"collectionLinkageItemRefObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"}},"required":["type","id"],"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}}}}},"collectionLinkageItemDataObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false},"relationships":{"description":"The record to add as a collection member.","type":"object","properties":{"record":{"description":"An existing record to add, by type and id. This call doesn't create it.","type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"required":["record"],"additionalProperties":false}},"required":["type","attributes","relationships"],"additionalProperties":false},"collectionLinkageItemRefObject":{"type":"object","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"collectionLinkageItemUpdateDataObject":{"type":"object","description":"The member to re-rank, as a resource object. `type` and `id` must equal the operation's `ref`.","properties":{"type":{"type":"string","const":"collectionLinkageItems"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"ranking":{"type":"number","minimum":0}},"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false}}}}
```

## The AlternateRunningOrderFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderFindManyResponse","description":"Every Alternate Running Order belonging to a parent record, ordered by id. Empty when the record has none, or when its work type cannot own running orders.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AlternateRunningOrder"}},"meta":{"type":"object","additionalProperties":false,"required":["count"],"properties":{"count":{"type":"number","description":"Number of running orders returned."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"AlternateRunningOrder":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrder","description":"An Alternate Running Order: a re-sequencing of a record's direct Episode children for distribution. It never changes an Episode's `sequenceNumber`, `parentId` or `path`. The canonical order (the Master) has no resource: it is the Episodes sorted by `sequenceNumber`.","type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"$ref":"#/components/schemas/AlternateRunningOrderAttributes"},"relationships":{"$ref":"#/components/schemas/AlternateRunningOrderRelationships"}}},"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}},"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The AlternateRunningOrderCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderCreateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderCreateRequest","description":"Creates an Alternate Running Order on a Season, or on a Series with seasonless Episodes.\n- Send `relationships.items` to seed it in the same atomic write; send the parent's Episodes in `sequenceNumber` order to copy the Master. Omit it to start empty.\n- Seeded Episodes keep the order sent. The server assigns their rankings from a microsecond clock, with gaps so you can later move an Episode between two neighbours without renumbering the rest. Read `position` for the 1-based place.\n- Every Episode must be an active direct child of the parent record.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"description":"Optional note. `null` is the same as omitting it.","type":["string","null"],"maxLength":500}}},"relationships":{"type":"object","additionalProperties":false,"properties":{"items":{"description":"Episodes to seed the running order with, in order.","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","maxItems":95,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}}}}}}}}}}}},"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}}}}}}}}
```

## The AlternateRunningOrderFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderFindOneResponse","description":"A single Alternate Running Order.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/AlternateRunningOrder"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"AlternateRunningOrder":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrder","description":"An Alternate Running Order: a re-sequencing of a record's direct Episode children for distribution. It never changes an Episode's `sequenceNumber`, `parentId` or `path`. The canonical order (the Master) has no resource: it is the Episodes sorted by `sequenceNumber`.","type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"$ref":"#/components/schemas/AlternateRunningOrderAttributes"},"relationships":{"$ref":"#/components/schemas/AlternateRunningOrderRelationships"}}},"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}},"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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}}}}
```

## The AlternateRunningOrderUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderUpdateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderUpdateRequest","description":"Renames an Alternate Running Order, changes its description, or both; send at least one. You can't clear `name`. A new name must be unique among the parent record's other running orders. To change Episodes, use the items atomic-operations endpoint.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"description":"`null` clears the description; omit it to keep the current one.","type":["string","null"],"maxLength":500}}}}}}},"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}}}}}}}}
```

## The AlternateRunningOrderItemFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderItemFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderItemFindManyResponse","description":"The Episodes of one Alternate Running Order, sorted by ranking. Returns identifiers only, without titles or canonical sequence numbers: fetch each Episode with `GET /records/{recordId}`. An item's id is the Episode's record id; an Episode appears at most once per running order.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string","description":"The Episode's record id. Use it as `ref.id` in atomic operations."},"type":{"type":"string","enum":["alternateRunningOrderItems"]},"attributes":{"type":"object","additionalProperties":false,"required":["ranking","position"],"properties":{"ranking":{"type":"number","description":"The sort value. Gaps are allowed, so a single move is one `update` operation."},"position":{"type":"number","description":"The Episode's 1-based place in this running order. Read-only.","readOnly":true}}},"relationships":{"type":"object","additionalProperties":false,"required":["record","alternateRunningOrder"],"properties":{"record":{"description":"The Episode this entry places in the running order.","$ref":"#/components/schemas/RecordRelationship"},"alternateRunningOrder":{"description":"The running order this entry belongs to.","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]}}}}}}}}}},"included":{"type":"array","description":"The running order these Episodes belong to.","items":{"$ref":"#/components/schemas/AlternateRunningOrder"}},"meta":{"type":"object","additionalProperties":false,"required":["count"],"properties":{"count":{"type":"number","description":"Number of Episodes in this running order."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"RecordRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordRelationship","description":"A relationship to a record","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"meta":{"type":"object","properties":{"primaryTitle":{"type":"string"}}},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"]},"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},"AlternateRunningOrder":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrder","description":"An Alternate Running Order: a re-sequencing of a record's direct Episode children for distribution. It never changes an Episode's `sequenceNumber`, `parentId` or `path`. The canonical order (the Master) has no resource: it is the Episodes sorted by `sequenceNumber`.","type":"object","additionalProperties":false,"required":["id","type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["alternateRunningOrders"]},"attributes":{"$ref":"#/components/schemas/AlternateRunningOrderAttributes"},"relationships":{"$ref":"#/components/schemas/AlternateRunningOrderRelationships"}}},"AlternateRunningOrderAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderAttributes","description":"Attributes of an Alternate Running Order: a named, reusable Episode sequence owned by one Season, or by one Series with seasonless Episodes.","type":"object","additionalProperties":false,"required":["name","itemCount","created","updated"],"properties":{"name":{"type":"string","description":"Display name, unique within the parent record, ignoring case and surrounding whitespace.","minLength":1,"maxLength":120},"description":{"type":"string","description":"Free-text note describing what this order is for.","maxLength":500},"itemCount":{"type":"number","description":"Number of Episodes in this running order. Read-only.","readOnly":true},"created":{"type":"string"},"updated":{"type":"string"}}},"AlternateRunningOrderRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderRelationships","description":"Relationships of an Alternate Running Order.","type":"object","additionalProperties":false,"required":["record","tenant"],"properties":{"record":{"description":"The parent Season, or seasonless Series, that owns this running order.","$ref":"#/components/schemas/RecordRelationship"},"tenant":{"description":"The tenant that owns this running order.","$ref":"#/components/schemas/TenantRelationship"},"items":{"description":"Link to this running order's Episodes, in order: `GET /records/{recordId}/alternateRunningOrders/{alternateRunningOrderId}/items`.","type":"object","additionalProperties":false,"required":["links"],"properties":{"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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}}}}
```

## The alternateRunningOrderItemDataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"alternateRunningOrderItemDataObject":{"type":"object","additionalProperties":false,"required":["type","attributes","relationships"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"attributes":{"type":"object","additionalProperties":false,"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991. Omit it to append the Episode at the end, with a microsecond timestamp as its ranking.","type":"integer","minimum":1,"maximum":9007199254740991}}},"relationships":{"type":"object","additionalProperties":false,"required":["record"],"properties":{"record":{"description":"The Episode to place. It must be an active direct child of the running order's parent record with work type Episode; you can't add EpisodeEdits.","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}}}}}}}}}}}}
```

## The alternateRunningOrderItemRefObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"alternateRunningOrderItemRefObject":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."}}}}}}
```

## The alternateRunningOrderItemUpdateDataObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"alternateRunningOrderItemUpdateDataObject":{"type":"object","description":"The entry to move, as a resource object. `type` and `id` must equal the operation's `ref`.","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."},"attributes":{"type":"object","additionalProperties":false,"required":["ranking"],"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991.","type":"integer","minimum":1,"maximum":9007199254740991}}}}}}}}
```

## The AlternateRunningOrderItemsAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AlternateRunningOrderItemsAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAlternateRunningOrderItemsAtomicOperationsRequest","description":"Adds, reorders and removes the Episodes of one Alternate Running Order in one transactional call of 1 to 99 operations.\n- `add`: places an Episode at `ranking`, or at the end when `ranking` is omitted. Fails if the Episode is already present: use `update` to move it, not remove and add.\n- `update`: changes an Episode's ranking.\n- `remove`: takes an Episode out of the order. The Episode record stays; you can add it back later.\n\n`ref.id` is the Episode's record id, since an Episode appears at most once per running order. Rankings need not be contiguous: leave gaps (100, 200, 300, ...) so a drag is one `update` instead of renumbering every row below it. Never changes an Episode's `sequenceNumber`, `parentId` or `path`.","type":"object","additionalProperties":false,"required":["atomic:operations"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","maxItems":99,"items":{"type":"object","oneOf":[{"type":"object","description":"Add an Episode to the running order. Fails with 409 if it is already present.","additionalProperties":false,"required":["op","data"],"properties":{"op":{"type":"string","const":"add"},"data":{"$ref":"#/components/schemas/alternateRunningOrderItemDataObject"}}},{"type":"object","description":"Change an existing Episode's ranking within the running order.","additionalProperties":false,"required":["op","ref","data"],"properties":{"op":{"type":"string","const":"update"},"ref":{"$ref":"#/components/schemas/alternateRunningOrderItemRefObject"},"data":{"$ref":"#/components/schemas/alternateRunningOrderItemUpdateDataObject"}}},{"type":"object","description":"Remove an Episode from the running order. Doesn't delete the Episode record.","additionalProperties":false,"required":["op","ref"],"properties":{"op":{"type":"string","const":"remove"},"ref":{"$ref":"#/components/schemas/alternateRunningOrderItemRefObject"}}}]}}},"definitions":{"alternateRunningOrderItemDataObject":{"type":"object","additionalProperties":false,"required":["type","attributes","relationships"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"attributes":{"type":"object","additionalProperties":false,"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991. Omit it to append the Episode at the end, with a microsecond timestamp as its ranking.","type":"integer","minimum":1,"maximum":9007199254740991}}},"relationships":{"type":"object","additionalProperties":false,"required":["record"],"properties":{"record":{"description":"The Episode to place. It must be an active direct child of the running order's parent record with work type Episode; you can't add EpisodeEdits.","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}}}}}}}}},"alternateRunningOrderItemUpdateDataObject":{"type":"object","description":"The entry to move, as a resource object. `type` and `id` must equal the operation's `ref`.","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."},"attributes":{"type":"object","additionalProperties":false,"required":["ranking"],"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991.","type":"integer","minimum":1,"maximum":9007199254740991}}}}},"alternateRunningOrderItemRefObject":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."}}}}},"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}}}}},"alternateRunningOrderItemDataObject":{"type":"object","additionalProperties":false,"required":["type","attributes","relationships"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"attributes":{"type":"object","additionalProperties":false,"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991. Omit it to append the Episode at the end, with a microsecond timestamp as its ranking.","type":"integer","minimum":1,"maximum":9007199254740991}}},"relationships":{"type":"object","additionalProperties":false,"required":["record"],"properties":{"record":{"description":"The Episode to place. It must be an active direct child of the running order's parent record with work type Episode; you can't add EpisodeEdits.","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"records"},"id":{"type":"string"}}}}}}}}},"alternateRunningOrderItemRefObject":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."}}},"alternateRunningOrderItemUpdateDataObject":{"type":"object","description":"The entry to move, as a resource object. `type` and `id` must equal the operation's `ref`.","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"alternateRunningOrderItems"},"id":{"type":"string","description":"The Episode's record id."},"attributes":{"type":"object","additionalProperties":false,"required":["ranking"],"properties":{"ranking":{"description":"Where the Episode sits in the running order; lower comes first. A positive integer up to 9007199254740991.","type":"integer","minimum":1,"maximum":9007199254740991}}}}}}}}
```

## The RecordLifecycleNodeAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleNodeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A single lifecycle status node: id, label, phase (drafting or published), and optional position.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description of the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"}}}}}}
```

## The RecordLifecycleEdgeAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleEdgeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A transition in the lifecycle graph, from status `fromStatusId` to status `toStatusId`.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."},"description":{"type":"string","description":"Optional description for the transition action"}}}}}}
```

## The RecordLifecycleAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleAttributes","description":"Attributes defining a record lifecycle: work type, statuses, and transitions between statuses.","type":"object","required":["workType","statuses","transitions"],"additionalProperties":false,"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"statuses":{"type":"array","description":"The lifecycle statuses","items":{"$ref":"#/components/schemas/RecordLifecycleNodeAttributes"}},"transitions":{"type":"array","description":"The lifecycle transitions between statuses","items":{"$ref":"#/components/schemas/RecordLifecycleEdgeAttributes"}}}},"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}$"},"RecordLifecycleNodeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A single lifecycle status node: id, label, phase (drafting or published), and optional position.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description of the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"}}},"RecordLifecycleEdgeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A transition in the lifecycle graph, from status `fromStatusId` to status `toStatusId`.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."},"description":{"type":"string","description":"Optional description for the transition action"}}}}}}
```

## The RecordLifecycleFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleFindManyResponse","description":"Every record lifecycle in the tenant, with its full graph.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the lifecycle"},"type":{"type":"string","enum":["recordLifecycles"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLifecycleAttributes"}]},"relationships":{"type":"object","properties":{"tenant":{"description":"The tenant that owns this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"author":{"description":"The user who originally created this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"]}},"required":["id","type","meta"]},"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["data"]},"updatedBy":{"description":"The user who last modified this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"]}},"required":["id","type","meta"]},"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["data"]}},"required":["tenant"],"additionalProperties":false}},"required":["id","type","attributes","relationships"],"additionalProperties":false}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"}}},"RecordLifecycleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleAttributes","description":"Attributes defining a record lifecycle: work type, statuses, and transitions between statuses.","type":"object","required":["workType","statuses","transitions"],"additionalProperties":false,"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"statuses":{"type":"array","description":"The lifecycle statuses","items":{"$ref":"#/components/schemas/RecordLifecycleNodeAttributes"}},"transitions":{"type":"array","description":"The lifecycle transitions between statuses","items":{"$ref":"#/components/schemas/RecordLifecycleEdgeAttributes"}}}},"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}$"},"RecordLifecycleNodeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A single lifecycle status node: id, label, phase (drafting or published), and optional position.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description of the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"}}},"RecordLifecycleEdgeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A transition in the lifecycle graph, from status `fromStatusId` to status `toStatusId`.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."},"description":{"type":"string","description":"Optional description for the transition action"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordLifecycleCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleCreateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleCreateRequest","description":"Creates a record lifecycle: its statuses, allowed transitions, and each status's position in the lifecycle editor.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["recordLifecycles"]},"attributes":{"$ref":"#/components/schemas/RecordLifecycleAttributes"}},"required":["type","attributes"],"additionalProperties":false}},"required":["data"],"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}}}}},"RecordLifecycleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleAttributes","description":"Attributes defining a record lifecycle: work type, statuses, and transitions between statuses.","type":"object","required":["workType","statuses","transitions"],"additionalProperties":false,"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"statuses":{"type":"array","description":"The lifecycle statuses","items":{"$ref":"#/components/schemas/RecordLifecycleNodeAttributes"}},"transitions":{"type":"array","description":"The lifecycle transitions between statuses","items":{"$ref":"#/components/schemas/RecordLifecycleEdgeAttributes"}}}},"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}$"},"RecordLifecycleNodeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A single lifecycle status node: id, label, phase (drafting or published), and optional position.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description of the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"}}},"RecordLifecycleEdgeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A transition in the lifecycle graph, from status `fromStatusId` to status `toStatusId`.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."},"description":{"type":"string","description":"Optional description for the transition action"}}}}}}
```

## The RecordLifecycleFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleFindOneResponse","description":"One record lifecycle with its full graph: statuses, transitions, nodes and edges.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the lifecycle"},"type":{"type":"string","enum":["recordLifecycles"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/RecordLifecycleAttributes"}]},"relationships":{"type":"object","properties":{"tenant":{"description":"The tenant that owns this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"author":{"description":"The user who originally created this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"]}},"required":["id","type","meta"]},"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["data"]},"updatedBy":{"description":"The user who last modified this lifecycle definition.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"]}},"required":["id","type","meta"]},"links":{"type":"object","properties":{"related":{"type":"string"}}}},"required":["data"]}},"required":["tenant"],"additionalProperties":false}},"required":["id","type","attributes","relationships"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"}}},"RecordLifecycleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleAttributes","description":"Attributes defining a record lifecycle: work type, statuses, and transitions between statuses.","type":"object","required":["workType","statuses","transitions"],"additionalProperties":false,"properties":{"workType":{"$ref":"#/components/schemas/WorkTypes"},"statuses":{"type":"array","description":"The lifecycle statuses","items":{"$ref":"#/components/schemas/RecordLifecycleNodeAttributes"}},"transitions":{"type":"array","description":"The lifecycle transitions between statuses","items":{"$ref":"#/components/schemas/RecordLifecycleEdgeAttributes"}}}},"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}$"},"RecordLifecycleNodeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A single lifecycle status node: id, label, phase (drafting or published), and optional position.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description of the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"}}},"RecordLifecycleEdgeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A transition in the lifecycle graph, from status `fromStatusId` to status `toStatusId`.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."},"description":{"type":"string","description":"Optional description for the transition action"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordLifecycleStatusAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleStatusAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A lifecycle status definition: id, label, phase (drafting or published), optional description and position, and in-use metadata.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description for the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"},"meta":{"type":"object","description":"Metadata about the status","additionalProperties":false,"properties":{"inUse":{"type":"boolean","description":"Whether any record in the library has this status."}}}}}}}}
```

## The RecordLifecycleTransitionAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleTransitionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A lifecycle transition: the action that moves a record from one status to another.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."}}}}}}
```

## The RecordLifecycleUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordLifecycleUpdateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleUpdateRequest","description":"Updates a record lifecycle: only the fields sent change. Covers the statuses, transitions and status positions.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the lifecycle"},"type":{"type":"string","enum":["recordLifecycles"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"statuses":{"type":"array","description":"The lifecycle statuses","items":{"$ref":"#/components/schemas/RecordLifecycleStatusAttributes"}},"transitions":{"type":"array","description":"The lifecycle transitions","items":{"$ref":"#/components/schemas/RecordLifecycleTransitionAttributes"}}}}},"required":["id","type","attributes"],"additionalProperties":false}},"required":["data"],"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}}}}},"RecordLifecycleStatusAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleStatusAttributes","description":"A lifecycle status definition: id, label, phase (drafting or published), optional description and position, and in-use metadata.","type":"object","required":["id","label","phase"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the status"},"label":{"type":"string","description":"Display label for the status"},"phase":{"type":"string","enum":["drafting","published"],"description":"The phase this status belongs to"},"description":{"type":"string","description":"Optional description for the status"},"positionX":{"type":"number","description":"The x position of the status"},"positionY":{"type":"number","description":"The y position of the status"},"meta":{"type":"object","description":"Metadata about the status","additionalProperties":false,"properties":{"inUse":{"type":"boolean","description":"Whether any record in the library has this status."}}}}},"RecordLifecycleTransitionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordLifecycleTransitionAttributes","description":"A lifecycle transition: the action that moves a record from one status to another.","type":"object","required":["id","label","fromStatusId","toStatusId","direction"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Unique identifier for the transition"},"label":{"type":"string","description":"Display label for the transition action"},"fromStatusId":{"type":"string","description":"The source status ID"},"toStatusId":{"type":"string","description":"The target status ID"},"direction":{"type":"string","enum":["forward","backward"],"description":"Whether the transition moves the record on or back.\n- `forward`: progresses the lifecycle.\n- `backward`: regresses it.\n\nThe lifecycle editor sets it from the edge handles: east to west is `forward`."}}}}}}
```

## The IExternalDataFieldItem object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IExternalDataFieldItem":{"type":"object","description":"One external field resource","properties":{"type":{"type":"string","enum":["externalSynopses","externalTitles","externalPrimaryTitle","externalReleaseYear","externalReleaseDate","externalRunLength","externalCountryOfOrigin","externalPrimarySpokenLanguage","externalOriginalLanguage","externalGenre","externalKeyword"],"description":"Discriminator for item shape"},"id":{"type":"string","description":"Stable compound id: recordId:provider:itemKey"},"attributes":{"type":"object","description":"Item fields (varies by type)","properties":{"field":{"type":"string","enum":["synopses","titles","primaryTitle","releaseYear","releaseDate","runLength","countriesOfOrigin","primarySpokenLanguage","originalLanguage","genres","keywords"],"description":"Field group this item belongs to"},"value":{"type":"string","description":"Primary value for this item (title text, synopsis body, year, date, duration, language code, etc.)"},"language":{"type":"string","description":"Locale / language tag (present on synopses and titles)"},"source":{"type":"string","description":"The provider, such as Origin Nexus."},"attribution":{"type":"string","description":"Attribution / credit for the source value"},"synopsisType":{"type":"string","description":"Synopsis kind (e.g. short, long, log line)"},"titleType":{"type":"string","description":"Title kind (e.g. primary, alternative)"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code"},"characterCount":{"type":"integer","description":"Character length of the value for UI hints"},"key":{"type":"string","description":"Sub-key disambiguating multi-valued items"}},"required":["field","source"],"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false}}}}
```

## The ExternalDataFieldsFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ExternalDataFieldsFindManyResponse":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"IExternalDataFieldsFindManyResponse","title":"IExternalDataFieldsFindManyResponse","description":"A record's field data from an external provider, such as Origin Nexus, as a flat list of typed field resources.","type":"object","properties":{"data":{"type":"array","description":"External field resources for this record and provider.","items":{"$ref":"#/components/schemas/IExternalDataFieldItem"}},"meta":{"type":"object","description":"Document-level meta for the external data request","properties":{"total":{"type":"integer","description":"Total number of field items returned"},"provider":{"type":"string","enum":["OriginNexus","IMDB","EIDR","Gracenote"],"description":"Provider identifier"},"availableLocales":{"type":"array","items":{"type":"string"},"description":"Locale codes that have data in at least one external source (synopses or titles)"}},"required":["total","provider"]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"type":"object","description":"JSON:API document-level links"}},"required":["data","meta","jsonapi"],"$defs":{"IExternalDataFieldItem":{"type":"object","description":"One external field resource","properties":{"type":{"type":"string","enum":["externalSynopses","externalTitles","externalPrimaryTitle","externalReleaseYear","externalReleaseDate","externalRunLength","externalCountryOfOrigin","externalPrimarySpokenLanguage","externalOriginalLanguage","externalGenre","externalKeyword"],"description":"Discriminator for item shape"},"id":{"type":"string","description":"Stable compound id: recordId:provider:itemKey"},"attributes":{"type":"object","description":"Item fields (varies by type)","properties":{"field":{"type":"string","enum":["synopses","titles","primaryTitle","releaseYear","releaseDate","runLength","countriesOfOrigin","primarySpokenLanguage","originalLanguage","genres","keywords"],"description":"Field group this item belongs to"},"value":{"type":"string","description":"Primary value for this item (title text, synopsis body, year, date, duration, language code, etc.)"},"language":{"type":"string","description":"Locale / language tag (present on synopses and titles)"},"source":{"type":"string","description":"The provider, such as Origin Nexus."},"attribution":{"type":"string","description":"Attribution / credit for the source value"},"synopsisType":{"type":"string","description":"Synopsis kind (e.g. short, long, log line)"},"titleType":{"type":"string","description":"Title kind (e.g. primary, alternative)"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code"},"characterCount":{"type":"integer","description":"Character length of the value for UI hints"},"key":{"type":"string","description":"Sub-key disambiguating multi-valued items"}},"required":["field","source"],"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false}}},"IExternalDataFieldItem":{"type":"object","description":"One external field resource","properties":{"type":{"type":"string","enum":["externalSynopses","externalTitles","externalPrimaryTitle","externalReleaseYear","externalReleaseDate","externalRunLength","externalCountryOfOrigin","externalPrimarySpokenLanguage","externalOriginalLanguage","externalGenre","externalKeyword"],"description":"Discriminator for item shape"},"id":{"type":"string","description":"Stable compound id: recordId:provider:itemKey"},"attributes":{"type":"object","description":"Item fields (varies by type)","properties":{"field":{"type":"string","enum":["synopses","titles","primaryTitle","releaseYear","releaseDate","runLength","countriesOfOrigin","primarySpokenLanguage","originalLanguage","genres","keywords"],"description":"Field group this item belongs to"},"value":{"type":"string","description":"Primary value for this item (title text, synopsis body, year, date, duration, language code, etc.)"},"language":{"type":"string","description":"Locale / language tag (present on synopses and titles)"},"source":{"type":"string","description":"The provider, such as Origin Nexus."},"attribution":{"type":"string","description":"Attribution / credit for the source value"},"synopsisType":{"type":"string","description":"Synopsis kind (e.g. short, long, log line)"},"titleType":{"type":"string","description":"Title kind (e.g. primary, alternative)"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code"},"characterCount":{"type":"integer","description":"Character length of the value for UI hints"},"key":{"type":"string","description":"Sub-key disambiguating multi-valued items"}},"required":["field","source"],"additionalProperties":false}},"required":["type","id","attributes"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordAddSecurityTagsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordAddSecurityTagsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordAddSecurityTagsRelationshipRequest","description":"Adds security tags to a record.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","minItems":1,"maxItems":99,"uniqueItems":true,"items":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}}},"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}}}}}}}}
```

## The RecordDeleteSecurityTagsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordDeleteSecurityTagsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordDeleteSecurityTagsRelationshipRequest","description":"The security tags to remove from a record.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","minItems":1,"maxItems":99,"uniqueItems":true,"items":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}}}}}},"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}}}}}}}}
```

## The SearchIndexProvisionResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SearchIndexProvisionResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchIndexProvisionResponse","description":"What provisioning did to each search index. An existing index is never changed.","type":"object","additionalProperties":false,"required":["meta","jsonapi"],"properties":{"meta":{"type":"object","additionalProperties":false,"required":["indices"],"properties":{"indices":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["alias","index","outcome"],"properties":{"alias":{"type":"string","description":"The alias the index is searched through."},"index":{"type":"string","description":"The index the alias points at, comma-separated when it points at more than one."},"outcome":{"type":"string","enum":["created","exists","conflict"],"description":"`created`: the index did not exist and was created. `exists`: the index already exists and was left as it is. `conflict`: an index of that name exists that the alias does not point at, or the name is an index rather than an alias; it is left as it is (see `reason`)."},"reason":{"type":"string","description":"What needs a manual fix. Only present on a conflict."}}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The RecordCloudEvent object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordCloudEvent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordCloudEvent","description":"A record change event in CloudEvents 1.0 structured JSON format. Consumers must ignore unknown properties, attributes and event types; new ones are added without notice.","type":"object","required":["specversion","id","source","type","subject","time","dataschema","datacontenttype","data"],"properties":{"specversion":{"type":"string","enum":["1.0"]},"id":{"description":"Unique per change; repeated deliveries of the same change share it.","type":"string"},"source":{"description":"`/tenants/{tenantId}/records`.","type":"string"},"type":{"type":"string","enum":["com.fabricinsights.originstudio.record.created","com.fabricinsights.originstudio.record.updated","com.fabricinsights.originstudio.record.deleted","com.fabricinsights.originstudio.record.restored","com.fabricinsights.originstudio.record.purged"]},"subject":{"description":"The record id.","type":"string"},"time":{"description":"When the change happened (RFC 3339).","type":"string","format":"date-time"},"dataschema":{"type":"string"},"datacontenttype":{"type":"string","enum":["application/json"]},"data":{"type":"object","required":["savedFields"],"properties":{"savedFields":{"description":"Attribute and field keys the change saved, with the locale for localized values. A key is listed whenever it was saved, even with its previous value. Empty for deleted, restored and purged events.","type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"locale":{"type":"string"}}}}}}}}}}}
```

## The TenantAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantAttributes","description":"A tenant's profile: display name, key, plan and contact details.","type":"object","additionalProperties":false,"required":["fullName","key","plan"],"properties":{"fullName":{"type":"string","description":"The tenant's display name, such as a studio or company name."},"contactInfo":{"type":"object","description":"Contact details for the tenant.","properties":{"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"}},"additionalProperties":false},"key":{"type":"string","description":"Unique key for the tenant. URLs and references use it."},"description":{"type":"string"},"policyStoreId":{"type":"string"},"auth0OrganizationId":{"type":"string","description":"The Auth0 organization linked to the tenant."},"plan":{"type":"string","description":"Subscription plan, such as `pro`, `team` or `enterprise`."},"planQuota":{"type":"object","description":"The plan's resource quotas.","properties":{"userCount":{"type":"number","description":"Maximum users in the tenant."},"recordCount":{"type":"number","description":"Maximum records in the tenant."},"deliveryRecordCount":{"type":"number","description":"Maximum delivery records in the tenant."},"apiCallCount":{"type":"number","description":"Maximum API calls per month."},"mediaStorageBytes":{"type":"number","description":"Maximum media storage, in bytes."}},"additionalProperties":false},"audit":{"type":"object","description":"Audit log settings for the tenant.","properties":{"retention":{"type":"object","description":"Retention policy for audit log files.","required":["days"],"properties":{"days":{"type":"number","description":"Days to keep audit log files. One of: 1, 30, 60, 90, 365, 730, 1095, 1460, 1825, 2555."}},"additionalProperties":false}},"additionalProperties":false,"required":["retention"]},"defaultRoleName":{"type":"string","description":"The role the server gives a user who signs in to the tenant for the first time without an assigned role. Absent when the tenant has no default role."}}}}}}
```

## The TenantRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationships","description":"Who created the tenant (`author`) and who last changed it (`updatedBy`). Each carries the user's display name and tenant in `meta`.","type":"object","properties":{"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}}},"updatedBy":{"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}}}},"additionalProperties":false}}}}
```

## The GetTenantsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetTenantsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFindManyResponse","description":"A list of tenants.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/TenantAttributes","required":["fullName","key","plan"]}]},"relationships":{"$ref":"#/components/schemas/TenantRelationships"},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false}}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"next":{"type":["string","null"]}},"additionalProperties":false},"meta":{"type":"object","properties":{"cursor":{"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"}}},"TenantAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantAttributes","description":"A tenant's profile: display name, key, plan and contact details.","type":"object","additionalProperties":false,"required":["fullName","key","plan"],"properties":{"fullName":{"type":"string","description":"The tenant's display name, such as a studio or company name."},"contactInfo":{"type":"object","description":"Contact details for the tenant.","properties":{"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"}},"additionalProperties":false},"key":{"type":"string","description":"Unique key for the tenant. URLs and references use it."},"description":{"type":"string"},"policyStoreId":{"type":"string"},"auth0OrganizationId":{"type":"string","description":"The Auth0 organization linked to the tenant."},"plan":{"type":"string","description":"Subscription plan, such as `pro`, `team` or `enterprise`."},"planQuota":{"type":"object","description":"The plan's resource quotas.","properties":{"userCount":{"type":"number","description":"Maximum users in the tenant."},"recordCount":{"type":"number","description":"Maximum records in the tenant."},"deliveryRecordCount":{"type":"number","description":"Maximum delivery records in the tenant."},"apiCallCount":{"type":"number","description":"Maximum API calls per month."},"mediaStorageBytes":{"type":"number","description":"Maximum media storage, in bytes."}},"additionalProperties":false},"audit":{"type":"object","description":"Audit log settings for the tenant.","properties":{"retention":{"type":"object","description":"Retention policy for audit log files.","required":["days"],"properties":{"days":{"type":"number","description":"Days to keep audit log files. One of: 1, 30, 60, 90, 365, 730, 1095, 1460, 1825, 2555."}},"additionalProperties":false}},"additionalProperties":false,"required":["retention"]},"defaultRoleName":{"type":"string","description":"The role the server gives a user who signs in to the tenant for the first time without an assigned role. Absent when the tenant has no default role."}}},"TenantRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationships","description":"Who created the tenant (`author`) and who last changed it (`updatedBy`). Each carries the user's display name and tenant in `meta`.","type":"object","properties":{"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}}},"updatedBy":{"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}}}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateTenantRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateTenantRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantCreateRequest","description":"Creates a tenant.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"type":"object","required":["fullName","contactInfo","key","description","plan","planQuota"],"additionalProperties":false,"properties":{"fullName":{"type":"string"},"contactInfo":{"type":"object","required":["email"],"properties":{"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"}},"additionalProperties":false},"key":{"type":"string"},"description":{"type":"string"},"auth0UserId":{"type":"string","description":"An Auth0 user to add to the tenant's Auth0 organization."},"shouldCreateUsagePlan":{"type":"boolean"},"audit":{"type":"object","description":"Audit log settings for the tenant.","properties":{"retention":{"type":"object","description":"How long to keep audit log files.","required":["days"],"properties":{"days":{"type":"number","description":"Days to keep audit log files: 1, 30, 60, 90, 365, 730, 1095, 1460, 1825 or 2555. Defaults to 30."}},"additionalProperties":false}},"additionalProperties":false,"required":["retention"]},"organizationId":{"type":"string","description":"An existing Auth0 organization to link the tenant to. When you omit it, the server creates an Auth0 organization named after the tenant `key`, with `fullName` as its `display_name`, unless that organization name is already in use."},"plan":{"type":"string","enum":["pro","team","enterprise"]},"planQuota":{"type":"object","description":"Resource quotas for the tenant plan","required":["userCount","recordCount","deliveryRecordCount","apiCallCount","mediaStorageBytes"],"additionalProperties":false,"properties":{"userCount":{"type":"number","description":"Maximum number of users in the tenant."},"recordCount":{"type":"number","description":"Maximum number of records in the tenant."},"deliveryRecordCount":{"type":"number","description":"Maximum number of delivery records in the tenant."},"apiCallCount":{"type":"integer","minimum":1,"description":"Maximum number of API calls per month."},"mediaStorageBytes":{"type":"number","description":"Maximum media storage in bytes"}}}}}},"required":["id","attributes"]}]}},"required":["data"],"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"]}}}}
```

## The TenantCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantCreateOneResponse","description":"The created tenant's id and `self` link.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The GetTenantResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetTenantResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFindOneResponse","description":"A tenant.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/TenantAttributes","required":["fullName","key","plan"]}]},"relationships":{"$ref":"#/components/schemas/TenantRelationships"}}},"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"}}},"TenantAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantAttributes","description":"A tenant's profile: display name, key, plan and contact details.","type":"object","additionalProperties":false,"required":["fullName","key","plan"],"properties":{"fullName":{"type":"string","description":"The tenant's display name, such as a studio or company name."},"contactInfo":{"type":"object","description":"Contact details for the tenant.","properties":{"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"}},"additionalProperties":false},"key":{"type":"string","description":"Unique key for the tenant. URLs and references use it."},"description":{"type":"string"},"policyStoreId":{"type":"string"},"auth0OrganizationId":{"type":"string","description":"The Auth0 organization linked to the tenant."},"plan":{"type":"string","description":"Subscription plan, such as `pro`, `team` or `enterprise`."},"planQuota":{"type":"object","description":"The plan's resource quotas.","properties":{"userCount":{"type":"number","description":"Maximum users in the tenant."},"recordCount":{"type":"number","description":"Maximum records in the tenant."},"deliveryRecordCount":{"type":"number","description":"Maximum delivery records in the tenant."},"apiCallCount":{"type":"number","description":"Maximum API calls per month."},"mediaStorageBytes":{"type":"number","description":"Maximum media storage, in bytes."}},"additionalProperties":false},"audit":{"type":"object","description":"Audit log settings for the tenant.","properties":{"retention":{"type":"object","description":"Retention policy for audit log files.","required":["days"],"properties":{"days":{"type":"number","description":"Days to keep audit log files. One of: 1, 30, 60, 90, 365, 730, 1095, 1460, 1825, 2555."}},"additionalProperties":false}},"additionalProperties":false,"required":["retention"]},"defaultRoleName":{"type":"string","description":"The role the server gives a user who signs in to the tenant for the first time without an assigned role. Absent when the tenant has no default role."}}},"TenantRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationships","description":"Who created the tenant (`author`) and who last changed it (`updatedBy`). Each carries the user's display name and tenant in `meta`.","type":"object","properties":{"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}}},"updatedBy":{"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}}}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UpdateTenantRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateTenantRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantUpdateRequest","description":"Updates a tenant.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"fullName":{"type":"string"},"description":{"type":"string"},"contactInfo":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string"},"phone":{"type":"string"},"address":{"type":"string"}}},"plan":{"type":"string","enum":["pro","team","enterprise"]},"planQuota":{"type":"object","additionalProperties":false,"properties":{"userCount":{"type":"number"},"recordCount":{"type":"number"},"deliveryRecordCount":{"type":"number"},"apiCallCount":{"type":"integer","minimum":1},"mediaStorageBytes":{"type":"number"}}},"audit":{"type":"object","additionalProperties":false,"required":["retention"],"properties":{"retention":{"type":"object","additionalProperties":false,"required":["days"],"properties":{"days":{"type":"number"}}}}},"defaultRoleName":{"type":["string","null"],"minLength":1,"description":"An assignable role in this tenant that the server gives a user who signs in for the first time without an assigned role. Send `null` to stop."}}}}}}},"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}}}}}}}}
```

## The TenantFeatureAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureAttributes","description":"The state of one entitlement-governed feature for a tenant. The tenant's plan sets `granted` and the tenant's own admins set `enabled`. The response includes features the plan doesn't grant, with `granted` set to `false`.","type":"object","additionalProperties":false,"required":["granted","enabled","effective"],"properties":{"granted":{"type":"boolean","description":"The tenant's plan offers this feature."},"enabled":{"type":"boolean","description":"The tenant has activated this feature. Activation is permanent."},"effective":{"type":"boolean","description":"Both `granted` and `enabled`. Gate behaviour on this value only."},"availableOn":{"type":"array","items":{"type":"string","enum":["pro","team","enterprise"]},"description":"Plans that offer this feature. Omitted when every plan offers it. An empty array means no plan offers it any more."},"created":{"type":"string","format":"date-time","description":"When the tenant activated the feature. Absent until activation."},"updated":{"type":"string","format":"date-time","description":"When the activation last changed. Absent until activation."}}}}}}
```

## The TenantFeatureResource object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureResource","description":"One entitlement-governed feature.","type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The feature's registry key."},"type":{"type":"string","enum":["features"]},"attributes":{"$ref":"#/components/schemas/TenantFeatureAttributes"},"relationships":{"type":"object","additionalProperties":false,"properties":{"author":{"type":"object","additionalProperties":false,"required":["data"],"description":"Who activated the feature. Absent until activation.","properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","additionalProperties":false,"required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string"}}}}},"TenantFeatureAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureAttributes","description":"The state of one entitlement-governed feature for a tenant. The tenant's plan sets `granted` and the tenant's own admins set `enabled`. The response includes features the plan doesn't grant, with `granted` set to `false`.","type":"object","additionalProperties":false,"required":["granted","enabled","effective"],"properties":{"granted":{"type":"boolean","description":"The tenant's plan offers this feature."},"enabled":{"type":"boolean","description":"The tenant has activated this feature. Activation is permanent."},"effective":{"type":"boolean","description":"Both `granted` and `enabled`. Gate behaviour on this value only."},"availableOn":{"type":"array","items":{"type":"string","enum":["pro","team","enterprise"]},"description":"Plans that offer this feature. Omitted when every plan offers it. An empty array means no plan offers it any more."},"created":{"type":"string","format":"date-time","description":"When the tenant activated the feature. Absent until activation."},"updated":{"type":"string","format":"date-time","description":"When the activation last changed. Absent until activation."}}}}}}
```

## The TenantFeatureFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureFindManyResponse","description":"Every registered feature, including those the tenant's plan doesn't grant. An empty array means no feature uses entitlements yet.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TenantFeatureResource"}},"links":{"type":"object","additionalProperties":false,"required":["self"],"properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"TenantFeatureResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureResource","description":"One entitlement-governed feature.","type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The feature's registry key."},"type":{"type":"string","enum":["features"]},"attributes":{"$ref":"#/components/schemas/TenantFeatureAttributes"},"relationships":{"type":"object","additionalProperties":false,"properties":{"author":{"type":"object","additionalProperties":false,"required":["data"],"description":"Who activated the feature. Absent until activation.","properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","additionalProperties":false,"required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string"}}}}},"TenantFeatureAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureAttributes","description":"The state of one entitlement-governed feature for a tenant. The tenant's plan sets `granted` and the tenant's own admins set `enabled`. The response includes features the plan doesn't grant, with `granted` set to `false`.","type":"object","additionalProperties":false,"required":["granted","enabled","effective"],"properties":{"granted":{"type":"boolean","description":"The tenant's plan offers this feature."},"enabled":{"type":"boolean","description":"The tenant has activated this feature. Activation is permanent."},"effective":{"type":"boolean","description":"Both `granted` and `enabled`. Gate behaviour on this value only."},"availableOn":{"type":"array","items":{"type":"string","enum":["pro","team","enterprise"]},"description":"Plans that offer this feature. Omitted when every plan offers it. An empty array means no plan offers it any more."},"created":{"type":"string","format":"date-time","description":"When the tenant activated the feature. Absent until activation."},"updated":{"type":"string","format":"date-time","description":"When the activation last changed. Absent until activation."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UpdateTenantFeatureRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateTenantFeatureRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateTenantFeatureRequest","description":"Activates a feature for the tenant.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["features"]},"attributes":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean","const":true,"description":"Must be `true`. You can't undo activation."}}}}}}},"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}}}}}}}}
```

## The TenantFeatureFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureFindOneResponse","description":"The feature after activation.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/TenantFeatureResource"},"links":{"type":"object","additionalProperties":false,"required":["self"],"properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"TenantFeatureResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureResource","description":"One entitlement-governed feature.","type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The feature's registry key."},"type":{"type":"string","enum":["features"]},"attributes":{"$ref":"#/components/schemas/TenantFeatureAttributes"},"relationships":{"type":"object","additionalProperties":false,"properties":{"author":{"type":"object","additionalProperties":false,"required":["data"],"description":"Who activated the feature. Absent until activation.","properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","meta"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","additionalProperties":false,"required":["tenantId","type","displayName"],"properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"related":{"type":"string"}}}}}}},"links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string"}}}}},"TenantFeatureAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureAttributes","description":"The state of one entitlement-governed feature for a tenant. The tenant's plan sets `granted` and the tenant's own admins set `enabled`. The response includes features the plan doesn't grant, with `granted` set to `false`.","type":"object","additionalProperties":false,"required":["granted","enabled","effective"],"properties":{"granted":{"type":"boolean","description":"The tenant's plan offers this feature."},"enabled":{"type":"boolean","description":"The tenant has activated this feature. Activation is permanent."},"effective":{"type":"boolean","description":"Both `granted` and `enabled`. Gate behaviour on this value only."},"availableOn":{"type":"array","items":{"type":"string","enum":["pro","team","enterprise"]},"description":"Plans that offer this feature. Omitted when every plan offers it. An empty array means no plan offers it any more."},"created":{"type":"string","format":"date-time","description":"When the tenant activated the feature. Absent until activation."},"updated":{"type":"string","format":"date-time","description":"When the activation last changed. Absent until activation."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The TenantFeatureActivationAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureActivationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureActivationAttributes","description":"One tenant's key, plan and the effective state of every registered feature.","type":"object","additionalProperties":false,"required":["tenantKey","plan","features"],"properties":{"tenantKey":{"type":"string","description":"The tenant's human-readable key."},"plan":{"type":"string","enum":["pro","team","enterprise"],"description":"The tenant's plan. It decides `granted` for each feature."},"features":{"type":"array","description":"The effective state of each registered feature.","items":{"type":"object","additionalProperties":false,"required":["featureKey","granted","enabled","effective"],"properties":{"featureKey":{"type":"string"},"granted":{"type":"boolean"},"enabled":{"type":"boolean"},"effective":{"type":"boolean"},"activatedAt":{"type":"string","format":"date-time","description":"When this tenant activated the feature. Absent until activation."}}}}}}}}}
```

## The TenantFeatureActivationFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantFeatureActivationFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureActivationFindManyResponse","description":"Every tenant's activation state for each registered feature. Fabric staff only. Returns one resource per tenant.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The tenant id."},"type":{"type":"string","enum":["tenantFeatureActivations"]},"attributes":{"$ref":"#/components/schemas/TenantFeatureActivationAttributes"}}}},"links":{"type":"object","additionalProperties":false,"required":["self"],"properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"TenantFeatureActivationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantFeatureActivationAttributes","description":"One tenant's key, plan and the effective state of every registered feature.","type":"object","additionalProperties":false,"required":["tenantKey","plan","features"],"properties":{"tenantKey":{"type":"string","description":"The tenant's human-readable key."},"plan":{"type":"string","enum":["pro","team","enterprise"],"description":"The tenant's plan. It decides `granted` for each feature."},"features":{"type":"array","description":"The effective state of each registered feature.","items":{"type":"object","additionalProperties":false,"required":["featureKey","granted","enabled","effective"],"properties":{"featureKey":{"type":"string"},"granted":{"type":"boolean"},"enabled":{"type":"boolean"},"effective":{"type":"boolean"},"activatedAt":{"type":"string","format":"date-time","description":"When this tenant activated the feature. Absent until activation."}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The PolicyTemplateAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"}}}}
```

## The PolicyTemplateRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The PolicyTemplateFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateFindManyResponse","description":"A list of policy templates.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"title":"IPolicyTemplate","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The CreatePolicyTemplateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreatePolicyTemplateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateCreateRequest","description":"Creates a policy template.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"$ref":"#/components/schemas/PolicyTemplateAttributes"}}}}},"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}}}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"}}}}
```

## The PolicyTemplateCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateCreateOneResponse","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The PolicyTemplateFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateFindOneResponse","description":"A policy template.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"},"assignmentsCount":{"type":"number","description":"Number of active assignments for this template"}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The PolicyTemplateUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateUpdateOneRequest","description":"Updates a policy template.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string"},"description":{"type":"string"},"actions":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"Record-type templates only. Grants access to the change history of the records the policy covers, under the same conditions as the rest of the policy. Send `false` to revoke."},"recordMoveAccess":{"type":"boolean","description":"Record-type templates only. Lets users move the records the policy covers under another parent, under the same conditions as the rest of the policy. Send `false` to revoke."}}}}}}},"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}}}}},"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}$"}}}}
```

## The PolicyTemplateUpdateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateUpdateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateUpdateOneResponse","description":"The updated policy template.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The AssignPolicyTemplateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AssignPolicyTemplateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAssignPolicyTemplateRequest","description":"Creates policies from a template for the given roles and, optionally, security tags.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["policies"]},"attributes":{"type":"object","required":["roleIds"],"additionalProperties":false,"properties":{"roleIds":{"type":"array","items":{"type":"string"},"minItems":1,"description":"The roles to assign."},"securityTagIds":{"type":"array","items":{"type":"string"},"description":"Security tags for the policies. Required for `record` templates; the server ignores them for every other template type."}}}}}}},"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}}}}}}}}
```

## The PolicyAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyAttributes","description":"A policy's attributes.","additionalProperties":false,"required":["resourceType"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this policy applies to"}}}}}}
```

## The RoleRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationship","description":"A relationship to a role","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"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}}}}
```

## The PolicyTemplateRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyTemplateRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateRelationship","description":"A relationship to a policy template","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"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}}}}
```

## The SecurityTagRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagRelationship","description":"A relationship to a security tag","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"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}}}}
```

## The PolicyRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyRelationships","description":"The policy's tenant, role and security tag.","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"role":{"$ref":"#/components/schemas/RoleRelationship"},"template":{"$ref":"#/components/schemas/PolicyTemplateRelationship"},"securityTag":{"$ref":"#/components/schemas/SecurityTagRelationship"}},"required":["tenant","role"],"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},"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},"RoleRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationship","description":"A relationship to a role","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"PolicyTemplateRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateRelationship","description":"A relationship to a policy template","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"SecurityTagRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagRelationship","description":"A relationship to a security tag","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false}}}}
```

## The PolicyFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyFindManyResponse","description":"A list of policies.","additionalProperties":false,"required":["data","links","included","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policies"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"},"next":{"type":"string","nullable":true}},"additionalProperties":false},"included":{"type":"array","items":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}}},"meta":{"type":"object","properties":{"cursor":{"type":"string","nullable":true}},"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"}}},"PolicyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyAttributes","description":"A policy's attributes.","additionalProperties":false,"required":["resourceType"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this policy applies to"}}},"PolicyRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyRelationships","description":"The policy's tenant, role and security tag.","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"role":{"$ref":"#/components/schemas/RoleRelationship"},"template":{"$ref":"#/components/schemas/PolicyTemplateRelationship"},"securityTag":{"$ref":"#/components/schemas/SecurityTagRelationship"}},"required":["tenant","role"],"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},"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},"RoleRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationship","description":"A relationship to a role","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"PolicyTemplateRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateRelationship","description":"A relationship to a policy template","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"SecurityTagRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagRelationship","description":"A relationship to a security tag","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The PolicyFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyFindOneResponse","description":"A policy.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policies"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"},"avpPolicy":{"type":"object","description":"The stored policy details.","properties":{"resource":{"type":"object","properties":{"entityType":{"type":"string"},"entityId":{"type":"string"}},"required":["entityType","entityId"],"additionalProperties":false},"principal":{"type":"object","properties":{"entityType":{"type":"string"},"entityId":{"type":"string"}},"required":["entityType","entityId"],"additionalProperties":false},"actions":{"type":"array","items":{"type":"object","properties":{"actionType":{"type":"string"},"actionId":{"type":"string"}},"required":["actionType","actionId"],"additionalProperties":false}},"effect":{"type":"string","enum":["Permit","Forbid"]}},"additionalProperties":false}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyAttributes","description":"A policy's attributes.","additionalProperties":false,"required":["resourceType"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this policy applies to"}}},"PolicyRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyRelationships","description":"The policy's tenant, role and security tag.","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"role":{"$ref":"#/components/schemas/RoleRelationship"},"template":{"$ref":"#/components/schemas/PolicyTemplateRelationship"},"securityTag":{"$ref":"#/components/schemas/SecurityTagRelationship"}},"required":["tenant","role"],"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},"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},"RoleRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationship","description":"A relationship to a role","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"PolicyTemplateRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateRelationship","description":"A relationship to a policy template","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"SecurityTagRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagRelationship","description":"A relationship to a security tag","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The policyRefObject object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"policyRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"policies"}},"required":["id","type"],"additionalProperties":false}}}}
```

## The PolicyAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PolicyAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyAtomicOperationsRequest","description":"JSON:API Atomic Operations request. Use `remove` operations to delete one or more policies in one call.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"atomic:operations":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"op":{"const":"remove"},"ref":{"$ref":"#/components/schemas/policyRefObject"}},"required":["op","ref"],"additionalProperties":false}}},"required":["atomic:operations"],"additionalProperties":false,"definitions":{"policyRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"policies"}},"required":["id","type"],"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}}}}},"policyRefObject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"policies"}},"required":["id","type"],"additionalProperties":false}}}}
```

## The SecurityTagAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagAttributes","description":"A security tag's name and description.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"description":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The SecurityTagFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagFindManyResponse","description":"The tenant's security tags.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/SecurityTagAttributes"}]}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"SecurityTagAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagAttributes","description":"A security tag's name and description.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"description":{"type":"string"},"name":{"type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateSecurityTagRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateSecurityTagRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagCreateRequest","description":"Creates a security tag in the tenant.","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":["securityTags"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"name":{"type":"string"}},"required":["description","name"]}}}}},"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}}}}}}}}
```

## The SecurityTagCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"ISecurityTagCreateOneResponse","description":"The created security tag and its `self` link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/SecurityTagAttributes","required":["description","name"]}]}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"SecurityTagAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagAttributes","description":"A security tag's name and description.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"description":{"type":"string"},"name":{"type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The SecurityTagFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"SecurityTagFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagFindOneResponse","description":"One security tag.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/SecurityTagAttributes","required":["description"]}]}}},"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"}}},"SecurityTagAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagAttributes","description":"A security tag's name and description.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"description":{"type":"string"},"name":{"type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UpdateSecurityTagRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateSecurityTagRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISecurityTagUpdateRequest","description":"Updates a security tag.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["securityTags"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}},"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}}}}}}}}
```

## The ApiKeyAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ApiKeyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyAttributes","description":"An API key's attributes. They never include the raw key: only the create response returns it.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"valuePreview":{"description":"Masked, non-secret preview of the key, such as `ak_prd_••••••••1a2b`. Identifies the key in a list.","type":"string"},"expiresAt":{"description":"ISO 8601 time after which the server refuses the key.","type":"string"}}}}}}
```

## The ApiKeyFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ApiKeyFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyFindManyResponse","description":"A list of API keys.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/ApiKeyAttributes"}]}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"ApiKeyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyAttributes","description":"An API key's attributes. They never include the raw key: only the create response returns it.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"valuePreview":{"description":"Masked, non-secret preview of the key, such as `ak_prd_••••••••1a2b`. Identifies the key in a list.","type":"string"},"expiresAt":{"description":"ISO 8601 time after which the server refuses the key.","type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateApiKeyRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateApiKeyRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyCreateRequest","description":"Creates an API key in the tenant. Set its roles in `relationships.roles` as role resource identifiers.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["apiKeys"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"name":{"type":"string"},"expiresInDays":{"description":"Days until the key stops working, counted from creation. Defaults to 90.","type":"integer","enum":[30,60,90,180,365]}},"required":["description","name"]},"relationships":{"type":"object","additionalProperties":false,"required":["roles"],"properties":{"roles":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}}}}}}}}}}}},"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}}}}}}}}
```

## The ApiKeyCreateAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ApiKeyCreateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyCreateAttributes","description":"The new API key's attributes, including the raw key.","type":"object","additionalProperties":false,"required":["description","name","value"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"value":{"description":"The raw API key, in the format `ak_<env>_<32 hex chars>`. Only this response returns it and you can't retrieve it again, so show it to the user right away.","type":"string"},"valuePreview":{"description":"Masked, non-secret preview of the key, such as `ak_prd_••••••••1a2b`.","type":"string"},"expiresAt":{"description":"ISO 8601 time after which the server refuses the key.","type":"string"}}}}}}
```

## The ApiKeyCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ApiKeyCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IApiKeyCreateOneResponse","description":"The created API key and its self link. Only this response includes the raw key.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/ApiKeyCreateAttributes","required":["description","name","value"]}]}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"ApiKeyCreateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyCreateAttributes","description":"The new API key's attributes, including the raw key.","type":"object","additionalProperties":false,"required":["description","name","value"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"value":{"description":"The raw API key, in the format `ak_<env>_<32 hex chars>`. Only this response returns it and you can't retrieve it again, so show it to the user right away.","type":"string"},"valuePreview":{"description":"Masked, non-secret preview of the key, such as `ak_prd_••••••••1a2b`.","type":"string"},"expiresAt":{"description":"ISO 8601 time after which the server refuses the key.","type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ApiKeyFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ApiKeyFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyFindOneResponse","description":"An API key.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["apiKeys"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/ApiKeyAttributes","required":["description"]}]}}},"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"}}},"ApiKeyAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IApiKeyAttributes","description":"An API key's attributes. They never include the raw key: only the create response returns it.","type":"object","additionalProperties":false,"required":["description","name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"valuePreview":{"description":"Masked, non-secret preview of the key, such as `ak_prd_••••••••1a2b`. Identifies the key in a list.","type":"string"},"expiresAt":{"description":"ISO 8601 time after which the server refuses the key.","type":"string"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The AiAssistantConfigAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigAttributes","description":"The tenant's AI assistant settings. Read-only.","type":"object","additionalProperties":false,"required":["modelProvider","modelId","apiKeyConfigured","created","updated"],"properties":{"modelProvider":{"type":"string","enum":["bedrock","custom"],"description":"Where the model comes from.\n- `custom`: a model and API key you provide.\n- `bedrock`: a Fabric-provided model. Read-only: you can't create new configurations with it."},"modelId":{"type":"string","minLength":1,"description":"The model id.\n- `custom`: the LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`.\n- `bedrock`: the Fabric-managed model id."},"apiKeyConfigured":{"type":"boolean","description":"Whether the configuration has a stored API key."},"apiKeyArn":{"type":"string","description":"Reference to the stored API key. The server never returns the raw key. Absent when `apiKeyConfigured` is false."},"created":{"type":"string","format":"date-time","description":"When this configuration was created"},"updated":{"type":"string","format":"date-time","description":"When this configuration was last updated"}}}}}}
```

## The AiAssistantConfigFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AiAssistantConfigFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigFindManyResponse","description":"A list of AI assistant configurations.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/AiAssistantConfigAttributes"}]}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"AiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigAttributes","description":"The tenant's AI assistant settings. Read-only.","type":"object","additionalProperties":false,"required":["modelProvider","modelId","apiKeyConfigured","created","updated"],"properties":{"modelProvider":{"type":"string","enum":["bedrock","custom"],"description":"Where the model comes from.\n- `custom`: a model and API key you provide.\n- `bedrock`: a Fabric-provided model. Read-only: you can't create new configurations with it."},"modelId":{"type":"string","minLength":1,"description":"The model id.\n- `custom`: the LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`.\n- `bedrock`: the Fabric-managed model id."},"apiKeyConfigured":{"type":"boolean","description":"Whether the configuration has a stored API key."},"apiKeyArn":{"type":"string","description":"Reference to the stored API key. The server never returns the raw key. Absent when `apiKeyConfigured` is false."},"created":{"type":"string","format":"date-time","description":"When this configuration was created"},"updated":{"type":"string","format":"date-time","description":"When this configuration was last updated"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateAiAssistantConfigAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateAiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateAiAssistantConfigAttributes","description":"The AI assistant configuration to create.","type":"object","additionalProperties":false,"required":["modelProvider","apiKey"],"properties":{"modelProvider":{"type":"string","enum":["custom"],"description":"Where the model comes from. Only `custom` is supported: you supply the model and API key."},"modelId":{"type":"string","minLength":1,"description":"The LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`. Required."},"apiKey":{"type":"string","description":"Your provider API key. Write-only: the server stores it securely and never returns it."}}}}}}
```

## The CreateAiAssistantConfigRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateAiAssistantConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigCreateRequest","description":"Creates the tenant's AI assistant configuration. A tenant can have only one.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["aiAssistantConfigs"]},"attributes":{"$ref":"#/components/schemas/CreateAiAssistantConfigAttributes"}}}}},"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}}}}},"CreateAiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateAiAssistantConfigAttributes","description":"The AI assistant configuration to create.","type":"object","additionalProperties":false,"required":["modelProvider","apiKey"],"properties":{"modelProvider":{"type":"string","enum":["custom"],"description":"Where the model comes from. Only `custom` is supported: you supply the model and API key."},"modelId":{"type":"string","minLength":1,"description":"The LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`. Required."},"apiKey":{"type":"string","description":"Your provider API key. Write-only: the server stores it securely and never returns it."}}}}}}
```

## The AiAssistantConfigCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AiAssistantConfigCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IAiAssistantConfigCreateOneResponse","description":"The created AI assistant configuration and its self link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/AiAssistantConfigAttributes"}]}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"AiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigAttributes","description":"The tenant's AI assistant settings. Read-only.","type":"object","additionalProperties":false,"required":["modelProvider","modelId","apiKeyConfigured","created","updated"],"properties":{"modelProvider":{"type":"string","enum":["bedrock","custom"],"description":"Where the model comes from.\n- `custom`: a model and API key you provide.\n- `bedrock`: a Fabric-provided model. Read-only: you can't create new configurations with it."},"modelId":{"type":"string","minLength":1,"description":"The model id.\n- `custom`: the LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`.\n- `bedrock`: the Fabric-managed model id."},"apiKeyConfigured":{"type":"boolean","description":"Whether the configuration has a stored API key."},"apiKeyArn":{"type":"string","description":"Reference to the stored API key. The server never returns the raw key. Absent when `apiKeyConfigured` is false."},"created":{"type":"string","format":"date-time","description":"When this configuration was created"},"updated":{"type":"string","format":"date-time","description":"When this configuration was last updated"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The AiAssistantConfigFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"AiAssistantConfigFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigFindOneResponse","description":"An AI assistant configuration.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["aiAssistantConfigs"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/AiAssistantConfigAttributes"}]}}},"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"}}},"AiAssistantConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigAttributes","description":"The tenant's AI assistant settings. Read-only.","type":"object","additionalProperties":false,"required":["modelProvider","modelId","apiKeyConfigured","created","updated"],"properties":{"modelProvider":{"type":"string","enum":["bedrock","custom"],"description":"Where the model comes from.\n- `custom`: a model and API key you provide.\n- `bedrock`: a Fabric-provided model. Read-only: you can't create new configurations with it."},"modelId":{"type":"string","minLength":1,"description":"The model id.\n- `custom`: the LiteLLM model id, normally provider-qualified, such as `anthropic/claude-sonnet-4`.\n- `bedrock`: the Fabric-managed model id."},"apiKeyConfigured":{"type":"boolean","description":"Whether the configuration has a stored API key."},"apiKeyArn":{"type":"string","description":"Reference to the stored API key. The server never returns the raw key. Absent when `apiKeyConfigured` is false."},"created":{"type":"string","format":"date-time","description":"When this configuration was created"},"updated":{"type":"string","format":"date-time","description":"When this configuration was last updated"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UpdateAiAssistantConfigRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UpdateAiAssistantConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IAiAssistantConfigUpdateRequest","description":"Updates the AI assistant configuration. Changes only the attributes you send.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["aiAssistantConfigs"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"modelProvider":{"type":"string","enum":["custom"],"description":"The model provider. Accepts only `custom`: send it to move a Fabric-provided configuration to your own model and API key."},"modelId":{"type":"string","minLength":1,"description":"The LiteLLM model id, usually provider-qualified, such as `anthropic/claude-sonnet-4`."},"apiKey":{"type":"string","description":"Write-only. Your provider API key. The server stores it securely and never returns it. Send a new key to rotate it."}}}}}}},"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}}}}}}}}
```

## The EventSubscriptionFormat object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]}}}}
```

## The EventSubscriptionResourceType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]}}}}
```

## The RecordEventSubscriptionFilter object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}}}}}
```

## The EventSubscriptionAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionAttributes","description":"An event subscription's attributes.","type":"object","additionalProperties":false,"required":["name","type","endpoint","subscriptionArn"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"endpoint":{"type":"string"},"subscriptionArn":{"type":"string"},"format":{"$ref":"#/components/schemas/EventSubscriptionFormat"},"resourceType":{"$ref":"#/components/schemas/EventSubscriptionResourceType"},"filter":{"$ref":"#/components/schemas/RecordEventSubscriptionFilter"}}},"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]},"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]},"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}}}}}
```

## The EventSubscriptionFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFindManyResponse","description":"A list of event subscriptions.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/EventSubscriptionAttributes"}]},"relationships":{"type":"object","properties":{"author":{"$ref":"#/components/schemas/UserRelationship"}},"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"meta":{"type":"object","properties":{"awsRegion":{"type":"string"},"awsAccountId":{"type":"string"},"tenantId":{"type":"string"},"awsSubscriptions":{"type":"array","items":{"type":"object","properties":{"subscriptionArn":{"type":"string"},"pendingConfirmation":{"type":"boolean"}},"required":["subscriptionArn","pendingConfirmation"],"additionalProperties":false}}},"required":["awsRegion","awsAccountId","tenantId"," awsSubscriptions"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"EventSubscriptionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionAttributes","description":"An event subscription's attributes.","type":"object","additionalProperties":false,"required":["name","type","endpoint","subscriptionArn"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"endpoint":{"type":"string"},"subscriptionArn":{"type":"string"},"format":{"$ref":"#/components/schemas/EventSubscriptionFormat"},"resourceType":{"$ref":"#/components/schemas/EventSubscriptionResourceType"},"filter":{"$ref":"#/components/schemas/RecordEventSubscriptionFilter"}}},"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]},"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]},"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}},"UserRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRelationship","description":"A relationship to the actor behind a write, such as `author` or `updatedBy`. `data.meta.type` is the actor type: a human user, an API key or an internal service. Only human users carry `links.related`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"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},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateEventSubscriptionRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateEventSubscriptionRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionCreateOneRequest","description":"Creates an event subscription in the tenant.","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":["eventSubscriptions"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"description":"Where the server delivers events.\n- `sqs`: an Amazon SQS queue, with its ARN in `endpoint`.\n- `webhook`: an HTTP or HTTPS URL.","type":"string","enum":["sqs","webhook"]},"endpoint":{"description":"The SQS queue ARN or the webhook URL.","type":"string"},"format":{"$ref":"#/components/schemas/EventSubscriptionFormat"},"resourceType":{"$ref":"#/components/schemas/EventSubscriptionResourceType"},"filter":{"$ref":"#/components/schemas/RecordEventSubscriptionFilter"}},"required":["name","type","endpoint","resourceType","filter"]}}}}},"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}}}}},"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]},"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]},"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}}}}}
```

## The EventSubscriptionCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IEventSubscriptionCreateOneResponse","description":"The created event subscription and its self link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/EventSubscriptionAttributes","required":["name","type","endpoint"]}]}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"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},"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"}}},"EventSubscriptionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionAttributes","description":"An event subscription's attributes.","type":"object","additionalProperties":false,"required":["name","type","endpoint","subscriptionArn"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"endpoint":{"type":"string"},"subscriptionArn":{"type":"string"},"format":{"$ref":"#/components/schemas/EventSubscriptionFormat"},"resourceType":{"$ref":"#/components/schemas/EventSubscriptionResourceType"},"filter":{"$ref":"#/components/schemas/RecordEventSubscriptionFilter"}}},"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]},"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]},"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The EventSubscriptionFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EventSubscriptionFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFindOneResponse","description":"An event subscription.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["eventSubscriptions"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/EventSubscriptionAttributes"}]}}},"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"}}},"EventSubscriptionAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionAttributes","description":"An event subscription's attributes.","type":"object","additionalProperties":false,"required":["name","type","endpoint","subscriptionArn"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"endpoint":{"type":"string"},"subscriptionArn":{"type":"string"},"format":{"$ref":"#/components/schemas/EventSubscriptionFormat"},"resourceType":{"$ref":"#/components/schemas/EventSubscriptionResourceType"},"filter":{"$ref":"#/components/schemas/RecordEventSubscriptionFilter"}}},"EventSubscriptionFormat":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionFormat","description":"Message format.\n- `cloudevents`: CloudEvents 1.0 events (see `RecordCloudEvent`). `filter` selects which events you receive.","type":"string","enum":["cloudevents"]},"EventSubscriptionResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEventSubscriptionResourceType","description":"The resource type the subscription receives events for. Each subscription covers exactly one.","type":"string","enum":["records"]},"RecordEventSubscriptionFilter":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRecordEventSubscriptionFilter","description":"Selects the record events a records subscription receives. The subscription gets every event type in `eventTypes` for every record; `updated` can narrow `record.updated`. Allows at most 150 combinations: one per event type other than `record.updated`, plus, for `record.updated`, the product of the value counts of each `updated` property.","type":"object","additionalProperties":false,"required":["eventTypes"],"properties":{"eventTypes":{"description":"Event types to receive, as an explicit list. You never receive event types added later until you add them.\n- `record.created`: a new record.\n- `record.updated`: any other write to a record, such as a field value, its title, lifecycle status, parent or position. Each save sends one event that lists every key it saved.\n- `record.deleted`: a record moved to the deleted records.\n- `record.restored`: a record came back from the deleted records.\n- `record.purged`: a record's permanent deletion.","type":"array","uniqueItems":true,"items":{"type":"string","enum":["record.created","record.updated","record.deleted","record.restored","record.purged"]}},"updated":{"description":"Narrows `record.updated` events. Use it only when `eventTypes` includes `record.updated`. An event must match every property you set, and any one value within a property. An omitted property matches any value. Set `lifecycleStatuses` or `lifecyclePhases`, not both.","type":"object","additionalProperties":false,"properties":{"lifecycleStatuses":{"description":"Only updates to records whose lifecycle status, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"lifecyclePhases":{"description":"Only updates to records whose lifecycle phase, after the change, is one of these ids.","type":"array","uniqueItems":true,"items":{"type":"string"}},"savedKeys":{"description":"Only updates that saved at least one of these attribute or field keys.","type":"array","uniqueItems":true,"items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ITenantFullDeleteJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ITenantFullDeleteJobParameters":{"type":"object","properties":{"tenantIdToDelete":{"type":"string","description":"The tenant to delete."}},"required":["tenantIdToDelete"],"additionalProperties":false}}}}
```

## The ITenantSyncSystemPoliciesJobParameters object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ITenantSyncSystemPoliciesJobParameters":{"type":"object","properties":{"tenantIdToSync":{"type":"string","description":"Syncs only this tenant. Omit to sync all tenants."}},"additionalProperties":false}}}}
```

## The TenantJobCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantJobCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantJobCreateOneRequest","description":"Starts a tenant background job of the given `type` with its `parameters`.","type":"object","definitions":{"ITenantFullDeleteJobParameters":{"type":"object","properties":{"tenantIdToDelete":{"type":"string","description":"The tenant to delete."}},"required":["tenantIdToDelete"],"additionalProperties":false},"ITenantSyncSystemPoliciesJobParameters":{"type":"object","properties":{"tenantIdToSync":{"type":"string","description":"Syncs only this tenant. Omit to sync all tenants."}},"additionalProperties":false}},"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"type":"object","properties":{"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["fullTenantDelete","syncSystemPolicies"],"description":"The job to start."},"parameters":{"oneOf":[{"$ref":"#/components/schemas/ITenantFullDeleteJobParameters"},{"$ref":"#/components/schemas/ITenantSyncSystemPoliciesJobParameters"}]}},"required":["type","parameters"],"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"required":["data"],"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"]},"ITenantFullDeleteJobParameters":{"type":"object","properties":{"tenantIdToDelete":{"type":"string","description":"The tenant to delete."}},"required":["tenantIdToDelete"],"additionalProperties":false},"ITenantSyncSystemPoliciesJobParameters":{"type":"object","properties":{"tenantIdToSync":{"type":"string","description":"Syncs only this tenant. Omit to sync all tenants."}},"additionalProperties":false}}}}
```

## The TenantJob object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantJob","description":"A tenant-level background job, such as a full tenant delete.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["fullTenantDelete","syncSystemPolicies"]},"parameters":{"type":"object","additionalProperties":true}},"required":["type","parameters"],"additionalProperties":false}],"required":["arn","status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]}}}}
```

## The TenantJobCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"TenantJobCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantJobCreateOneResponse","description":"The started job and its `self` link.","type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/TenantJob"},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"]},"relationships":{"type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"additionalProperties":false}},"required":["id","attributes","links","relationships"]}]},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"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"]},"TenantJob":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantJob","description":"A tenant-level background job, such as a full tenant delete.","type":"object","allOf":[{"$ref":"#/components/schemas/BackgroundJobAttributes"},{"type":"object","properties":{"type":{"type":"string","enum":["fullTenantDelete","syncSystemPolicies"]},"parameters":{"type":"object","additionalProperties":true}},"required":["type","parameters"],"additionalProperties":false}],"required":["arn","status","created","updated","type","parameters"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"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"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"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},"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}}}}
```

## The UserAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UserAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserAttributes","description":"A user's attributes. For `external` users, the identity provider owns `given_name` and `family_name`, and you can't change them.","type":"object","additionalProperties":false,"properties":{"email_verified":{"type":"boolean"},"picture":{"type":"string","description":"URL of the user's picture."},"name":{"type":"string","description":"Display name. The server keeps it in sync with `given_name` and `family_name`."},"given_name":{"type":"string","description":"First name. Absent until the user or an administrator sets it; invited accounts start without one."},"family_name":{"type":"string","description":"Last name. Absent until set."},"email":{"type":"string","description":"The user's email address."},"roles":{"type":"array","description":"Role names the user holds *in the requesting tenant*. The same account can hold different roles in other tenants.","items":{"type":"string"}},"source":{"type":"string","description":"Where the user comes from.\n- `local`: created in Origin Studio.\n- `external`: federated from an external identity provider.","enum":["local","external"]},"identity_provider":{"type":"string","description":"The identity provider the user signs in with, such as `local` or `google-oauth2`."},"disabled":{"type":"boolean","description":"Whether the user is deactivated in the requesting tenant only. Unlike `blocked`, you can change it, through `PATCH /users/{userId}`."},"blocked":{"type":"boolean","description":"Whether the whole Auth0 account is blocked, which denies the user in every tenant and every Fabric application. Read-only: someone sets it by hand in Auth0 and this API never changes it, so you can't reactivate a blocked user from the product."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}}}}}
```

## The User object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"User":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUser","description":"A person with access to Origin Studio, with profile attributes (email, name, picture, status, and the names of the roles held in this tenant) and a relationship to the owning tenant.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"type":{"type":"string","const":"users"},"attributes":{"allOf":[{"$ref":"#/components/schemas/UserAttributes"}],"additionalProperties":false},"relationships":{"type":"object","required":["tenant"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}}}},"required":["type","attributes","relationships"],"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},"UserAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserAttributes","description":"A user's attributes. For `external` users, the identity provider owns `given_name` and `family_name`, and you can't change them.","type":"object","additionalProperties":false,"properties":{"email_verified":{"type":"boolean"},"picture":{"type":"string","description":"URL of the user's picture."},"name":{"type":"string","description":"Display name. The server keeps it in sync with `given_name` and `family_name`."},"given_name":{"type":"string","description":"First name. Absent until the user or an administrator sets it; invited accounts start without one."},"family_name":{"type":"string","description":"Last name. Absent until set."},"email":{"type":"string","description":"The user's email address."},"roles":{"type":"array","description":"Role names the user holds *in the requesting tenant*. The same account can hold different roles in other tenants.","items":{"type":"string"}},"source":{"type":"string","description":"Where the user comes from.\n- `local`: created in Origin Studio.\n- `external`: federated from an external identity provider.","enum":["local","external"]},"identity_provider":{"type":"string","description":"The identity provider the user signs in with, such as `local` or `google-oauth2`."},"disabled":{"type":"boolean","description":"Whether the user is deactivated in the requesting tenant only. Unlike `blocked`, you can change it, through `PATCH /users/{userId}`."},"blocked":{"type":"boolean","description":"Whether the whole Auth0 account is blocked, which denies the user in every tenant and every Fabric application. Read-only: someone sets it by hand in Auth0 and this API never changes it, so you can't reactivate a blocked user from the product."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"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},"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}}}}
```

## The GetUsersResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetUsersResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGetUsersResponse","description":"A page of users in a tenant. Each item in `data` is a full user with profile attributes, role relationships, `meta.tenantId` and a self link. The top-level `meta` holds the total count and pagination offsets.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/User"},{"type":"object","additionalProperties":false,"required":["meta","links"],"properties":{"meta":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false}}}]},"additionalProperties":false},"meta":{"type":"object","properties":{"total":{"type":"integer"},"start":{"type":"integer"},"limit":{"type":"integer"}},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"User":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUser","description":"A person with access to Origin Studio, with profile attributes (email, name, picture, status, and the names of the roles held in this tenant) and a relationship to the owning tenant.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"type":{"type":"string","const":"users"},"attributes":{"allOf":[{"$ref":"#/components/schemas/UserAttributes"}],"additionalProperties":false},"relationships":{"type":"object","required":["tenant"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}}}},"required":["type","attributes","relationships"],"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},"UserAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserAttributes","description":"A user's attributes. For `external` users, the identity provider owns `given_name` and `family_name`, and you can't change them.","type":"object","additionalProperties":false,"properties":{"email_verified":{"type":"boolean"},"picture":{"type":"string","description":"URL of the user's picture."},"name":{"type":"string","description":"Display name. The server keeps it in sync with `given_name` and `family_name`."},"given_name":{"type":"string","description":"First name. Absent until the user or an administrator sets it; invited accounts start without one."},"family_name":{"type":"string","description":"Last name. Absent until set."},"email":{"type":"string","description":"The user's email address."},"roles":{"type":"array","description":"Role names the user holds *in the requesting tenant*. The same account can hold different roles in other tenants.","items":{"type":"string"}},"source":{"type":"string","description":"Where the user comes from.\n- `local`: created in Origin Studio.\n- `external`: federated from an external identity provider.","enum":["local","external"]},"identity_provider":{"type":"string","description":"The identity provider the user signs in with, such as `local` or `google-oauth2`."},"disabled":{"type":"boolean","description":"Whether the user is deactivated in the requesting tenant only. Unlike `blocked`, you can change it, through `PATCH /users/{userId}`."},"blocked":{"type":"boolean","description":"Whether the whole Auth0 account is blocked, which denies the user in every tenant and every Fabric application. Read-only: someone sets it by hand in Auth0 and this API never changes it, so you can't reactivate a blocked user from the product."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"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},"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}}}}
```

## The CreateUsersRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateUsersRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateUsersRequest","description":"Creates one or more users. Each entry in `data` gives an email address and the role IDs to assign. Each new user gets an invitation email and must verify their account before signing in.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"attributes":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The user's email address."},"roles":{"type":"array","items":{"type":"string"},"description":"Role IDs to assign to the user."}},"required":["email","roles"],"additionalProperties":false}},"required":["type","attributes"],"additionalProperties":false}}},"required":["data"],"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}}}}}}}}
```

## The CreateUsersData object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateUsersData":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateUsersData","description":"Outcome of a batch user create.\n- `created`: users the server created, with their email and assigned role IDs.\n- `failed`: entries it couldn't create, each with the email address, HTTP status code and error details.","type":"object","properties":{"created":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string"},"attributes":{"type":"object","properties":{"email":{"type":"string","format":"email"},"roles":{"type":"array","items":{"type":"string"}}},"required":["email","roles"]}},"required":["type","id","attributes"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"status":{"type":"number"},"title":{"type":"string"},"detail":{"type":"string"}},"required":["email","status","title","detail"],"additionalProperties":false}}},"required":["created","failed"],"additionalProperties":false}}}}
```

## The CreateUsersResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateUsersResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateUsersResponse","description":"Result of a batch user create. It can partly succeed: check both `data.created` and `data.failed`, even on a 201.","type":"object","properties":{"data":{"type":"object","$ref":"#/components/schemas/CreateUsersData"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"CreateUsersData":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateUsersData","description":"Outcome of a batch user create.\n- `created`: users the server created, with their email and assigned role IDs.\n- `failed`: entries it couldn't create, each with the email address, HTTP status code and error details.","type":"object","properties":{"created":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string"},"attributes":{"type":"object","properties":{"email":{"type":"string","format":"email"},"roles":{"type":"array","items":{"type":"string"}}},"required":["email","roles"]}},"required":["type","id","attributes"],"additionalProperties":false}},"failed":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"status":{"type":"number"},"title":{"type":"string"},"detail":{"type":"string"}},"required":["email","status","title","detail"],"additionalProperties":false}}},"required":["created","failed"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The ProfileUpdateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"ProfileUpdateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IProfileUpdateRequest","description":"Updates your own name through `PATCH /users/me`. It accepts only the name fields: change `disabled` and role assignments through `PATCH /users/{userId}`. The access token, not the body, decides whose profile the server writes.\n\nThe server normalises whitespace, then checks `maxLength` again. Answers 403 for federated users (`source: external`).","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Your own user id. Any other id gets 409.","minLength":1},"type":{"type":"string","enum":["users"]},"attributes":{"type":"object","description":"Send at least one field. The server rejects an empty object.","minProperties":1,"additionalProperties":false,"properties":{"given_name":{"type":"string","description":"First name. Must start with a letter. Allows letters of any script, combining marks, and dashes, apostrophes, periods and one or more spaces between letters. The server trims surrounding whitespace and collapses runs of spaces before storing it.","minLength":1,"maxLength":100,"pattern":"^\\u0020*\\p{L}[\\p{L}\\p{M}]*(?:(?:\\.?\\u0020+|[\\p{Pd}\\u0027\\u2019.])[\\p{L}\\p{M}]+)*\\.?\\u0020*$"},"family_name":{"type":"string","description":"Last name, with the same rules as `given_name`. An empty or whitespace-only string clears it.","maxLength":100,"pattern":"^\\u0020*(?:\\p{L}[\\p{L}\\p{M}]*(?:(?:\\.?\\u0020+|[\\p{Pd}\\u0027\\u2019.])[\\p{L}\\p{M}]+)*\\.?)?\\u0020*$"}}}}}}},"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}}}}}}}}
```

## The UserCapabilitiesAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UserCapabilitiesAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserCapabilitiesAttributes","description":"What you can do in the current tenant. The server checks each area live against your roles and policies and reports `canAccess`; a check it can't evaluate reports `false`.","type":"object","additionalProperties":false,"required":["deliveryWorkspace","workingSets","administration","bulkActions"],"properties":{"deliveryWorkspace":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"workingSets":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"administration":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"bulkActions":{"type":"object","additionalProperties":false,"required":["write","delete"],"properties":{"write":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"delete":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}}}}}}}}}
```

## The GetUserResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"GetUserResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IGetUserResponse","description":"A single user.","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/User"},"meta":{"type":"object","required":["tenantId"],"properties":{"tenantId":{"type":"string"},"permissions":{"$ref":"#/components/schemas/UserCapabilitiesAttributes"}},"additionalProperties":false},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"User":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUser","description":"A person with access to Origin Studio, with profile attributes (email, name, picture, status, and the names of the roles held in this tenant) and a relationship to the owning tenant.","allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"type":{"type":"string","const":"users"},"attributes":{"allOf":[{"$ref":"#/components/schemas/UserAttributes"}],"additionalProperties":false},"relationships":{"type":"object","required":["tenant"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}}}},"required":["type","attributes","relationships"],"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},"UserAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserAttributes","description":"A user's attributes. For `external` users, the identity provider owns `given_name` and `family_name`, and you can't change them.","type":"object","additionalProperties":false,"properties":{"email_verified":{"type":"boolean"},"picture":{"type":"string","description":"URL of the user's picture."},"name":{"type":"string","description":"Display name. The server keeps it in sync with `given_name` and `family_name`."},"given_name":{"type":"string","description":"First name. Absent until the user or an administrator sets it; invited accounts start without one."},"family_name":{"type":"string","description":"Last name. Absent until set."},"email":{"type":"string","description":"The user's email address."},"roles":{"type":"array","description":"Role names the user holds *in the requesting tenant*. The same account can hold different roles in other tenants.","items":{"type":"string"}},"source":{"type":"string","description":"Where the user comes from.\n- `local`: created in Origin Studio.\n- `external`: federated from an external identity provider.","enum":["local","external"]},"identity_provider":{"type":"string","description":"The identity provider the user signs in with, such as `local` or `google-oauth2`."},"disabled":{"type":"boolean","description":"Whether the user is deactivated in the requesting tenant only. Unlike `blocked`, you can change it, through `PATCH /users/{userId}`."},"blocked":{"type":"boolean","description":"Whether the whole Auth0 account is blocked, which denies the user in every tenant and every Fabric application. Read-only: someone sets it by hand in Auth0 and this API never changes it, so you can't reactivate a blocked user from the product."},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"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},"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},"UserCapabilitiesAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserCapabilitiesAttributes","description":"What you can do in the current tenant. The server checks each area live against your roles and policies and reports `canAccess`; a check it can't evaluate reports `false`.","type":"object","additionalProperties":false,"required":["deliveryWorkspace","workingSets","administration","bulkActions"],"properties":{"deliveryWorkspace":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"workingSets":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"administration":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"bulkActions":{"type":"object","additionalProperties":false,"required":["write","delete"],"properties":{"write":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"delete":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UserCapabilitiesFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UserCapabilitiesFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserCapabilitiesFindOneResponse","description":"Your capabilities in the current tenant, from `/users/me/capabilities`. `GET /users/{userId}` returns the same values in `meta.permissions` when you read your own record.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userCapabilities"]},"attributes":{"$ref":"#/components/schemas/UserCapabilitiesAttributes"},"meta":{"type":"object","additionalProperties":false,"required":["tenantId"],"properties":{"tenantId":{"type":"string"}}}}},"links":{"type":"object","additionalProperties":false,"required":["self"],"properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UserCapabilitiesAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserCapabilitiesAttributes","description":"What you can do in the current tenant. The server checks each area live against your roles and policies and reports `canAccess`; a check it can't evaluate reports `false`.","type":"object","additionalProperties":false,"required":["deliveryWorkspace","workingSets","administration","bulkActions"],"properties":{"deliveryWorkspace":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"workingSets":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"administration":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"bulkActions":{"type":"object","additionalProperties":false,"required":["write","delete"],"properties":{"write":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}},"delete":{"type":"object","additionalProperties":false,"required":["canAccess"],"properties":{"canAccess":{"type":"boolean"}}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The PatchUserRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"PatchUserRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPatchUserRequest","description":"Updates a user's `disabled` status in `attributes`, replaces their role assignments in `relationships.roles`, or both. Both apply to the requesting tenant only. `data.id` must match the `userId` path parameter.\n\n`relationships.roles.data` needs at least one role, so unlike the usual JSON:API rule, an empty array can't clear a user's roles. Omit `relationships` to keep roles unchanged, and set `attributes.disabled` to revoke access.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"required":["id","type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["users"]},"attributes":{"type":"object","additionalProperties":false,"properties":{"disabled":{"type":"boolean"}}},"relationships":{"type":"object","required":["roles"],"additionalProperties":false,"properties":{"roles":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]}}}}}}}}}}]}}},"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}}}}
```

## The UserRoleAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UserRoleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRoleAttributes","description":"Attributes of a role.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name, such as `Admin` or `Editor`."},"description":{"type":"string","description":"What the role is for."},"dataSource":{"type":"string","description":"Who owns the role.\n- `fabric`: a system role Fabric provisions. You can't delete it.\n- `custom`: a role the tenant created.","enum":["custom","fabric"]},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}}}}}
```

## The RoleRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationships","description":"Relationships of a role: the owning `tenant`, and optionally the `author` who created it, with their display name and tenant in `meta`.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"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}}}},"required":["tenant"],"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},"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}}}}
```

## The RoleFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleFindManyResponse","description":"All roles in a tenant. Each item in `data` is a full role with its name, description, `dataSource`, timestamps, and tenant and author relationships. Each item's `meta.tenantId` names the owning tenant.","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":["userRoles"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/UserRoleAttributes"}]},"relationships":{"$ref":"#/components/schemas/RoleRelationships"},"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"}}},"UserRoleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRoleAttributes","description":"Attributes of a role.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name, such as `Admin` or `Editor`."},"description":{"type":"string","description":"What the role is for."},"dataSource":{"type":"string","description":"Who owns the role.\n- `fabric`: a system role Fabric provisions. You can't delete it.\n- `custom`: a role the tenant created.","enum":["custom","fabric"]},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RoleRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationships","description":"Relationships of a role: the owning `tenant`, and optionally the `author` who created it, with their display name and tenant in `meta`.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"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}}}},"required":["tenant"],"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},"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}}}}
```

## The EffectiveConditions object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EffectiveConditions":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveConditions","description":"Conditions that scope a policy-granted action, matching the policy template's conditions. Present only on grants with `source: policy`.","type":"object","additionalProperties":false,"properties":{"workTypes":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"lifecyclePhases":{"type":"array","items":{"type":"string"}},"lifecycleStatuses":{"type":"object","description":"Allowed lifecycle status ids, keyed by work type (the template's `workTypeLifecycleAccess`). Status ids are unique only within a work type.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string"}},"updateTypes":{"type":"array","items":{"type":"string"}},"recordHistoryAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder read the audit history of the records it scopes."},"recordMoveAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder move the records it scopes under another parent."},"securityTagId":{"type":"string"},"dataGroups":{"type":"object","description":"Allowed entity collections, keyed by work type (the template's `workTypeEntityAccess`).","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}}}}}}}}}
```

## The EffectiveActionGrant object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EffectiveActionGrant":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveActionGrant","description":"One allowed action on a resource, with where the grant comes from.","type":"object","additionalProperties":false,"required":["verb","source"],"properties":{"verb":{"type":"string","enum":["Create","Read","Update","Delete","Write"],"description":"The allowed action."},"source":{"type":"string","enum":["baseline","policy"],"description":"Where the grant comes from.\n- `baseline`: the role itself, through its system policies.\n- `policy`: a custom policy assigned to the role."},"policyId":{"type":"string"},"templateId":{"type":"string"},"templateLabel":{"type":"string"},"conditions":{"$ref":"#/components/schemas/EffectiveConditions"}}},"EffectiveConditions":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveConditions","description":"Conditions that scope a policy-granted action, matching the policy template's conditions. Present only on grants with `source: policy`.","type":"object","additionalProperties":false,"properties":{"workTypes":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"lifecyclePhases":{"type":"array","items":{"type":"string"}},"lifecycleStatuses":{"type":"object","description":"Allowed lifecycle status ids, keyed by work type (the template's `workTypeLifecycleAccess`). Status ids are unique only within a work type.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string"}},"updateTypes":{"type":"array","items":{"type":"string"}},"recordHistoryAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder read the audit history of the records it scopes."},"recordMoveAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder move the records it scopes under another parent."},"securityTagId":{"type":"string"},"dataGroups":{"type":"object","description":"Allowed entity collections, keyed by work type (the template's `workTypeEntityAccess`).","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}}}}}}}}}
```

## The EffectiveResourceGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EffectiveResourceGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveResourceGroup","description":"All allowed actions on one resource category.","type":"object","additionalProperties":false,"required":["resourceType","grants"],"properties":{"resourceType":{"type":"string","enum":["record","contributor","credits","alternateRunningOrders","media","delivery","dataset","field","recordLayout","recordLifecycle","tenant","user","globalMetadata","bulkActions","workingSet"]},"grants":{"type":"array","items":{"$ref":"#/components/schemas/EffectiveActionGrant"}}}},"EffectiveActionGrant":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveActionGrant","description":"One allowed action on a resource, with where the grant comes from.","type":"object","additionalProperties":false,"required":["verb","source"],"properties":{"verb":{"type":"string","enum":["Create","Read","Update","Delete","Write"],"description":"The allowed action."},"source":{"type":"string","enum":["baseline","policy"],"description":"Where the grant comes from.\n- `baseline`: the role itself, through its system policies.\n- `policy`: a custom policy assigned to the role."},"policyId":{"type":"string"},"templateId":{"type":"string"},"templateLabel":{"type":"string"},"conditions":{"$ref":"#/components/schemas/EffectiveConditions"}}},"EffectiveConditions":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveConditions","description":"Conditions that scope a policy-granted action, matching the policy template's conditions. Present only on grants with `source: policy`.","type":"object","additionalProperties":false,"properties":{"workTypes":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"lifecyclePhases":{"type":"array","items":{"type":"string"}},"lifecycleStatuses":{"type":"object","description":"Allowed lifecycle status ids, keyed by work type (the template's `workTypeLifecycleAccess`). Status ids are unique only within a work type.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string"}},"updateTypes":{"type":"array","items":{"type":"string"}},"recordHistoryAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder read the audit history of the records it scopes."},"recordMoveAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder move the records it scopes under another parent."},"securityTagId":{"type":"string"},"dataGroups":{"type":"object","description":"Allowed entity collections, keyed by work type (the template's `workTypeEntityAccess`).","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}}}}}}}}}
```

## The EffectivePermissionsAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EffectivePermissionsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectivePermissionsAttributes","description":"Plain-terms summary of what a role, or the union of a user's roles, can do.","type":"object","additionalProperties":false,"required":["roles","fullAccess","resourceGroups"],"properties":{"roles":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["roleId","isSystemRole"],"properties":{"roleId":{"type":"string"},"roleName":{"type":"string"},"isSystemRole":{"type":"boolean"}}}},"fullAccess":{"type":"boolean","description":"`true` when the role has unrestricted access within `scope`. `resourceGroups` is then empty."},"scope":{"type":"string","enum":["global","tenant"],"description":"How broad the unrestricted access is. Present when `fullAccess` is `true`. `tenant` covers your own tenant."},"baselineScope":{"type":"string","enum":["full","edit","read"],"description":"How broad the system-role baseline alone is, ignoring any custom policy also held. Absent when every role is custom.\n- `full`: an administrator role.\n- `edit`: Editor.\n- `read`: Viewer."},"forbids":{"type":"array","items":{"type":"string"},"description":"Stable keys that name notable restrictions, such as Admin caveats."},"resourceGroups":{"type":"array","items":{"$ref":"#/components/schemas/EffectiveResourceGroup"}}}},"EffectiveResourceGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveResourceGroup","description":"All allowed actions on one resource category.","type":"object","additionalProperties":false,"required":["resourceType","grants"],"properties":{"resourceType":{"type":"string","enum":["record","contributor","credits","alternateRunningOrders","media","delivery","dataset","field","recordLayout","recordLifecycle","tenant","user","globalMetadata","bulkActions","workingSet"]},"grants":{"type":"array","items":{"$ref":"#/components/schemas/EffectiveActionGrant"}}}},"EffectiveActionGrant":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveActionGrant","description":"One allowed action on a resource, with where the grant comes from.","type":"object","additionalProperties":false,"required":["verb","source"],"properties":{"verb":{"type":"string","enum":["Create","Read","Update","Delete","Write"],"description":"The allowed action."},"source":{"type":"string","enum":["baseline","policy"],"description":"Where the grant comes from.\n- `baseline`: the role itself, through its system policies.\n- `policy`: a custom policy assigned to the role."},"policyId":{"type":"string"},"templateId":{"type":"string"},"templateLabel":{"type":"string"},"conditions":{"$ref":"#/components/schemas/EffectiveConditions"}}},"EffectiveConditions":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveConditions","description":"Conditions that scope a policy-granted action, matching the policy template's conditions. Present only on grants with `source: policy`.","type":"object","additionalProperties":false,"properties":{"workTypes":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"lifecyclePhases":{"type":"array","items":{"type":"string"}},"lifecycleStatuses":{"type":"object","description":"Allowed lifecycle status ids, keyed by work type (the template's `workTypeLifecycleAccess`). Status ids are unique only within a work type.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string"}},"updateTypes":{"type":"array","items":{"type":"string"}},"recordHistoryAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder read the audit history of the records it scopes."},"recordMoveAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder move the records it scopes under another parent."},"securityTagId":{"type":"string"},"dataGroups":{"type":"object","description":"Allowed entity collections, keyed by work type (the template's `workTypeEntityAccess`).","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}}}}}}}}}
```

## The EffectivePermissionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"EffectivePermissionsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectivePermissionsResponse","description":"Effective permissions for a user (the union of their roles, from `/users/{userId}/permissions`) or for one role (from `/roles/{roleId}/permissions`). Both endpoints return this shape.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["effectivePermissions"]},"attributes":{"$ref":"#/components/schemas/EffectivePermissionsAttributes"},"meta":{"type":"object","additionalProperties":false,"required":["tenantId"],"properties":{"tenantId":{"type":"string"}}}}},"links":{"type":"object","additionalProperties":false,"required":["self"],"properties":{"self":{"type":"string"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"EffectivePermissionsAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectivePermissionsAttributes","description":"Plain-terms summary of what a role, or the union of a user's roles, can do.","type":"object","additionalProperties":false,"required":["roles","fullAccess","resourceGroups"],"properties":{"roles":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["roleId","isSystemRole"],"properties":{"roleId":{"type":"string"},"roleName":{"type":"string"},"isSystemRole":{"type":"boolean"}}}},"fullAccess":{"type":"boolean","description":"`true` when the role has unrestricted access within `scope`. `resourceGroups` is then empty."},"scope":{"type":"string","enum":["global","tenant"],"description":"How broad the unrestricted access is. Present when `fullAccess` is `true`. `tenant` covers your own tenant."},"baselineScope":{"type":"string","enum":["full","edit","read"],"description":"How broad the system-role baseline alone is, ignoring any custom policy also held. Absent when every role is custom.\n- `full`: an administrator role.\n- `edit`: Editor.\n- `read`: Viewer."},"forbids":{"type":"array","items":{"type":"string"},"description":"Stable keys that name notable restrictions, such as Admin caveats."},"resourceGroups":{"type":"array","items":{"$ref":"#/components/schemas/EffectiveResourceGroup"}}}},"EffectiveResourceGroup":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveResourceGroup","description":"All allowed actions on one resource category.","type":"object","additionalProperties":false,"required":["resourceType","grants"],"properties":{"resourceType":{"type":"string","enum":["record","contributor","credits","alternateRunningOrders","media","delivery","dataset","field","recordLayout","recordLifecycle","tenant","user","globalMetadata","bulkActions","workingSet"]},"grants":{"type":"array","items":{"$ref":"#/components/schemas/EffectiveActionGrant"}}}},"EffectiveActionGrant":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveActionGrant","description":"One allowed action on a resource, with where the grant comes from.","type":"object","additionalProperties":false,"required":["verb","source"],"properties":{"verb":{"type":"string","enum":["Create","Read","Update","Delete","Write"],"description":"The allowed action."},"source":{"type":"string","enum":["baseline","policy"],"description":"Where the grant comes from.\n- `baseline`: the role itself, through its system policies.\n- `policy`: a custom policy assigned to the role."},"policyId":{"type":"string"},"templateId":{"type":"string"},"templateLabel":{"type":"string"},"conditions":{"$ref":"#/components/schemas/EffectiveConditions"}}},"EffectiveConditions":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IEffectiveConditions","description":"Conditions that scope a policy-granted action, matching the policy template's conditions. Present only on grants with `source: policy`.","type":"object","additionalProperties":false,"properties":{"workTypes":{"type":"array","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"lifecyclePhases":{"type":"array","items":{"type":"string"}},"lifecycleStatuses":{"type":"object","description":"Allowed lifecycle status ids, keyed by work type (the template's `workTypeLifecycleAccess`). Status ids are unique only within a work type.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string"}},"updateTypes":{"type":"array","items":{"type":"string"}},"recordHistoryAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder read the audit history of the records it scopes."},"recordMoveAccess":{"type":"boolean","description":"Present and `true` when the granting template also lets the holder move the records it scopes under another parent."},"securityTagId":{"type":"string"},"dataGroups":{"type":"object","description":"Allowed entity collections, keyed by work type (the template's `workTypeEntityAccess`).","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The CreateRoleRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"CreateRoleRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleCreateRequest","description":"Creates a custom role in a tenant.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseCreateRequest"},{"additionalProperties":false,"properties":{"attributes":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The role name. Must be unique in the tenant."},"description":{"type":"string","description":"What the role is for."}}}},"required":["attributes"]}]}},"required":["data"],"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"]}}}}
```

## The RoleFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleFindOneResponse","description":"A single role.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/UserRoleAttributes"}]},"relationships":{"$ref":"#/components/schemas/RoleRelationships"},"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"}}},"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"}}},"UserRoleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRoleAttributes","description":"Attributes of a role.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name, such as `Admin` or `Editor`."},"description":{"type":"string","description":"What the role is for."},"dataSource":{"type":"string","description":"Who owns the role.\n- `fabric`: a system role Fabric provisions. You can't delete it.\n- `custom`: a role the tenant created.","enum":["custom","fabric"]},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RoleRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationships","description":"Relationships of a role: the owning `tenant`, and optionally the `author` who created it, with their display name and tenant in `meta`.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"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}}}},"required":["tenant"],"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},"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}}}}
```

## The RoleUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleUpdateOneRequest","description":"Updates a role's description. You can't rename a role. Set `data.type` to `userRoles` and `data.id` to the role in the URL.","type":"object","properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"additionalProperties":false,"properties":{"attributes":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"What the role is for."}}}},"required":["attributes"]}]}},"required":["data"],"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}}}}
```

## The RoleUpdateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"RoleUpdateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleUpdateOneResponse","description":"The updated role.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes","relationships","meta"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["userRoles"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/UserRoleAttributes"}]},"relationships":{"$ref":"#/components/schemas/RoleRelationships"},"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"}}},"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"}}},"UserRoleAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRoleAttributes","description":"Attributes of a role.","type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Display name, such as `Admin` or `Editor`."},"description":{"type":"string","description":"What the role is for."},"dataSource":{"type":"string","description":"Who owns the role.\n- `fabric`: a system role Fabric provisions. You can't delete it.\n- `custom`: a role the tenant created.","enum":["custom","fabric"]},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"RoleRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IRoleRelationships","description":"Relationships of a role: the owning `tenant`, and optionally the `author` who created it, with their display name and tenant in `meta`.","type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"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}}}},"required":["tenant"],"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},"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}}}}
```

## The UtilizationAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UtilizationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationAttributes","description":"Your tenant's current usage","type":"object","additionalProperties":false,"required":["userCount","recordCount","apiCallCount","deliveryRecordCount","mediaStorageBytes","currentMonthKey","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"currentMonthKey":{"type":"string","description":"Current month key in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"userCount":{"type":"integer","description":"Current number of users"},"recordCount":{"type":"integer","description":"Current number of records"},"apiCallCount":{"type":"integer","description":"Current number of API calls this month"},"deliveryRecordCount":{"type":"integer","description":"Current number of delivery records"},"mediaStorageBytes":{"type":"integer","description":"Current media storage usage in bytes"},"peakUserCount":{"type":"integer","description":"Peak user count for the current month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the current month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the current month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the current month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the current month"},"lastReconciledAt":{"type":"string","format":"date-time","description":"When utilization was last reconciled"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}}}}}
```

## The UtilizationFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UtilizationFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationFindOneResponse","description":"Your tenant's current utilization","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Utilization ID"},"type":{"type":"string","enum":["utilization"]},"attributes":{"$ref":"#/components/schemas/UtilizationAttributes"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationAttributes","description":"Your tenant's current usage","type":"object","additionalProperties":false,"required":["userCount","recordCount","apiCallCount","deliveryRecordCount","mediaStorageBytes","currentMonthKey","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"currentMonthKey":{"type":"string","description":"Current month key in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"userCount":{"type":"integer","description":"Current number of users"},"recordCount":{"type":"integer","description":"Current number of records"},"apiCallCount":{"type":"integer","description":"Current number of API calls this month"},"deliveryRecordCount":{"type":"integer","description":"Current number of delivery records"},"mediaStorageBytes":{"type":"integer","description":"Current media storage usage in bytes"},"peakUserCount":{"type":"integer","description":"Peak user count for the current month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the current month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the current month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the current month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the current month"},"lastReconciledAt":{"type":"string","format":"date-time","description":"When utilization was last reconciled"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UtilizationSnapshotAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Usage for one month","type":"object","additionalProperties":false,"required":["tenantId","yearMonth","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"yearMonth":{"type":"string","description":"Month in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"plan":{"type":"string","description":"Plan name at the time of the snapshot"},"peakUserCount":{"type":"integer","description":"Peak user count for the month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the month"},"endOfMonthUserCount":{"type":"integer","description":"User count at the end of the month"},"endOfMonthRecordCount":{"type":"integer","description":"Record count at the end of the month"},"endOfMonthDeliveryRecordCount":{"type":"integer","description":"Delivery record count at the end of the month"},"endOfMonthMediaStorageBytes":{"type":"integer","description":"Media storage bytes at the end of the month"},"created":{"type":"string","format":"date-time","description":"When the snapshot was taken"}}}}}}
```

## The UtilizationSnapshotFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UtilizationSnapshotFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotFindManyResponse","description":"A page of utilization snapshots","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","links"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Snapshot ID"},"type":{"type":"string","enum":["utilizationSnapshots"]},"attributes":{"$ref":"#/components/schemas/UtilizationSnapshotAttributes"},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this snapshot"}}}}}},"meta":{"type":"object","required":["total"],"additionalProperties":false,"properties":{"total":{"type":"integer","description":"Total number of snapshots available"}}},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this resource"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Usage for one month","type":"object","additionalProperties":false,"required":["tenantId","yearMonth","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"yearMonth":{"type":"string","description":"Month in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"plan":{"type":"string","description":"Plan name at the time of the snapshot"},"peakUserCount":{"type":"integer","description":"Peak user count for the month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the month"},"endOfMonthUserCount":{"type":"integer","description":"User count at the end of the month"},"endOfMonthRecordCount":{"type":"integer","description":"Record count at the end of the month"},"endOfMonthDeliveryRecordCount":{"type":"integer","description":"Delivery record count at the end of the month"},"endOfMonthMediaStorageBytes":{"type":"integer","description":"Media storage bytes at the end of the month"},"created":{"type":"string","format":"date-time","description":"When the snapshot was taken"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The UtilizationSnapshotFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"UtilizationSnapshotFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotFindOneResponse","description":"A single utilization snapshot","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Snapshot ID"},"type":{"type":"string","enum":["utilizationSnapshots"]},"attributes":{"$ref":"#/components/schemas/UtilizationSnapshotAttributes"}}},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this snapshot"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Usage for one month","type":"object","additionalProperties":false,"required":["tenantId","yearMonth","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"yearMonth":{"type":"string","description":"Month in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"plan":{"type":"string","description":"Plan name at the time of the snapshot"},"peakUserCount":{"type":"integer","description":"Peak user count for the month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the month"},"endOfMonthUserCount":{"type":"integer","description":"User count at the end of the month"},"endOfMonthRecordCount":{"type":"integer","description":"Record count at the end of the month"},"endOfMonthDeliveryRecordCount":{"type":"integer","description":"Delivery record count at the end of the month"},"endOfMonthMediaStorageBytes":{"type":"integer","description":"Media storage bytes at the end of the month"},"created":{"type":"string","format":"date-time","description":"When the snapshot was taken"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkTypeAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAttributes","description":"Attributes of a work type. You can't change built-in work types (`dataSource: fabric`). On a custom type, only `label` and `domain` can change after create; the key, `structure` and the behavioural flags stay fixed.","type":"object","additionalProperties":false,"required":["label","dataSource","status","structure","domain","requiresParent","requiresSequenceNumber","maxDepth"],"properties":{"label":{"type":"string","description":"The name shown to users. Unique within the tenant, ignoring case."},"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in work type, `custom` for one the tenant defined."},"status":{"type":"string","enum":["PROVISIONING","ACTIVE","DELETING"],"description":"Only an `ACTIVE` work type accepts new records. `PROVISIONING` and `DELETING` mean a save is still setting the type up or removing it; the next save finishes it."},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"`HIERARCHICAL` types sit in the parent/child hierarchy. A `COLLECTION` holds members by linking existing records instead, so it never has a parent and is never one."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain the type belongs to, or `null` for none."},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record. `false` means it can also exist at the top level."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type."},"maxDepth":{"type":"integer","description":"The deepest level a record of this type may sit at, counting itself and every ancestor."}}}}}}
```

## The validParentIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}}}
```

## The validParentsRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}}}
```

## The policiesRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}}}}}
```

## The WorkType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkType","description":"A work type: the classification of a record, built-in or defined by the tenant. Its `id` is the work type key carried by every record's `workType`. The `validParents` relationship is the hierarchy itself: the work types a record of this type may sit under.","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","description":"The work type key, for example `Movie` or `Podcast`. Immutable."},"attributes":{"$ref":"#/components/schemas/WorkTypeAttributes"},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"$ref":"#/components/schemas/validParentsRelationship"},"policies":{"$ref":"#/components/schemas/policiesRelationship"}}}},"definitions":{"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}},"WorkTypeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAttributes","description":"Attributes of a work type. You can't change built-in work types (`dataSource: fabric`). On a custom type, only `label` and `domain` can change after create; the key, `structure` and the behavioural flags stay fixed.","type":"object","additionalProperties":false,"required":["label","dataSource","status","structure","domain","requiresParent","requiresSequenceNumber","maxDepth"],"properties":{"label":{"type":"string","description":"The name shown to users. Unique within the tenant, ignoring case."},"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in work type, `custom` for one the tenant defined."},"status":{"type":"string","enum":["PROVISIONING","ACTIVE","DELETING"],"description":"Only an `ACTIVE` work type accepts new records. `PROVISIONING` and `DELETING` mean a save is still setting the type up or removing it; the next save finishes it."},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"`HIERARCHICAL` types sit in the parent/child hierarchy. A `COLLECTION` holds members by linking existing records instead, so it never has a parent and is never one."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain the type belongs to, or `null` for none."},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record. `false` means it can also exist at the top level."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type."},"maxDepth":{"type":"integer","description":"The deepest level a record of this type may sit at, counting itself and every ancestor."}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}},"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}}}}}
```

## The WorkTypeGraphMeta object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeGraphMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeGraphMeta","description":"The version of the tenant's work types this response reflects. Send it back as `meta.graphVersion` on a save to have the save refused if the work types changed in the meantime.","type":"object","additionalProperties":false,"required":["graphVersion"],"properties":{"graphVersion":{"type":"integer","minimum":0}}}}}}
```

## The WorkTypeFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeFindManyResponse","description":"Every work type of the tenant, built-in and custom. With `include=validParents`, `included` carries parent work types outside the primary data.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkType"}},"included":{"type":"array","items":{"$ref":"#/components/schemas/WorkType"}},"meta":{"$ref":"#/components/schemas/WorkTypeGraphMeta"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkType","description":"A work type: the classification of a record, built-in or defined by the tenant. Its `id` is the work type key carried by every record's `workType`. The `validParents` relationship is the hierarchy itself: the work types a record of this type may sit under.","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","description":"The work type key, for example `Movie` or `Podcast`. Immutable."},"attributes":{"$ref":"#/components/schemas/WorkTypeAttributes"},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"$ref":"#/components/schemas/validParentsRelationship"},"policies":{"$ref":"#/components/schemas/policiesRelationship"}}}},"definitions":{"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}},"WorkTypeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAttributes","description":"Attributes of a work type. You can't change built-in work types (`dataSource: fabric`). On a custom type, only `label` and `domain` can change after create; the key, `structure` and the behavioural flags stay fixed.","type":"object","additionalProperties":false,"required":["label","dataSource","status","structure","domain","requiresParent","requiresSequenceNumber","maxDepth"],"properties":{"label":{"type":"string","description":"The name shown to users. Unique within the tenant, ignoring case."},"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in work type, `custom` for one the tenant defined."},"status":{"type":"string","enum":["PROVISIONING","ACTIVE","DELETING"],"description":"Only an `ACTIVE` work type accepts new records. `PROVISIONING` and `DELETING` mean a save is still setting the type up or removing it; the next save finishes it."},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"`HIERARCHICAL` types sit in the parent/child hierarchy. A `COLLECTION` holds members by linking existing records instead, so it never has a parent and is never one."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain the type belongs to, or `null` for none."},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record. `false` means it can also exist at the top level."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type."},"maxDepth":{"type":"integer","description":"The deepest level a record of this type may sit at, counting itself and every ancestor."}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}},"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"WorkTypeGraphMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeGraphMeta","description":"The version of the tenant's work types this response reflects. Send it back as `meta.graphVersion` on a save to have the save refused if the work types changed in the meantime.","type":"object","additionalProperties":false,"required":["graphVersion"],"properties":{"graphVersion":{"type":"integer","minimum":0}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The label object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"label":{"type":"string","minLength":1,"maxLength":100,"description":"The name shown to users. Unique within the tenant ignoring case, built-in labels included."}}}}
```

## The domain object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain, or `null` for none."}}}}
```

## The workTypeIdentifier object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"workTypeIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}}}}}
```

## The workTypeCreateData object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"workTypeCreateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$","description":"The new work type's key: PascalCase letters and digits, 2 to 40 characters, unique within the tenant ignoring case. Immutable."},"attributes":{"type":"object","additionalProperties":false,"required":["label","requiresParent"],"properties":{"label":{"$ref":"#/components/schemas/label"},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"Defaults to `HIERARCHICAL`. A `COLLECTION` holds member records instead of children: it takes no `validParents`, `requiresParent` or `requiresSequenceNumber`, and is never a parent."},"domain":{"$ref":"#/components/schemas/domain"},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type. Defaults to `false`."},"maxDepth":{"type":"integer","minimum":1,"description":"The deepest level a record of this type may sit at, counting itself and every ancestor. Defaults to, and cannot exceed, 10."}}},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}}}}}}}},"label":{"type":"string","minLength":1,"maxLength":100,"description":"The name shown to users. Unique within the tenant ignoring case, built-in labels included."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain, or `null` for none."},"workTypeIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}}}}}
```

## The workTypeRef object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"workTypeRef":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}}}}}
```

## The workTypeUpdateData object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"workTypeUpdateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"label":{"$ref":"#/components/schemas/label"},"domain":{"$ref":"#/components/schemas/domain"}}}}},"label":{"type":"string","minLength":1,"maxLength":100,"description":"The name shown to users. Unique within the tenant ignoring case, built-in labels included."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain, or `null` for none."}}}}
```

## The validParentsRef object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"validParentsRef":{"type":"object","additionalProperties":false,"required":["type","id","relationship"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"relationship":{"type":"string","const":"validParents"}}}}}}
```

## The workTypeIdentifiers object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"workTypeIdentifiers":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}},"workTypeIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}}}}}
```

## The WorkTypeAtomicOperationsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeAtomicOperationsRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAtomicOperationsRequest","description":"Saves any set of changes to the tenant's work types in one JSON:API Atomic Operations request.\n- `add` with `data`: create a custom type.\n- `update`: change its `label` or `domain`.\n- `remove`: delete it.\n- `add` or `remove` with `ref.relationship`: add or remove entries of a type's `validParents`.\n\nValidates only the resulting work types and accepts or refuses the whole save. You can't change built-in work types or their built-in relationships. An empty `atomic:operations` array only finishes setting up or removing types an earlier save left unfinished.","type":"object","additionalProperties":false,"required":["atomic:operations"],"properties":{"meta":{"type":"object","additionalProperties":false,"properties":{"graphVersion":{"type":"integer","minimum":0,"description":"The `meta.graphVersion` the client last read. When sent, the save fails with 409 if the work types changed since; when omitted, the save applies to the latest work types."},"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"atomic:operations":{"type":"array","maxItems":100,"items":{"type":"object","oneOf":[{"type":"object","description":"Create a custom work type.","additionalProperties":false,"required":["op","data"],"properties":{"op":{"type":"string","const":"add"},"data":{"$ref":"#/components/schemas/workTypeCreateData"}}},{"type":"object","description":"Change a custom work type's `label` or `domain`.","additionalProperties":false,"required":["op","ref","data"],"properties":{"op":{"type":"string","const":"update"},"ref":{"$ref":"#/components/schemas/workTypeRef"},"data":{"$ref":"#/components/schemas/workTypeUpdateData"}}},{"type":"object","description":"Delete a custom work type. Refused while any record of the type exists (including records in the trash), while a policy lists it, or while another work type still lists it as a valid parent after the save.","additionalProperties":false,"required":["op","ref"],"properties":{"op":{"type":"string","const":"remove"},"ref":{"$ref":"#/components/schemas/workTypeRef"}}},{"type":"object","description":"Add work types to a type's `validParents`. At least one end of each new relationship must be a custom type.","additionalProperties":false,"required":["op","ref","data"],"properties":{"op":{"type":"string","const":"add"},"ref":{"$ref":"#/components/schemas/validParentsRef"},"data":{"$ref":"#/components/schemas/workTypeIdentifiers"}}},{"type":"object","description":"Remove work types from a type's `validParents`. You can't remove built-in relationships. Existing records keep their parent.","additionalProperties":false,"required":["op","ref","data"],"properties":{"op":{"type":"string","const":"remove"},"ref":{"$ref":"#/components/schemas/validParentsRef"},"data":{"$ref":"#/components/schemas/workTypeIdentifiers"}}}]}}},"definitions":{"workTypeCreateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$","description":"The new work type's key: PascalCase letters and digits, 2 to 40 characters, unique within the tenant ignoring case. Immutable."},"attributes":{"type":"object","additionalProperties":false,"required":["label","requiresParent"],"properties":{"label":{"$ref":"#/components/schemas/label"},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"Defaults to `HIERARCHICAL`. A `COLLECTION` holds member records instead of children: it takes no `validParents`, `requiresParent` or `requiresSequenceNumber`, and is never a parent."},"domain":{"$ref":"#/components/schemas/domain"},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type. Defaults to `false`."},"maxDepth":{"type":"integer","minimum":1,"description":"The deepest level a record of this type may sit at, counting itself and every ancestor. Defaults to, and cannot exceed, 10."}}},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}}}}}}}},"workTypeUpdateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"label":{"$ref":"#/components/schemas/label"},"domain":{"$ref":"#/components/schemas/domain"}}}}},"workTypeRef":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}},"validParentsRef":{"type":"object","additionalProperties":false,"required":["type","id","relationship"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"relationship":{"type":"string","const":"validParents"}}},"workTypeIdentifiers":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}},"workTypeIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}},"label":{"type":"string","minLength":1,"maxLength":100,"description":"The name shown to users. Unique within the tenant ignoring case, built-in labels included."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain, or `null` for none."}}},"workTypeCreateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","pattern":"^[A-Z][A-Za-z0-9]{1,39}$","description":"The new work type's key: PascalCase letters and digits, 2 to 40 characters, unique within the tenant ignoring case. Immutable."},"attributes":{"type":"object","additionalProperties":false,"required":["label","requiresParent"],"properties":{"label":{"$ref":"#/components/schemas/label"},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"Defaults to `HIERARCHICAL`. A `COLLECTION` holds member records instead of children: it takes no `validParents`, `requiresParent` or `requiresSequenceNumber`, and is never a parent."},"domain":{"$ref":"#/components/schemas/domain"},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type. Defaults to `false`."},"maxDepth":{"type":"integer","minimum":1,"description":"The deepest level a record of this type may sit at, counting itself and every ancestor. Defaults to, and cannot exceed, 10."}}},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}}}}}}}},"label":{"type":"string","minLength":1,"maxLength":100,"description":"The name shown to users. Unique within the tenant ignoring case, built-in labels included."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain, or `null` for none."},"workTypeIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}},"workTypeRef":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"}}},"workTypeUpdateData":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"label":{"$ref":"#/components/schemas/label"},"domain":{"$ref":"#/components/schemas/domain"}}}}},"validParentsRef":{"type":"object","additionalProperties":false,"required":["type","id","relationship"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"relationship":{"type":"string","const":"validParents"}}},"workTypeIdentifiers":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/workTypeIdentifier"}}}}}
```

## The WorkTypeAtomicOperationsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeAtomicOperationsResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAtomicOperationsResponse","description":"The result of a save: one entry per operation, in request order. Creating or updating a type returns it as `data`; relationship changes and deletes return an empty result.","type":"object","additionalProperties":false,"required":["atomic:results","meta","jsonapi"],"properties":{"atomic:results":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/WorkType"}}}},"meta":{"type":"object","additionalProperties":false,"required":["graphVersion"],"properties":{"graphVersion":{"type":"integer","minimum":0,"description":"The version of the work types after the save. Send it back on the next save."},"notDeleted":{"type":"array","items":{"type":"string"},"description":"Keys of work types this save meant to delete that gained a record while it ran. They stay `ACTIVE`; every other change in the save applied."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkType","description":"A work type: the classification of a record, built-in or defined by the tenant. Its `id` is the work type key carried by every record's `workType`. The `validParents` relationship is the hierarchy itself: the work types a record of this type may sit under.","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","description":"The work type key, for example `Movie` or `Podcast`. Immutable."},"attributes":{"$ref":"#/components/schemas/WorkTypeAttributes"},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"$ref":"#/components/schemas/validParentsRelationship"},"policies":{"$ref":"#/components/schemas/policiesRelationship"}}}},"definitions":{"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}},"WorkTypeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAttributes","description":"Attributes of a work type. You can't change built-in work types (`dataSource: fabric`). On a custom type, only `label` and `domain` can change after create; the key, `structure` and the behavioural flags stay fixed.","type":"object","additionalProperties":false,"required":["label","dataSource","status","structure","domain","requiresParent","requiresSequenceNumber","maxDepth"],"properties":{"label":{"type":"string","description":"The name shown to users. Unique within the tenant, ignoring case."},"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in work type, `custom` for one the tenant defined."},"status":{"type":"string","enum":["PROVISIONING","ACTIVE","DELETING"],"description":"Only an `ACTIVE` work type accepts new records. `PROVISIONING` and `DELETING` mean a save is still setting the type up or removing it; the next save finishes it."},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"`HIERARCHICAL` types sit in the parent/child hierarchy. A `COLLECTION` holds members by linking existing records instead, so it never has a parent and is never one."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain the type belongs to, or `null` for none."},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record. `false` means it can also exist at the top level."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type."},"maxDepth":{"type":"integer","description":"The deepest level a record of this type may sit at, counting itself and every ancestor."}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}},"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkTypeProvisionResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeProvisionResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeProvisionResponse","description":"What provisioning did to the tenant's built-in work types. Provisioning never changes custom work types or the relationships a tenant added.","type":"object","additionalProperties":false,"required":["meta","jsonapi"],"properties":{"meta":{"type":"object","additionalProperties":false,"required":["tenantId","documentCreated","seeded","repaired","skipped"],"properties":{"tenantId":{"type":"string"},"documentCreated":{"type":"boolean","description":"The tenant had no work types yet, so provisioning added every built-in work type."},"seeded":{"type":"array","items":{"type":"string"},"description":"Missing built-in work types that provisioning added."},"repaired":{"type":"array","items":{"type":"string"},"description":"Built-in work types that differed from their definition, which provisioning restored."},"skipped":{"type":"array","items":{"type":"string"},"description":"Built-in work types left unchanged: already correct, or a custom work type holds their key. Provisioning never changes custom work types."}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The items object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"items":{"title":"IPolicyTemplate","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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}}}}
```

## The WorkTypeFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeFindOneResponse","description":"One work type. With `include=validParents`, `included` carries its parent work types; with `include=policies`, the policies of its `policies` relationship.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/WorkType"},"included":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/WorkType"},{"$ref":"#/components/schemas/items"}]}},"meta":{"$ref":"#/components/schemas/WorkTypeGraphMeta"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkType","description":"A work type: the classification of a record, built-in or defined by the tenant. Its `id` is the work type key carried by every record's `workType`. The `validParents` relationship is the hierarchy itself: the work types a record of this type may sit under.","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string","description":"The work type key, for example `Movie` or `Podcast`. Immutable."},"attributes":{"$ref":"#/components/schemas/WorkTypeAttributes"},"relationships":{"type":"object","additionalProperties":false,"required":["validParents"],"properties":{"validParents":{"$ref":"#/components/schemas/validParentsRelationship"},"policies":{"$ref":"#/components/schemas/policiesRelationship"}}}},"definitions":{"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}}}},"WorkTypeAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeAttributes","description":"Attributes of a work type. You can't change built-in work types (`dataSource: fabric`). On a custom type, only `label` and `domain` can change after create; the key, `structure` and the behavioural flags stay fixed.","type":"object","additionalProperties":false,"required":["label","dataSource","status","structure","domain","requiresParent","requiresSequenceNumber","maxDepth"],"properties":{"label":{"type":"string","description":"The name shown to users. Unique within the tenant, ignoring case."},"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in work type, `custom` for one the tenant defined."},"status":{"type":"string","enum":["PROVISIONING","ACTIVE","DELETING"],"description":"Only an `ACTIVE` work type accepts new records. `PROVISIONING` and `DELETING` mean a save is still setting the type up or removing it; the next save finishes it."},"structure":{"type":"string","enum":["HIERARCHICAL","COLLECTION"],"description":"`HIERARCHICAL` types sit in the parent/child hierarchy. A `COLLECTION` holds members by linking existing records instead, so it never has a parent and is never one."},"domain":{"type":["string","null"],"enum":["ENTERTAINMENT","SPORTS","NEWS",null],"description":"The content domain the type belongs to, or `null` for none."},"requiresParent":{"type":"boolean","description":"Whether every record of this type must sit under a parent record. `false` means it can also exist at the top level."},"requiresSequenceNumber":{"type":"boolean","description":"Whether records of this type get a sequence number among their siblings of the same type."},"maxDepth":{"type":"integer","description":"The deepest level a record of this type may sit at, counting itself and every ancestor."}}},"validParentsRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}},"policiesRelationship":{"type":"object","description":"Present with `include=policies`: every policy that lists work types, so an admin can see which policies leave this type out. Leaves out policies that list no work types: those apply to every type.","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"policyTemplates"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["covers"],"properties":{"covers":{"type":"boolean","description":"Whether the policy lists this work type. `false` means the roles it applies to get nothing from it for records of this type."}}}}}}}},"items":{"title":"IPolicyTemplate","type":"object","required":["id","type","attributes","relationships"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["policyTemplates"]},"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/PolicyTemplateAttributes"}]},"relationships":{"$ref":"#/components/schemas/PolicyTemplateRelationships"},"meta":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID"}},"required":["tenantId"],"additionalProperties":false}}},"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"}}},"PolicyTemplateAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IPolicyTemplateAttributes","description":"A policy template's attributes.","additionalProperties":false,"required":["resourceType","name","label","actions"],"type":"object","properties":{"resourceType":{"type":"string","enum":["record","contributor","delivery","bulkActions","workingSet"],"description":"The resource type this template targets"},"name":{"type":"string","description":"The template's name. You can't change it after creation."},"label":{"type":"string","description":"The display label for the policy template"},"description":{"type":"string","description":"The description of the policy template"},"actions":{"type":"array","description":"The actions the template allows.","items":{"type":"string"}},"locales":{"type":"array","items":{"type":"string"}},"workTypeEntityAccess":{"type":"object","additionalProperties":{"type":"object","properties":{"creditsAccess":{"type":"boolean"},"mediaAccess":{"type":"array","items":{"type":"string"}},"externalDataAccess":{"type":"boolean"},"alternateRunningOrdersAccess":{"type":"boolean"}},"additionalProperties":false}},"workTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkTypes"}},"lifecyclePhases":{"type":"array","items":{"type":"string","enum":["drafting","published"]}},"workTypeLifecycleAccess":{"type":"object","description":"Lifecycle status access, keyed by work type. Requires the `statusBasedPermissions` entitlement. When set, the policy is status-based and the server derives `lifecyclePhases` from these statuses.","additionalProperties":{"type":"array","items":{"type":"string"}}},"sectionIds":{"type":"array","items":{"type":"string"}},"createSources":{"type":"array","items":{"type":"string","enum":["custom","origin"]}},"updateTypes":{"type":"array","items":{"type":"string","enum":["regular","publish"]}},"recordHistoryAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also view the change history of the records it covers, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Read access alone never grants history access; only this flag does."},"recordMoveAccess":{"type":"boolean","description":"`record` templates only. When true, holders of the policy can also move the records it covers, with everything below them, under another parent, within the same work types, lifecycle and security tags as the rest of the policy. Absent means false. Update access alone never grants move access; in a custom policy, only this flag does."}}},"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}$"},"PolicyTemplateRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"IPolicyTemplateRelationships","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"}},"required":["tenant"],"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},"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},"WorkTypeGraphMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeGraphMeta","description":"The version of the tenant's work types this response reflects. Send it back as `meta.graphVersion` on a save to have the save refused if the work types changed in the meantime.","type":"object","additionalProperties":false,"required":["graphVersion"],"properties":{"graphVersion":{"type":"integer","minimum":0}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkTypeValidParentsRelationshipResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkTypeValidParentsRelationshipResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeValidParentsRelationshipResponse","description":"The work types a record of this type may sit under, as resource identifiers.","type":"object","additionalProperties":false,"required":["data","meta","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/validParentIdentifier"}},"meta":{"$ref":"#/components/schemas/WorkTypeGraphMeta"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"validParentIdentifier":{"type":"object","additionalProperties":false,"required":["type","id","meta"],"properties":{"type":{"type":"string","const":"workTypes"},"id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"required":["dataSource"],"properties":{"dataSource":{"type":"string","enum":["fabric","custom"],"description":"`fabric` for a built-in relationship, which you can't remove; `custom` for one the tenant added."}}}}},"WorkTypeGraphMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkTypeGraphMeta","description":"The version of the tenant's work types this response reflects. Send it back as `meta.graphVersion` on a save to have the save refused if the work types changed in the meantime.","type":"object","additionalProperties":false,"required":["graphVersion"],"properties":{"graphVersion":{"type":"integer","minimum":0}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetResourceType object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}}}}}
```

## The WorkingSetAttributesInput object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}}}}}
```

## The WorkingSetAttributeStatus object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]}}}}
```

## The WorkingSetAttributes object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]}}}}
```

## The WorkingSetCreatorRelationship object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"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}}}}
```

## The WorkingSetRelationships object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The WorkingSetResource object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResource","description":"A Working Set as a JSON:API resource object.","allOf":[{"$ref":"#/components/schemas/WorkingSetResourceType"},{"type":"object","required":["id","type","attributes","relationships","links"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributes"},"relationships":{"$ref":"#/components/schemas/WorkingSetRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}},"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]},"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false}}}}
```

## The WorkingSetFindManyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetFindManyResponse","description":"A page of Working Sets. Follow `links.next` while it is non-null.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkingSetResource"}},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string"},"next":{"type":["string","null"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"cursor":{"type":"string"},"filters":{"type":"object","additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"}}}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkingSetResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResource","description":"A Working Set as a JSON:API resource object.","allOf":[{"$ref":"#/components/schemas/WorkingSetResourceType"},{"type":"object","required":["id","type","attributes","relationships","links"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributes"},"relationships":{"$ref":"#/components/schemas/WorkingSetRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}},"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]},"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetCreateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetCreateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreateOneRequest","description":"A new Working Set, with up to 99 records to link: the create lands whole or not at all. Add more records with `POST /workingSets/{workingSetId}/relationships/records`, 99 per request, up to 50000 per Working Set.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["workingSets"]},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributesInput"},"relationships":{"type":"object","additionalProperties":false,"properties":{"records":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"},"minItems":1,"maxItems":99}}}}}}}}},"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}}}}},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The WorkingSetCreateOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreateOneResponse","description":"The created Working Set.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/WorkingSetResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkingSetResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResource","description":"A Working Set as a JSON:API resource object.","allOf":[{"$ref":"#/components/schemas/WorkingSetResourceType"},{"type":"object","required":["id","type","attributes","relationships","links"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributes"},"relationships":{"$ref":"#/components/schemas/WorkingSetRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}},"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]},"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The IWorkingSetOperator object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IWorkingSetOperator":{"type":"string","description":"Comparison operator for a condition:\n- `eq`: exact match\n- `ne`: exact exclusion\n- `contains`: substring or token match\n- `not_contains`: negation of `contains`\n- `starts_with`: prefix match\n- `lt`, `lte`, `gt`, `gte`: numeric or date range\n- `exists`: field has any non-null value\n- `not_exists`: field is absent or null","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IWorkingSetCondition object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IWorkingSetCondition":{"type":"object","required":["field","operator"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["id","name","purposeOfWork","orchestrationReference","status","creatorId","creatorName","created","updated"]},"operator":{"$ref":"#/components/schemas/IWorkingSetOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}}},"IWorkingSetOperator":{"type":"string","description":"Comparison operator for a condition:\n- `eq`: exact match\n- `ne`: exact exclusion\n- `contains`: substring or token match\n- `not_contains`: negation of `contains`\n- `starts_with`: prefix match\n- `lt`, `lte`, `gt`, `gte`: numeric or date range\n- `exists`: field has any non-null value\n- `not_exists`: field is absent or null","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The IWorkingSetQueryGroup object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"IWorkingSetQueryGroup":{"type":"object","required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false,"properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IWorkingSetCondition"}},"groups":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IWorkingSetQueryGroup"}}}},"IWorkingSetCondition":{"type":"object","required":["field","operator"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["id","name","purposeOfWork","orchestrationReference","status","creatorId","creatorName","created","updated"]},"operator":{"$ref":"#/components/schemas/IWorkingSetOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}}},"IWorkingSetOperator":{"type":"string","description":"Comparison operator for a condition:\n- `eq`: exact match\n- `ne`: exact exclusion\n- `contains`: substring or token match\n- `not_contains`: negation of `contains`\n- `starts_with`: prefix match\n- `lt`, `lte`, `gt`, `gte`: numeric or date range\n- `exists`: field has any non-null value\n- `not_exists`: field is absent or null","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The WorkingSetSearchRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetSearchRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetSearchRequest","description":"A Working Set search: a tree of condition groups joined by `AND`, `OR` or `NOT`. Each leaf condition compares one indexed Working Set field to a value.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["searchQueries"]},"attributes":{"type":"object","required":["group"],"additionalProperties":false,"properties":{"group":{"$ref":"#/components/schemas/IWorkingSetQueryGroup"}}}}}},"definitions":{"IWorkingSetOperator":{"type":"string","description":"Comparison operator for a condition:\n- `eq`: exact match\n- `ne`: exact exclusion\n- `contains`: substring or token match\n- `not_contains`: negation of `contains`\n- `starts_with`: prefix match\n- `lt`, `lte`, `gt`, `gte`: numeric or date range\n- `exists`: field has any non-null value\n- `not_exists`: field is absent or null","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]},"IWorkingSetCondition":{"type":"object","required":["field","operator"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["id","name","purposeOfWork","orchestrationReference","status","creatorId","creatorName","created","updated"]},"operator":{"$ref":"#/components/schemas/IWorkingSetOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}}},"IWorkingSetQueryGroup":{"type":"object","required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false,"properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IWorkingSetCondition"}},"groups":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IWorkingSetQueryGroup"}}}}}},"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}}}}},"IWorkingSetQueryGroup":{"type":"object","required":["operator"],"anyOf":[{"required":["conditions"]},{"required":["groups"]}],"additionalProperties":false,"properties":{"operator":{"type":"string","enum":["AND","OR","NOT"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IWorkingSetCondition"}},"groups":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IWorkingSetQueryGroup"}}}},"IWorkingSetCondition":{"type":"object","required":["field","operator"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["id","name","purposeOfWork","orchestrationReference","status","creatorId","creatorName","created","updated"]},"operator":{"$ref":"#/components/schemas/IWorkingSetOperator"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}}},"IWorkingSetOperator":{"type":"string","description":"Comparison operator for a condition:\n- `eq`: exact match\n- `ne`: exact exclusion\n- `contains`: substring or token match\n- `not_contains`: negation of `contains`\n- `starts_with`: prefix match\n- `lt`, `lte`, `gt`, `gte`: numeric or date range\n- `exists`: field has any non-null value\n- `not_exists`: field is absent or null","enum":["eq","ne","contains","not_contains","starts_with","lt","lte","gt","gte","exists","not_exists"]}}}}
```

## The WorkingSetSearchResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetSearchResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetSearchResponse","description":"A page of Working Sets from the search index, with pagination and the applied ordering in `meta`.","type":"object","required":["data","meta","jsonapi"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkingSetResource"}},"links":{"type":"object","additionalProperties":false,"properties":{"self":{"type":"string"},"next":{"type":["string","null"]},"prev":{"type":["string","null"]}}},"meta":{"type":"object","required":["total","page","perPage","sort"],"additionalProperties":false,"properties":{"total":{"type":"integer"},"page":{"type":"integer"},"perPage":{"type":"integer"},"sort":{"$ref":"#/components/schemas/SearchSortMeta"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkingSetResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResource","description":"A Working Set as a JSON:API resource object.","allOf":[{"$ref":"#/components/schemas/WorkingSetResourceType"},{"type":"object","required":["id","type","attributes","relationships","links"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributes"},"relationships":{"$ref":"#/components/schemas/WorkingSetRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}},"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]},"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"SearchSortMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ISearchSortMeta","description":"The ordering applied to the search results. Every search response carries it, whether or not the request asked for an ordering.","type":"object","properties":{"applied":{"type":"string","description":"The ordering applied, in the `sort` parameter's comma-separated syntax. Pass it back as `sort` to keep the ordering fixed across later requests."},"default":{"type":"boolean","description":"`true` when the request had no `sort` and the server chose the ordering; `false` when it reflects the `sort` you sent."}},"required":["applied","default"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetFindOneResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetFindOneResponse","description":"A single Working Set.","type":"object","additionalProperties":false,"required":["data","jsonapi"],"properties":{"data":{"$ref":"#/components/schemas/WorkingSetResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"WorkingSetResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResource","description":"A Working Set as a JSON:API resource object.","allOf":[{"$ref":"#/components/schemas/WorkingSetResourceType"},{"type":"object","required":["id","type","attributes","relationships","links"],"additionalProperties":false,"properties":{"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/WorkingSetAttributes"},"relationships":{"$ref":"#/components/schemas/WorkingSetRelationships"},"links":{"$ref":"#/components/schemas/LinksSelf"}}}]},"WorkingSetResourceType":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetResourceType","description":"JSON:API type of Working Set resources: always `\"workingSets\"`.","type":"object","required":["type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["workingSets"]}}},"WorkingSetAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributes","description":"Working Set attributes, plus the system-managed `status`, `recordCount` and timestamps.","allOf":[{"$ref":"#/components/schemas/WorkingSetAttributesInput"},{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","required":["status","recordCount"],"additionalProperties":false,"properties":{"status":{"$ref":"#/components/schemas/WorkingSetAttributeStatus"},"recordCount":{"type":"integer","minimum":0,"description":"Records in the Working Set. Can trail a membership change by a few seconds."}}}]},"WorkingSetAttributesInput":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributesInput","description":"Attributes you set on a Working Set.","type":"object","required":["name","purposeOfWork"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":"string","maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL."}}},"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"}}},"WorkingSetAttributeStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAttributeStatus","description":"Working Set lifecycle status:\n- `OPEN`: accepts membership changes.\n- `CLOSED`: frozen.\n- `DELETING`: a delete is in progress and the Working Set is about to disappear. It refuses every change and doesn't appear under `OPEN` or `CLOSED`.","type":"string","enum":["OPEN","CLOSED","DELETING"]},"WorkingSetRelationships":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRelationships","description":"The Working Set's tenant, creator and records. `records.data` holds identifiers only in a create response; otherwise follow `records.links.related`.","type":"object","required":["tenant","creator","records"],"additionalProperties":false,"properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"creator":{"$ref":"#/components/schemas/WorkingSetCreatorRelationship"},"records":{"type":"object","required":["links"],"additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data"}},"links":{"$ref":"#/components/schemas/LinksRelated"}}}}},"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},"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},"WorkingSetCreatorRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetCreatorRelationship","description":"The user or API client that created the Working Set. `data.type` is `users` for an interactive user and `apiKeys` for a machine client; `meta.name` holds the creator's display name at creation time.","type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","required":["id","type"],"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users","apiKeys"]}}},"meta":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"The creator's display name at creation time."}}},"links":{"$ref":"#/components/schemas/LinksRelated"}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]},"LinksSelf":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinksSelf","description":"A JSON:API links object with an absolute or relative 'self' link","type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetUpdateOneRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetUpdateOneRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetUpdateOneRequest","description":"Edits or closes a Working Set. Send at least one attribute; omitted attributes stay unchanged. You can edit only an `OPEN` Working Set, and an edit sent with a close applies as one change.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","required":["type","id","attributes"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["workingSets"]},"id":{"type":"string","description":"The Working Set ID; must match the `workingSetId` path parameter."},"attributes":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"Identifies the Working Set."},"purposeOfWork":{"type":"string","minLength":1,"maxLength":250,"description":"The specific job to do, as one short, explicit statement of intent."},"orchestrationReference":{"type":["string","null"],"maxLength":2048,"description":"The external workflow reference driving the work, such as a ticket key or URL. `null` clears it."},"status":{"type":"string","enum":["CLOSED"],"description":"Closes the Working Set. Accepts only `CLOSED`; you can't reopen it."}}}}}}},"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}}}}}}}}
```

## The WorkingSetFindRecordsRelationshipResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetFindRecordsRelationshipResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetFindRecordsRelationshipResponse","description":"Resource identifiers of the records in a Working Set. Follow `links.next` while it is non-null.","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"type":"array","description":"One resource identifier per record","items":{"type":"object","required":["type","id"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["records"]},"id":{"type":"string"}}}},"links":{"type":"object","description":"JSON:API links","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this relationship"},"next":{"type":["string","null"],"description":"Link to the next page; null on the last page"}}},"meta":{"type":"object","additionalProperties":false,"properties":{"total":{"type":"integer","minimum":0,"description":"Total number of records in the relationship"},"cursor":{"type":"string","description":"Cursor for the next page, also in `links.next`"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetAddRecordsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetAddRecordsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAddRecordsRelationshipRequest","description":"Records to add to a Working Set, up to 99 per request.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/data"},"minItems":1,"maxItems":99}}},"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}}}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The WorkingSetAddRecordsRelationshipResponse object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetAddRecordsRelationshipResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetAddRecordsRelationshipResponse","description":"Meta-only response: how many requested records the call linked, and how many the Working Set already held.","type":"object","additionalProperties":false,"required":["meta","jsonapi"],"properties":{"meta":{"type":"object","additionalProperties":false,"required":["requestedCount","addedCount","skippedCount"],"properties":{"requestedCount":{"type":"integer","minimum":1,"description":"Distinct records in the request"},"addedCount":{"type":"integer","minimum":0,"description":"Records the call newly linked to the Working Set"},"skippedCount":{"type":"integer","minimum":0,"description":"Requested records the Working Set already held"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```

## The WorkingSetRemoveRecordsRelationshipRequest object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"WorkingSetRemoveRecordsRelationshipRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWorkingSetRemoveRecordsRelationshipRequest","description":"Records to remove from a Working Set. The API ignores records the Working Set doesn't contain.","type":"object","required":["data"],"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/data"},"minItems":1,"maxItems":99}}},"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}}}}},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["records"]}},"required":["id","type"]}}}}
```

## The JsonApiVersion object

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"components":{"schemas":{"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}}}
```
