Skip to content

AssetDevelopRevisionResponseDto

Endpoints · All schemas

FieldRequiredDescription
assetIdYesAsset this revision belongs to
attemptsYesRender attempts so far; one automatic retry follows a first failure
createdAtYesWhen the version was saved
errorYesWhy the last render failed, when it did
exportIdYesThe export of the original an imported version was developed from
fileNameYesName of the imported file, for a version developed elsewhere
hasMasterYesTrue once the edited master file exists
hasPreviewYesTrue once the preview file exists
heightYesHeight of the edited master in pixels
idYesDevelop revision ID
isCurrentYesTrue for the version the asset currently shows
kindYesSee definition below
labelYesName given when the version was saved
progressYesRender progress as a percentage
recipeYesSee definition below
renderedAtYesWhen the render finished
rendererVersionYesIdentity of the renderer that produced the files, for lineage
renditionChecksumYesSHA-256 (hex) of the edited master file, once it exists
revisionYesPer-asset sequence number, 1 for the first saved version
softwareYesApplication an imported version was developed with, when known
sourceChecksumYesSHA-256 (hex) of the original this version was rendered or developed from
statusYesSee definition below
updatedAtYesWhen the revision last changed
widthYesWidth of the edited master in pixels

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: AssetDevelopRevisionKind, AssetDevelopRecipeDto, AssetDevelopRevisionStatus

{
  "properties": {
    "assetId": {
      "description": "Asset this revision belongs to",
      "format": "uuid",
      "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"
    },
    "attempts": {
      "description": "Render attempts so far; one automatic retry follows a first failure",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "createdAt": {
      "description": "When the version was saved",
      "format": "date-time",
      "type": "string"
    },
    "error": {
      "description": "Why the last render failed, when it did",
      "nullable": true,
      "type": "string"
    },
    "exportId": {
      "description": "The export of the original an imported version was developed from",
      "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"
    },
    "fileName": {
      "description": "Name of the imported file, for a version developed elsewhere",
      "nullable": true,
      "type": "string"
    },
    "hasMaster": {
      "description": "True once the edited master file exists",
      "type": "boolean"
    },
    "hasPreview": {
      "description": "True once the preview file exists",
      "type": "boolean"
    },
    "height": {
      "description": "Height of the edited master in pixels",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "id": {
      "description": "Develop revision ID",
      "format": "uuid",
      "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"
    },
    "isCurrent": {
      "description": "True for the version the asset currently shows",
      "type": "boolean"
    },
    "kind": {
      "$ref": "#/components/schemas/AssetDevelopRevisionKind"
    },
    "label": {
      "description": "Name given when the version was saved",
      "nullable": true,
      "type": "string"
    },
    "progress": {
      "description": "Render progress as a percentage",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "recipe": {
      "$ref": "#/components/schemas/AssetDevelopRecipeDto"
    },
    "renderedAt": {
      "description": "When the render finished",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "rendererVersion": {
      "description": "Identity of the renderer that produced the files, for lineage",
      "nullable": true,
      "type": "string"
    },
    "renditionChecksum": {
      "description": "SHA-256 (hex) of the edited master file, once it exists",
      "nullable": true,
      "type": "string"
    },
    "revision": {
      "description": "Per-asset sequence number, 1 for the first saved version",
      "maximum": 9007199254740991,
      "minimum": 1,
      "type": "integer"
    },
    "software": {
      "description": "Application an imported version was developed with, when known",
      "nullable": true,
      "type": "string"
    },
    "sourceChecksum": {
      "description": "SHA-256 (hex) of the original this version was rendered or developed from",
      "nullable": true,
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/AssetDevelopRevisionStatus"
    },
    "updatedAt": {
      "description": "When the revision last changed",
      "format": "date-time",
      "type": "string"
    },
    "width": {
      "description": "Width of the edited master in pixels",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "assetId",
    "attempts",
    "createdAt",
    "error",
    "exportId",
    "fileName",
    "hasMaster",
    "hasPreview",
    "height",
    "id",
    "isCurrent",
    "kind",
    "label",
    "progress",
    "recipe",
    "renderedAt",
    "rendererVersion",
    "renditionChecksum",
    "revision",
    "software",
    "sourceChecksum",
    "status",
    "updatedAt",
    "width"
  ],
  "type": "object"
}