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

# Data Deliveries

Manage your tenant's data deliveries.

## List data deliveries

> Lists your tenant's data deliveries. Filter by status and export job status; page with \`page.cursor\`.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries":{"get":{"summary":"List data deliveries","operationId":"dataDeliveryFindMany","description":"Lists your tenant's data deliveries. Filter by status and export job status; page with `page.cursor`.","tags":["Data Deliveries"],"parameters":[{"name":"filter.tenant.id","in":"query","description":"Returns only this tenant's deliveries. System users only.","schema":{"type":"string","pattern":"^[a-f0-9]{16}$"}},{"name":"filter.status","in":"query","description":"Returns only deliveries in this status.","schema":{"type":"string","enum":["IN_PROGRESS","COMPLETED","DELETING"]}},{"name":"filter.exportJobStatus","in":"query","description":"Returns only deliveries with this export job status.","schema":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","TIMED_OUT","ABORTED","PENDING_REDRIVE"]}},{"name":"filter.created.after","in":"query","description":"Returns deliveries created at or after this ISO 8601 date-time.","schema":{"type":"string","format":"date-time"}},{"name":"filter.created.before","in":"query","description":"Returns deliveries created at or before this ISO 8601 date-time.","schema":{"type":"string","format":"date-time"}},{"name":"page.cursor","in":"query","description":"The previous page's `meta.cursor`.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryFindManyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Create a single data delivery

> Creates a data delivery. Links up to 99 records in the same request: all or none.\
> \
> To use an alternate running order for a record, set its \`meta.alternateRunningOrderId\`. You must be able to read that running order and the record must be one of its Episodes, or the request creates nothing.\
> \
> Add more records with \`POST /dataDeliveries/{dataDeliveryId}/relationships/records\`, 99 per request, up to 50,000 per package.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"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."}}}}}}]},"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries":{"post":{"summary":"Create a single data delivery","operationId":"dataDeliveryCreateOne","description":"Creates a data delivery. Links up to 99 records in the same request: all or none.\n\nTo use an alternate running order for a record, set its `meta.alternateRunningOrderId`. You must be able to read that running order and the record must be one of its Episodes, or the request creates nothing.\n\nAdd more records with `POST /dataDeliveries/{dataDeliveryId}/relationships/records`, 99 per request, up to 50,000 per package.","tags":["Data Deliveries"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryCreateOneRequest"}}}},"responses":{"201":{"description":"Created OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryCreateOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You can't read an alternate running order named in `meta.alternateRunningOrderId`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: another operation is deleting or moving a record's hierarchy. Retry once it finishes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"An alternate running order in `meta.alternateRunningOrderId` doesn't exist, or a record isn't one of its Episodes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get a single data delivery

> Fetches a data delivery by id.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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}}},"paths":{"/dataDeliveries/{dataDeliveryId}":{"get":{"summary":"Get a single data delivery","operationId":"dataDeliveryFindOne","description":"Fetches a data delivery by id.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The delivery to fetch.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryFindOneResponse"}}}}}}}}}
```

## Update a single data delivery

> Updates a data delivery. Works only while \`status\` is \`IN\_PROGRESS\`.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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."}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}},"paths":{"/dataDeliveries/{dataDeliveryId}":{"patch":{"summary":"Update a single data delivery","operationId":"dataDeliveryUpdateOne","description":"Updates a data delivery. Works only while `status` is `IN_PROGRESS`.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The delivery to update.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryUpdateOneRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Duplicate a data delivery

> Creates a package with the same records, named \`\<source name> (Copy)\`. The source must be \`IN\_PROGRESS\` with \`exportJobStatus\` \`PENDING\`, or \`COMPLETED\`.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries/{dataDeliveryId}/duplicate":{"post":{"summary":"Duplicate a data delivery","operationId":"dataDeliveryDuplicateOne","description":"Creates a package with the same records, named `<source name> (Copy)`. The source must be `IN_PROGRESS` with `exportJobStatus` `PENDING`, or `COMPLETED`.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The delivery to duplicate.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryCreateOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get records relationship (linkage)

> Lists the package's records as resource identifiers (\`type\` and \`id\`). An identifier carries \`meta.alternateRunningOrderId\` when the record uses an alternate running order in this package.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries/{dataDeliveryId}/relationships/records":{"get":{"summary":"Get records relationship (linkage)","operationId":"dataDeliveryFindRecordsRelationship","description":"Lists the package's records as resource identifiers (`type` and `id`). An identifier carries `meta.alternateRunningOrderId` when the record uses an alternate running order in this package.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The data delivery.","in":"path","required":true,"schema":{"type":"string"}},{"name":"page.size","in":"query","description":"Identifiers per page. Omit to return all.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"page.number","in":"query","description":"Page number, starting at 1. Applies only with `page.size`.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryFindRecordsRelationshipResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Add records to a data delivery

> Appends records to the package and keeps the existing ones. Takes up to 99 records per request and links all or none. A package holds at most 50,000 records.\
> \
> To use an alternate running order for a record, set its \`meta.alternateRunningOrderId\`. You must be able to read that running order and the record must be one of its Episodes, or the request adds nothing.\
> \
> Skips records already in the package and keeps their alternate running order. Response \`meta\` reports how many records it added and skipped. Works only while \`status\` is \`IN\_PROGRESS\` and \`exportJobStatus\` is \`PENDING\`.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries/{dataDeliveryId}/relationships/records":{"post":{"summary":"Add records to a data delivery","operationId":"dataDeliveryAddRecordsRelationship","description":"Appends records to the package and keeps the existing ones. Takes up to 99 records per request and links all or none. A package holds at most 50,000 records.\n\nTo use an alternate running order for a record, set its `meta.alternateRunningOrderId`. You must be able to read that running order and the record must be one of its Episodes, or the request adds nothing.\n\nSkips records already in the package and keeps their alternate running order. Response `meta` reports how many records it added and skipped. Works only while `status` is `IN_PROGRESS` and `exportJobStatus` is `PENDING`.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The data delivery.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryAddRecordsRelationshipRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryAddRecordsRelationshipResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"You can't read an alternate running order named in `meta.alternateRunningOrderId`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"An alternate running order in `meta.alternateRunningOrderId` doesn't exist, or a record isn't one of its Episodes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Remove records from a data delivery

> Removes the given records from the package. Works only while \`status\` is \`IN\_PROGRESS\`.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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"]},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}},"paths":{"/dataDeliveries/{dataDeliveryId}/relationships/records":{"delete":{"summary":"Remove records from a data delivery","operationId":"dataDeliveryRemoveRecordsRelationship","description":"Removes the given records from the package. Works only while `status` is `IN_PROGRESS`.","tags":["Data Deliveries"],"parameters":[{"name":"dataDeliveryId","description":"The data delivery.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryRemoveRecordsRelationshipRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Create a data delivery job

> Starts a background job. Depends on \`type\`:\
> \- \`exportDataDelivery\`: exports the package. Needs \`status\` \`IN\_PROGRESS\` and \`exportJobStatus\` \`PENDING\`.\
> \- \`deleteDataDelivery\`: deletes the package. Needs \`status\` \`IN\_PROGRESS\` with \`exportJobStatus\` \`PENDING\`, or \`status\` \`COMPLETED\`.\
> \- \`exportRecordSelection\`: creates a package with the name you send, links the records in your Studio Library selection that you can read, then exports it. Use it for selections too large to send as a list of ids.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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},"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},"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveries/jobs":{"post":{"summary":"Create a data delivery job","operationId":"dataDeliveryExportJobCreateOne","description":"Starts a background job. Depends on `type`:\n- `exportDataDelivery`: exports the package. Needs `status` `IN_PROGRESS` and `exportJobStatus` `PENDING`.\n- `deleteDataDelivery`: deletes the package. Needs `status` `IN_PROGRESS` with `exportJobStatus` `PENDING`, or `status` `COMPLETED`.\n- `exportRecordSelection`: creates a package with the name you send, links the records in your Studio Library selection that you can read, then exports it. Use it for selections too large to send as a list of ids.","tags":["Data Deliveries"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryExportJobCreateOneRequest"}}}},"responses":{"201":{"description":"Created OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryExportJobCreateOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Find data delivery record linkages

> Lists data delivery record linkages. Use exactly one filter:\
> \- \`filter.record.path\`\
> \- \`filter.alternateRunningOrder.id\`\
> \- \`filter.dataDelivery.id\` with \`filter.record.id\`\
> \
> Returns only linkages in packages you can read, at most \`page.size\`, with no total.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Data Deliveries","description":"Manage your tenant's data deliveries."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"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"]},"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},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/dataDeliveryRecordLinkages":{"get":{"summary":"Find data delivery record linkages","operationId":"dataDeliveryRecordLinkageFindMany","description":"Lists data delivery record linkages. Use exactly one filter:\n- `filter.record.path`\n- `filter.alternateRunningOrder.id`\n- `filter.dataDelivery.id` with `filter.record.id`\n\nReturns only linkages in packages you can read, at most `page.size`, with no total.","tags":["Data Deliveries"],"parameters":[{"name":"filter.record.path","description":"Record hierarchy path. Returns linkages for the record at this path and everything beneath it.","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"filter.alternateRunningOrder.id","description":"Returns the linkages tagged with this alternate running order, across every package.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter.dataDelivery.status","description":"Returns only linkages in packages with this status. Needs `filter.alternateRunningOrder.id`.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DataDeliveryAttributeStatus"}},{"name":"filter.dataDelivery.id","description":"The package whose linkages to return. Needs `filter.record.id`.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter.record.id","description":"Comma-separated record ids, at most 100. Returns the package's linkages for exactly these records. Needs `filter.dataDelivery.id`.","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":2048}},{"name":"include","description":"Related resources to add to `included`. `alternateRunningOrder` adds each linked alternate running order you can read. It also gives every linkage's `alternateRunningOrder` relationship a `meta` with the running order's current name and the record's position in it, even when you can't read that running order.","in":"query","required":false,"schema":{"type":"string","enum":["alternateRunningOrder"]}},{"name":"page.size","description":"Maximum linkages to return. Defaults to 100.","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}}],"responses":{"200":{"description":"Matching linkages in packages you can read. Empty when there are none you can see, never an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataDeliveryRecordLinkageFindManyResponse"}}}},"400":{"description":"Missing, malformed or wrongly combined filters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
