Grouped Approvals

Update grouped approval (full state)

Changed on

Applies a full-state update to a grouped approval: the submitted structure (assets, paths, stages, participants) is reconciled against the current one - adding, updating and removing so the group matches what you send.

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

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/grouped-approvals/{groupGuid}
  • 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

assetsstring[]

The complete set of document version (DOCV) IDs the group should contain.

idempotencyKeystring

Optional client-supplied key that makes a retried request safe (the same key will not apply the update twice).

Response

OK

pathsobject[]
assetsobject[]

Example response

{
  "paths": [
    {
      "pathId": "primary",
      "stages": [
        {
          "stageId": "legal-review",
          "participants": [
            {
              "identityGuid": "698b60820000462ecf66c409d1248fa9"
            }
          ]
        }
      ]
    }
  ],
  "assets": [
    {
      "assetGuid": "673fc29b0006af515e33732d1ebdc39a"
    }
  ]
}

Changes

  • 68f7acba0ea1Revision changes
    • breaking

      added the pattern ^[A-Za-z0-9_-]{1,64}$ to the request property //

    • breaking

      added the pattern ^[A-Za-z0-9_-]{1,64}$ to the request property ////

    • breaking

      added the pattern ^[a-fA-F0-9]{32}$ to the request property //////

  • 5c6824f10092Revision changes
    • info

      endpoint added