If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / WorkflowApi
new WorkflowApi(
client):WorkflowApi
Create an instance of the WorkflowApi class
Workflow objects represent projects and deliverables stored in the Acquia Workflow system. The API allows you to retrieve, create, delete, and close deliverables and projects.
Provide an instance of ApiClient.
addDeliverable(
params):Promise<AddDeliverableResult>
Add a deliverable to a project
Information about the request
Promise<AddDeliverableResult>
Promise containing information about the added deliverable
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/projects/add-deliverable-to-project
closeDeliverable(
params):Promise<void>
Close the deliverable. Optionally, provide a filename and upload_profile to move the deliverable over to Assets
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/deliverables/close-deliverable
createProject(
params):Promise<CreateProjectResult>
Create a new project
Information about the request
Promise<CreateProjectResult>
Promise containing the new project's ID
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/projects/create-new-project
deleteDeliverable(
project_id,deliverable_id):Promise<void>
Delete a deliverable
string
Project ID
string
Deliverable ID
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/deliverables/delete-deliverable
deleteProject(
project_id):Promise<void>
Delete a project
string
Project ID
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/projects/delete-project
getDeliverable(
params):Promise<GetDeliverableResult>
Retrieve information about a deliverable
Information about the request
Promise<GetDeliverableResult>
Promise containing information about the deliverable
getProject(
params):Promise<GetProjectResult>
Retrieve information about a project
Information about the request
Promise<GetProjectResult>
Promise containing information about the deliverable
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/projects/retrieve-by-project-id
listDeliverables(
params):Promise<ListDeliverablesResult>
Retrieve all deliverables for a project
Information about the request
Promise<ListDeliverablesResult>
Promise containing a list of deliverables
listSupportingFiles(
project_id):Promise<GetSupportingFilesResult>
Retrieve all supporting files for a project
string
Project ID
Promise<GetSupportingFilesResult>
Promise containing a list of supporting files
https://widenv2.docs.apiary.io/#reference/workflow-app-projects/projects/retrieve-supporting-files
uploadProof(
params):Promise<UploadProofResult>
Upload proof to a deliverable
Information about the request
Promise<UploadProofResult>
Promise containing information about the deliverable