Skip to content

StudioBundleSourceDto

Endpoints · All schemas

FieldRequiredDescription
contentTypeYesstring
fileNameYesstring
idYesIdentifier on the exporting server
keyYesMapping key for the import request
kindYes`library-asset`, `edited-master` or `project-import` (a file kept with the project)
modeYesSee definition below
resolutionYesSee definition below
sizeBytesYesSize of the source file, when the exporting server knew it
suggestedAssetIdYesAn asset of yours with the same content

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: StudioBundleSourceMode, StudioBundleSourceResolution

{
  "properties": {
    "contentType": {
      "nullable": true,
      "type": "string"
    },
    "fileName": {
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "Identifier on the exporting server",
      "type": "string"
    },
    "key": {
      "description": "Mapping key for the import request",
      "type": "string"
    },
    "kind": {
      "description": "`library-asset`, `edited-master` or `project-import` (a file kept with the project)",
      "type": "string"
    },
    "mode": {
      "$ref": "#/components/schemas/StudioBundleSourceMode"
    },
    "resolution": {
      "$ref": "#/components/schemas/StudioBundleSourceResolution"
    },
    "sizeBytes": {
      "description": "Size of the source file, when the exporting server knew it",
      "nullable": true,
      "type": "string"
    },
    "suggestedAssetId": {
      "description": "An asset of yours with the same content",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "contentType",
    "fileName",
    "id",
    "key",
    "kind",
    "mode",
    "resolution",
    "sizeBytes",
    "suggestedAssetId"
  ],
  "type": "object"
}