Metadata

Some resources (such as clips) can be associated with metadata. That metadata is usually not part of the resource itself, but instead managed as a separate resource called "metadata", nested under the resource's path.

In the URL examples below {resource_path} represents the path to the resource metadata is managed for.

Example for filters:

POST /api/projects/6/metadata/filters HTTP/1.1
Authorization: Bearer example-token
Content-Type: application/json

response:

HTTP/1.1 200

{
  "status": 200,
  "status_message": "OK",
  "info": "",
  "data": {
      "hash": {
          "reel": [],
          "scene": [
              "10"
          ],
          "shoot_date": [],
          "take": [
              "1"
          ],
          "playlists": {
              "123": "playlist 1",
              "234": "playlist 2"
          }
      }
   }
}

Example:

Add camera metadata to a clip

POST /api/projects/6/clips/1162/metadata HTTP/1.1
Authorization: Bearer example-token
Content-Type: application/json

{"metadata":{"type":"camera", "label":"example label"}}

response:

HTTP/1.1 201 Created

{
  "status": 201,
  "status_message": "Created",
  "info": "",
  "data": {"mediametadata":{"id":70583,"media_id":1162,"media_type":"Clip","metadata_id":37,"metadata_type":"CameraMetadata"}}
}

• camera
• content
• copyright
• image
• lens
• object (for unstructured metadata, e.g. ALE)
• structure
• video

When updating metadata, changing the type results in an error.

All of the above types have their own set of attributes. Specifying attributes that aren't part of the type-specific attribute set results in an error.

{
  "metadata":
    "type": "object",
    "custom key 1": "custom value 1",
    "custom key 2": "custom value 2"
  }
}