Asset Upload Data Model

Initiates and tracks processing of a file uploaded to Live Editor’s file storage.

This resource is a part of the Uploading Assets Workflow.

Sample JSON Data

      {
        "data": {
          "id": "1737042d-3151-4fa4-bdb8-5a87a8f2d6fd",
          "type": "asset-uploads",
          "attributes": {
            "file-name": "logo.png",
            "key": "c97d0973-8a5c-4300-a70c-58e837c8c90c/1483810832535/logo.png",
            "content-type": "image/png",
            "file-size": 22366,
            "user-agent": null,
            "status": "processing",
            "error-message": null,
            "created-at": "2012-04-23T18:25:43.511Z",
            "updated-at": "2012-04-23T18:25:43.511Z"
          },
          "relationships": {
            "asset": {
              "data": {
                "id": "33b08288-5021-4cf9-80d8-d59436f528f6",
                "type": "assets"
              }
            },
            "asset-file": {
              "data": null
            }
          }
        }
      }

Attributes

Attribute Type Required Description
file-name string Yes Name of file to process.
key string Yes Key returned from the upload signature.
content-type string Yes MIME type of file being processed.
file-size number Yes Size of file being processed.
user-agent string No User agent identifier of client that uploaded the file.
status string Read-only Status of upload processing. Following are possible values:

processing
The file is currently being processed and copied to the content delivery network.
finished
Processing of upload is completed. The asset-file relationship (see below) will now reflect details about the asset that was generated by this upload process.
error
An error occurred during processing or the file format is not supported or recognized.
error-message string Read-only If the value of status is error, this will contain details about that error.
created-at date Read-only Records when asset upload record was created, localized to the current logged in user’s time zone.
updated-at date Read-only Records when asset upload record was last updated, localized to the current logged in user’s time zone.

Relationships

Title Type Required Description
asset object Read-only Asset record tracking this upload.
asset-file object Read-only Points to the asset record generated after this upload is processed successfully. Can be an image.

Related