WorkflowDocument

Provides APIs to create and retrieve workflow documents.

APIDescription
GET api/v1/workflow/{workflowId}/document?objectId={objectId}&token={token}

Given the workflowId and objectId, returns the content of the specific document if it is available.

GET api/v1/workflow/{workflowId}/document?objectId={objectId}&multiDocId={multiDocId}&token={token}

No documentation available.

DELETE api/v1/workflow/{workflowId}/document?objectId={objectId}

Delete document form workflow definition.

GET api/v1/workflow/{workflowId}/document?processIdNum={processIdNum}&objectId={objectId}

No documentation available.

GET api/v1/workflowDocument/GetDocument?workflowId={workflowId}&objectId={objectId}&token={token}

Given the workflowId and objectId, returns the content of the specific document if it is available.

GET api/v1/workflowDocument/GetDocument?workflowId={workflowId}&objectId={objectId}&multiDocId={multiDocId}&token={token}

No documentation available.

POST api/v1/workflowDocument/AddDocument?workflowId={workflowId}

Adds a document to the workflow. NOTE: 'CustomDocumentName', 'DocumentType' and the document stream should be posted as 'Content-Type: multipart/form-data' 'DocumentType' should be 0 for 'Main' and 1 for 'Attachment'

DELETE api/v1/workflowDocument/DeleteDocument?workflowId={workflowId}&objectId={objectId}

Delete document form workflow definition.

POST api/v1/workflowDocument/AddDocumentFromExternalSource

Upload files form external source to Zorrosign workflow

GET api/v1/workflowDocument/GetDocumentPageSize?processIdNum={processIdNum}&objectId={objectId}

No documentation available.

Workflow

Provides APIs to create workflows using the tag editor.

APIDescription
GET api/v1/workflow/GetWorkflow/{id}

Given a Id of a workflow, returns the definition of the workflow.

POST api/v1/workflow/GetMultipleWorkflow

Given a Id of a workflow, returns the definition of the workflow.

PUT api/v1/workflow/SaveWorkflow

Saves the definition of the workflow.

POST api/v1/workflow/CreateWorkflow

Creates a new workflow definition. In order to save documents and the workflow details, the workflow must first be created and an ID must be acquired.

GET api/v1/workflow/GetWorkflowList?startIndex={startIndex}&pageSize={pageSize}&isDraftList={isDraftList}&orderBy={orderBy}&isAscending={isAscending}&searchText={searchText}&CreatDateFrom={CreatDateFrom}&CreatDateTo={CreatDateTo}

Provide list of workflow details which are accessible.

GET api/v1/workflow/GetWorkflowCount?isDraftList={isDraftList}&searchText={searchText}&CreatDateFrom={CreatDateFrom}&CreatDateTo={CreatDateTo}

Provide workflow count

DELETE api/v1/workflow/DeleteWorkflow/{id}?isDraft={isDraft}

Delete all details of the workflow.

GET api/v1/workflow/GetUniqKeyForTemplate/{id}

No documentation available.

POST api/v1/workflow/ShareTemplateURL

Share the template via email with other users.

POST api/v1/workflow/UpdateWorkflowExpiryDate

Update workflow definition data.

POST api/v1/workflow/EditWorkflow

Edit current workflow definition. In order to save documents and the workflow details, the workflow must first be created and an ID must be acquired.

POST api/v1/workflow/CopyWorkflow

Creates a new workflow definition from an existing workflow definition.

POST api/v1/workflow/SendWorkflowCopy

Send a copy of workflow to another user. And it will be listed on receiver's workflow list.

GET api/v1/workflow/AcceptWorkflowCopy?upprId={upprId}

Accept copy of a workflow which was send by another user.

DashBoard

Provide the work flow dash board related functionalities.

APIDescription
GET api/v1/dashboard/GetCountForCategory?labelId={labelId}&dashboardCategory={dashboardCategory}&searchText={searchText}&startDateFrom={startDateFrom}&startDateTo={startDateTo}&endDateFrom={endDateFrom}&endDateTo={endDateTo}

Gets the count of all workflow categories

GET api/v1/dashboard/GetDetailsForCategory?type={type}&startIndex={startIndex}&pageSize={pageSize}&orderBy={orderBy}&isAscending={isAscending}&labelId={labelId}&searchText={searchText}&startDateFrom={startDateFrom}&startDateTo={startDateTo}&endDateFrom={endDateFrom}&endDateTo={endDateTo}

Gets the details of workflow by each workflow categories

PUT api/v1/dashboard/UpdateFlag?instanceId={instanceId}&flagType={flagType}&WorkflowSourceCategory={WorkflowSourceCategory}

Update the process flag whether it's importance or not.

GET api/v1/dashboard/BulkSendWorkflows?type={type}&parentInstanceIds={parentInstanceIds}&labelId={labelId}

Get bulk send workflow instances of parent process.

GET api/v1/dashboard/BulkSendWorkflowCounts?parentInstanceIds={parentInstanceIds}&labelId={labelId}

Get bulk send workflow instance counts of parent process.

Process

Provide the workflow instance related functionalities.

APIDescription
POST api/v1/process/CreateProcess

Initialize a process from the definition and place holder data.

GET api/v1/process/GetPublicTemplate?templateKey={templateKey}

Get the template id, user place holder labels and generated process name for the given template mapped guid

GET api/v1/process/GetProcess?processId={processId}

Gets already initiated process.

POST api/v1/process/GetProcessList

Gets already initiated process.

GET api/v1/process/GetProcessDetails?processId={processId}&canMarkAsViewed={canMarkAsViewed}&upprId={upprId}

Get the current document set and the status of the process.

GET api/v1/process/GetESignProcessDetails?workflowId={workflowId}

Get Esign process details using workflow id

GET api/v1/process/GetTicks

Generate a an identification based on server time.

PUT api/v1/process/SaveAllProcess

Initialize a list of processes from the definition and save them on DB when a workflow starts executing.

GET api/v1/process/GetPageCount

Gets total number of pages user processed

GET api/v1/process/GetEnvironmentSaving

Environmental saving figures per user's utilized page count

PUT api/v1/process/SendReminder

Send email reminder to users in the given step of workflow instance

GET api/v1/process/GetDocumentStatus?documentId={documentId}

No documentation available.

POST api/v1/process/CancelProcess

Cancel an instance of a workflow

POST api/v1/process/GetUsersForProcessList

Get Users for a given process

POST api/v1/process/SendDashboardEmail

Send emails to document users via dashboard.

PUT api/v1/process/SaveAllDrafts

Save list of process data temporary on DB after workflow starts executing.

PUT api/v1/process/ShareProcess

Share completed document.

GET api/v1/process/GetExternalSourceData?processId={processId}&sourceId={sourceId}

Get external resource data associated with this process.

GET api/v1/process/GetExternalSourceFields?sourceId={sourceId}&category={category}

Get fields from external data source

GET api/v1/process/GetUsageSummary?isProfileSummary={isProfileSummary}

Get document sets and user license usage summary of the organization

DELETE api/v1/process/DeleteProcess?processId={processId}

Delete process

GET api/v1/process/GetAccessLink?processId={processId}

No documentation available.

ProcessDocument

Provides APIs to create and retrieve process related documents.

APIDescription
GET api/v1/process/{processId}/document?objectId={objectId}&token={token}&embedAnnotation={embedAnnotation}

Get document by the document object Id.

GET api/v1/process/{processId}/document?objectId={objectId}&multiDocId={multiDocId}&token={token}&embedAnnotation={embedAnnotation}&downloadAsPdf={downloadAsPdf}&dwfComments={dwfComments}

Get document by the document object Id.

GET api/v1/process/{processId}/document?multiDocId={multiDocId}&token={token}&embedAnnotation={embedAnnotation}

No documentation available.

GET api/v1/process/{processId}/document?processIdNum={processIdNum}&objectId={objectId}

No documentation available.

POST api/v1/process/{processId}/document?objectId={objectId}

Update an existing document of a process. NOTE: 'DocumentName', 'DocumentType', 'ObjectId' and the document stream should be posted as 'Content-Type: multipart/form-data'

DELETE api/v1/process/{processId}/document?objectId={objectId}

Delete document form process attached documents.

GET api/v1/processDocument/GetDocument?processId={processId}&objectId={objectId}&token={token}&embedAnnotation={embedAnnotation}

Get document by the document object Id.

GET api/v1/processDocument/GetDocument?processId={processId}&objectId={objectId}&multiDocId={multiDocId}&token={token}&embedAnnotation={embedAnnotation}&downloadAsPdf={downloadAsPdf}&dwfComments={dwfComments}

Get document by the document object Id.

GET api/v1/processDocument/DownloadDocument?processId={processId}&multiDocId={multiDocId}&token={token}&embedAnnotation={embedAnnotation}

No documentation available.

GET api/v1/processDocument/GetDocumentPageSize?processIdNum={processIdNum}&objectId={objectId}

No documentation available.

POST api/v1/processDocument/AddDocument?processId={processId}

Adds a document to the process. NOTE: 'CustomDocumentName', 'DocumentType' and the document stream should be posted as 'Content-Type: multipart/form-data'

POST api/v1/processDocument/UpdateDocument?processId={processId}&objectId={objectId}

Update an existing document of a process. NOTE: 'DocumentName', 'DocumentType', 'ObjectId' and the document stream should be posted as 'Content-Type: multipart/form-data'

DELETE api/v1/processDocument/DeleteDocument?processId={processId}&objectId={objectId}

Delete document form process attached documents.

POST api/v1/processDocument/AddDocumentFromExternalSource

Upload files form external source to Zorrosign workflow

SelfSign

Provides APIs to selfsign instance.

APIDescription
GET api/v1/sign/GetDraftList?startIndex={startIndex}&pageSize={pageSize}&orderBy={orderBy}&isAscending={isAscending}&searchText={searchText}&CreatDateFrom={CreatDateFrom}&CreatDateTo={CreatDateTo}

Get list of Single signatory and Multiple signatory according to the profileId of the requested user.

Label

Provides APIs to create labels for processes and workflows.

APIDescription
PUT api/v1/label/Create

Create a label for a process/workflow

POST api/v1/label/Update

Update label data in a process/workflow

DELETE api/v1/label/Delete?labelId={labelId}&labelCategory={labelCategory}

Delete label in a process/workflow

POST api/v1/label/AddUserWorkflows

Add user document sets in a process/workflow into a label

GET api/v1/label/GetLabels?labelCategory={labelCategory}

Get user label list of the page.

POST api/v1/label/MoveItemsToLabel

Move labels and document sets to another Label

POST api/v1/label/CopyItemsToLabel

Copy labels and document sets to another Label