Grouped Approvals

Manage assets on a grouped approval

Changed on

Adds and/or removes document versions on a grouped approval. Send add and/or remove arrays of document version IDs.

patch/api/v1/grouped-approvals/{groupGuid}/assets

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/grouped-approvals/{groupGuid}/assets
  • Auth: HTTP bearer

Path parameters

groupGuidstring required
Example:9f8b60820000462ecf66c409d1248fa9

GUID of the grouped approval.

Headers

x-api-keystring required

client_id of the Adobe Developer Console technical account. Identifies the calling integration to the AIO gateway.

x-gw-subdomainstring required

Workfront customer subdomain (e.g. mycompany). Must match the subdomain of the Workfront instance being accessed. Passing an incorrect or unrecognized subdomain will result in a 502 Bad Gateway response from the AIO gateway.

wf-customeridstring required

Workfront customer ID.

wf-useridstring required

Workfront user ID of the acting user.

wf-lane'prod' | 'preview' | 'hub' | 'staging' | 'devtest' required

Workfront deployment lane.

x-request-idstring uuid

Unique identifier for request tracing. Auto-generated if not provided.

x-correlation-idstring

Unique identifier for correlation across multiple service calls. Auto-generated if not provided.

Request body

addstring[]

Document version (DOCV) IDs to add.

removestring[]

Document version (DOCV) IDs to remove.

Response

OK

Example response

{
  "added": [
    {
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a",
      "references": [
        {
          "id": "698b61d400011579a3dbc96cfb99ca06",
          "type": "DOCV"
        },
        {
          "id": "urn:aaid:sc:US:f9228e94-dace-34c9-91da-332a190186d4:0",
          "type": "esm"
        },
        {
          "id": "urn:aaid:aem:eb19fb9d-1543-47c1-b219-578f5be98d2c:1",
          "type": "genStudioDraft"
        }
      ]
    }
  ],
  "removed": [
    {
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a",
      "references": [
        {
          "id": "698b61d400011579a3dbc96cfb99ca06",
          "type": "DOCV"
        },
        {
          "id": "urn:aaid:sc:US:f9228e94-dace-34c9-91da-332a190186d4:0",
          "type": "esm"
        },
        {
          "id": "urn:aaid:aem:eb19fb9d-1543-47c1-b219-578f5be98d2c:1",
          "type": "genStudioDraft"
        }
      ]
    }
  ],
  "errors": [
    {
      "operation": "add",
      "code": "ASSET_ALREADY_IN_GROUP",
      "message": "Asset already belongs to another grouped approval.",
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a",
      "references": [
        {
          "id": "698b61d400011579a3dbc96cfb99ca06",
          "type": "DOCV"
        },
        {
          "id": "urn:aaid:sc:US:f9228e94-dace-34c9-91da-332a190186d4:0",
          "type": "esm"
        },
        {
          "id": "urn:aaid:aem:eb19fb9d-1543-47c1-b219-578f5be98d2c:1",
          "type": "genStudioDraft"
        }
      ]
    }
  ],
  "summary": {
    "added": 2,
    "failed": 1
  }
}

Changes