{ "opencollection": "1.0.0", "info": { "name": "Unified Approvals API (Deprecated)", "version": "1.0" }, "items": [ { "info": { "name": "Get an approval", "type": "http" }, "http": { "method": "GET", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets the approval required for the given assetType and assetId." }, { "info": { "name": "Create or update an approval", "type": "http" }, "http": { "method": "PUT", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/stages", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new approval with a single stage. If the approval already exists, it will be updated." }, { "info": { "name": "Make a decision on an approval", "type": "http" }, "http": { "method": "PUT", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/decisions", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Make a decision on a stage. If the decision is already made, it will be updated. Overall stage and approval status will be updated based on the decision and other participants. Throws an error if the approval is not found or if participant is not allowed." }, { "info": { "name": "Add or update approval participants", "type": "http" }, "http": { "method": "PUT", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/participants", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Adds new participants to an approval. You can also update an existing participants role by passing in the same participantId again but with their new role." }, { "info": { "name": "Delete approval participants", "type": "http" }, "http": { "method": "DELETE", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/participants", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Removes requested participants from an approval. Removing the last participant on an approval will result in the approval being deleted." }, { "info": { "name": "Lock a stage", "type": "http" }, "http": { "method": "PUT", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/stages/:stageId/lock", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" }, { "name": "stageId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Locks the requested stage of the approval. When a stage is locked, participants cannot make a decision on it. Participants cannot be added or removed." }, { "info": { "name": "Unlock a stage", "type": "http" }, "http": { "method": "PUT", "url": "https://workfront.adobe.io/unified-approvals/public/api/v1/approvals/:assetType/:assetId/stages/:stageId/unlock", "headers": [ { "name": "x-gw-subdomain", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "AssetType", "value": "", "type": "path" }, { "name": "assetId", "value": "", "type": "path", "description": "The id of the asset being approved" }, { "name": "stageId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unlocks the requested stage of the approval. Participants will be able to make a decision on the stage again. Participants can be added or removed from the approval." } ], "bundled": true }