Tag asset (Helix DAM only)

Manage the tags for the asset files in the depot. Asset tags are stored on the Helix Server as an attribute of the original asset file. For information on file attributes, see p4 attribute.

• Request parameters
• Operations

  PUT /p4/batch/tags

Request parameters

paths

The full depot paths of assets or folders containing assets. If a file revision (identifier) is specified for a file, the tag change requested is only applied that revision of the file.

The identifier parameter cannot be used if the propagatable parameter is set to true.

• Type: array of objects

• Required: true

• identifier file revision: integer

• Allowed file formats: all asset types

create

The tags to add to the assets specified in the paths.

• Type: array

• case: lowercase

delete

The tags to delete from the assets specified in the paths.

• Type: array

• case: lowercase

propagatable

Determines whether the specified tag changes are propagated to future revisions of the asset file.

The propagatable parameter must be set to false if any of the paths specify an identifier.

true: the requested tag change is made to the most recent revision of the assets and future revisions of the assets specified in paths.

false the requested tag change is only made to the specified file revision (identifier) or the most recent revision of the asset file if no revision is specified.

• Type: array

• Boolean: true

Operations

PUT /p4/batch/tags

Manage the tags for the asset files in the depot.

Request example: No propagation

The following example request will:

• Add the car and red tags, and delete the truck and blue tags for:

  • foo.jpg: at revision 456

  • all asset files in //depot/cars: at revision 123

curl -X PUT \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  -H "Content-Type: application/json" \
  -d '{ "paths": [{ "path": "//depot/foo.jpg", "identifier": 456 }, { "path": "//depot/cars/...", "identifier": 123 }], "create": ["car", "red"], "delete": ["truck", "blue"], "propagatable": false }' \
  https://helixteamhub.cloud/api/p4/batch/tags

Response Example

Only files are returned in the response.

[
  {
    "path": "//depot/foo.jpg",
    "identifier": 456
    "tags": ["car", "red"]
  }
]

Request example: With propagation

The following example request will:

• Add the car and red tags for:

  • foo.jpg at the most recent revision and future revisions

  • all of the asset files in //depot/cars at the most recent revision and future revisions

curl -X PUT \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  -H "Content-Type: application/json" \
  -d '{ "paths": [{ "path": "//depot/foo.jpg" }, { "path": "//depot/cars/..." }], "create": ["car", "red"], "propagatable": true }' \
  https://helixteamhub.cloud/api/p4/batch/tags

Response Example

Only files are returned in the response.

[
  {
    "path": "//depot/foo.jpg",
    "identifier": 456
    "tags": ["car", "red"]
  }
]