Grouped Approvals

Get approvals in a grouped approval

Changed on

Returns the individual asset approvals that make up a grouped approval. Pass documentVersionData=true to also attach each document version's Workfront record to the corresponding approval.

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

Request

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

Path parameters

groupGuidstring required
Example:9f8b60820000462ecf66c409d1248fa9

GUID of the grouped approval.

Query parameters

documentVersionDataboolean

When true, attach the Redrock documentVersion record to each DOCV 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.

Response

OK

approvalGuidstring

Unique identifier for the approval

assetIdstring
assetType'DOCV'
creatorIdstring
realCreatorIdstring nullable

ID of the proxy user who actually created the approval. When the approval is created on behalf of another user (e.g. via a technical account or another proxying integration), this is the ID of the actual user making the call (the technical-account / proxy user). The companion creatorId field still reflects the user the action is attributed to. When no proxying takes place, this matches the companion field.

customerDomainstring
eauthTenantIdstring
templateIdstring

ID of the template used to create this approval, if any.

productId'workfront'

Identifier of the Workfront product the approval is associated with. Always workfront for the Unified Approvals Connector.

status'in review' | 'pending review' | 'approved' | 'approved with changes' | 'needs work' | 'reviewed' | 'withdrawn'

Overall lifecycle status of the approval, derived from the rolled-up stage and participant decisions.

  • in review — At least one stage is active and waiting for decisions.
  • pending review — Approval exists but no stage has been activated yet.
  • approved — All required participants have approved.
  • approved with changes — All required participants have decided; at least one with changes.
  • needs work — At least one required participant has returned needs work.
  • reviewed — All reviewer-role participants have reviewed (no approver decisions required).
  • withdrawn — The approval has been retracted; no further actions are possible.
isLockedboolean

Whether the approval is currently locked. Mirrors the lock state of the active stage (a stage being manually locked sets the approval inactive).

isLockOverriddenboolean

Whether the approval lock was overridden by an admin.

decisionDatestring date-time nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
isApprovalActiveboolean

Computed flag that indicates whether the version being accessed is still the document's active (head) version. Compares the document's currentVersionID against the assetId of the requested version: when they match, the version is current and isApprovalActive is true; when the document has been superseded by a newer upload, it is false.

isEsmAssetboolean

Whether the asset is an ESM (Experience Storage Manager) asset

frameSyncStatusboolean nullable

Whether the Frame.io asset sync is complete

decisionstring nullable

The asset's decision within the grouped approval.

documentVersionobject

The Workfront documentVersion record, attached only when documentVersionData=true.

Example response

[
  {
    "approvalGuid": "6744feadafbbfb97a7c1c325",
    "assetId": "673fc29b0006af515e33732d1ebdc39a",
    "assetType": "DOCV",
    "creatorId": "15401B8A66C8F9CB0A49423C@13cc192466c8c9a949410f.e",
    "customerDomain": "mycompany",
    "status": "in review",
    "isLocked": false,
    "isApprovalActive": true,
    "isEsmAsset": true,
    "createdAt": "2024-11-25T22:48:13.598Z",
    "updatedAt": "2024-11-25T22:48:13.598Z",
    "stages": [
      {
        "stageId": "design-review",
        "name": "Design Review",
        "status": "in review",
        "isLocked": false,
        "isActive": true,
        "isStarted": true,
        "isCompleted": false,
        "participants": [
          {
            "participantId": "66cf5cec0002204507c8ce6d532dfc08",
            "participantType": "USER",
            "participantRole": "approver",
            "status": "notified",
            "createdAt": "2024-11-25T22:48:13.598Z",
            "updatedAt": "2024-11-25T22:48:13.598Z"
          }
        ],
        "createdAt": "2024-11-25T22:48:13.598Z",
        "updatedAt": "2024-11-25T22:48:13.598Z"
      }
    ],
    "structure": [
      {
        "stageId": "design-review",
        "parentIds": []
      }
    ],
    "paths": [],
    "userInfo": {
      "isEditable": true,
      "hasLicenseAccess": true,
      "activeDecision": null,
      "availableDecisions": {
        "approved": "Approve",
        "needs work": "Request changes"
      },
      "currentUserMadeDecision": false
    }
  }
]

Changes

  • 8b7d6eb43c60Revision changes
    • info

      removed the needs work enum value from the ///////////// response property for the response status

    • info

      removed the needs work enum value from the ///////////// response property for the response status

    • info

      removed the needs work enum value from the /////////// response property for the response status

    • info

      removed the needs work enum value from the /////////// response property for the response status

  • 68f7acba0ea1Revision changes
    • breaking

      the response property /////////// became optional for the status

    • breaking

      the response property /////////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • breaking

      the response property ///////// became optional for the status

    • warning

      removed the optional property //////////// from the response with the status

    • warning

      removed the optional property //////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status