Skip to content

Get metadata suggestions for assets

Request

Get metadata suggestions for a set of Assets by the specified assets selector.

Use the BY_IDS selector to get suggestions for a specific list of Asset.ids, or the BY_CRITERION selector to get suggestions for a search criterion, e.g. all Assets in a specific folder. See AssetSearch for more detail on the available criterion.

Security
bearerToken
Bodyapplication/jsonrequired
selectoranyrequired
curl -i -X POST \
  https://api-v2.dash.app/asset-metadata-suggestion-batch-jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "selector": {
      "type": "BY_CRITERION",
      "criterion": {
        "type": "FIELD_EQUALS",
        "value": "Folder",
        "field": {
          "type": "FIXED",
          "fieldName": "STAGED_BY"
        },
        "includeDescendants": true,
        "boost": null
      }
    }
  }'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the job that has been created

Example:"be161977-d44e-4888-af3c-66522e223963"
accountIdstringrequired

The ID of the account the job is happening in

Example:"cfb665ca-ce35-4418-b9d5-70ee815db4bd"
creatorIdstringrequired

The ID of the User who created the job

Example:"google-oauth2|110955770826801837334"
typestringrequired

The job type

Value:"IN_PROGRESS"
Discriminator
progressobjectrequired
statusstringrequired
Enum:"PENDING""STARTING""STARTED""STOPPING"
Response
{
  "id": "be161977-d44e-4888-af3c-66522e223963",
  "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
  "creatorId": "google-oauth2|110955770826801837334",
  "type": "IN_PROGRESS",
  "status": "PENDING",
  "progress": {
    "steps": [ … ]
  }
}