@azure-rest/purview-workflow package
Interfaces
| ApprovalDetailOutput |
The approval task details |
| ApprovalOutput |
The workflow approval task properties. |
| ApprovalResponseComment | |
| ApproveApprovalTask | |
| ApproveApprovalTask200Response |
Approve an approval task. |
| ApproveApprovalTaskBodyParam | |
| ApproveApprovalTaskDefaultResponse |
Approve an approval task. |
| ApproveApprovalTaskMediaTypesParam | |
| ApproverResponseOutput |
The response of approvers for a workflow task. |
| CancelWorkflowRun | |
| CancelWorkflowRun200Response |
Cancel a workflow run. |
| CancelWorkflowRunBodyParam | |
| CancelWorkflowRunDefaultResponse |
Cancel a workflow run. |
| CancelWorkflowRunMediaTypesParam | |
| CreateOrReplaceWorkflow200Response |
Create or replace a workflow. |
| CreateOrReplaceWorkflowBodyParam | |
| CreateOrReplaceWorkflowDefaultResponse |
Create or replace a workflow. |
| CreateOrReplaceWorkflowMediaTypesParam | |
| DeleteWorkflow204Response |
Delete a workflow. |
| DeleteWorkflowDefaultResponse |
Delete a workflow. |
| ErrorModelOutput |
Default error model |
| ErrorResponseOutput |
Default error response model |
| GetWorkflow | |
| GetWorkflow200Response |
Get a specific workflow. |
| GetWorkflowDefaultResponse |
Get a specific workflow. |
| GetWorkflowRun | |
| GetWorkflowRun200Response |
Get a workflow run. |
| GetWorkflowRunDefaultResponse |
Get a workflow run. |
| GetWorkflowTask | |
| GetWorkflowTask200Response |
Get a workflow task. |
| GetWorkflowTaskDefaultResponse |
Get a workflow task. |
| ListWorkflowRuns | |
| ListWorkflowRuns200Response |
List workflow runs. |
| ListWorkflowRunsDefaultResponse |
List workflow runs. |
| ListWorkflowRunsQueryParam | |
| ListWorkflowRunsQueryParamProperties | |
| ListWorkflowTasks | |
| ListWorkflowTasks200Response |
Get all workflow tasks. |
| ListWorkflowTasksDefaultResponse |
Get all workflow tasks. |
| ListWorkflowTasksQueryParam | |
| ListWorkflowTasksQueryParamProperties | |
| ListWorkflows | |
| ListWorkflows200Response |
List all workflows. |
| ListWorkflowsDefaultResponse |
List all workflows. |
| Operation |
The operation user wants to perform. |
| PageSettings |
An interface that tracks the settings for paged iteration |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PagingOptions |
Options for the paging helper |
| PurviewWorkflowClientOptions |
The optional parameters for the client |
| ReassignCommand |
The request payload of reassigning a workflow task. |
| ReassignCommandReassignmentsItem | |
| ReassignWorkflowTask | |
| ReassignWorkflowTask200Response |
Reassign a workflow task. |
| ReassignWorkflowTaskBodyParam | |
| ReassignWorkflowTaskDefaultResponse |
Reassign a workflow task. |
| ReassignWorkflowTaskMediaTypesParam | |
| RejectApprovalTask | |
| RejectApprovalTask200Response |
Reject an approval task. |
| RejectApprovalTaskBodyParam | |
| RejectApprovalTaskDefaultResponse |
Reject an approval task. |
| RejectApprovalTaskMediaTypesParam | |
| Routes | |
| SimpleTaskDetailOutput |
Workflow simple task details. |
| SimpleTaskOutput |
The workflow simple task properties. |
| SubmitUserRequests | |
| SubmitUserRequests200Response |
Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. |
| SubmitUserRequestsBodyParam | |
| SubmitUserRequestsDefaultResponse |
Submit a user request for requestor, a user request describes user ask to do operation(s) on Purview. If any workflow's trigger matches with an operation in request, a run of the workflow is created. |
| SubmitUserRequestsMediaTypesParam | |
| TaskPayloadOutput |
Info and material that helps assignees to take action. |
| TaskUpdateCommand | |
| TasksListOutput | |
| Trigger |
Describes under what condition a workflow will run. |
| TriggerOutput |
Describes under what condition a workflow will run. |
| UpdateTaskStatus | |
| UpdateTaskStatus200Response |
Update the status of a workflow task request. |
| UpdateTaskStatusBodyParam | |
| UpdateTaskStatusDefaultResponse |
Update the status of a workflow task request. |
| UpdateTaskStatusMediaTypesParam | |
| UserRequestPayload | |
| UserRequestResponseOperationsItemOutput |
The operation user wants to perform. |
| UserRequestResponseOutput |
Describes user ask to do operation(s) on Purview. |
| WorkflowCreateOrUpdateCommand |
Create or update workflow payload. |
| WorkflowMetadataListOutput |
The workflow list. |
| WorkflowMetadataOutput |
The workflow metadata, action DAGs are not included. |
| WorkflowOutput |
The workflow properties. It includes the triggers, actual flow and other properties of a workflow. |
| WorkflowRunCancelRequest | |
| WorkflowRunDetailOutput |
It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions. |
| WorkflowRunListOutput | |
| WorkflowRunMetadataOutput |
The execution of a workflow. It includes status of the entire run and other properties of a run. |
| WorkflowRunOutput |
The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run. |
| WorkflowRunPayloadOutput |
The input of a workflow run. Align with operation in user request. |
| WorkflowRunRunPayloadOutput |
The input of a workflow run. Align with operation in user request. |
| WorkflowTaskExpiryInfoExpirySettingsOutput | |
| WorkflowTaskExpiryInfoOutput |
Info of task expiry. |
| WorkflowTaskOutputParent |
An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. |
| WorkflowTaskReminderInfoOutput |
Info of task reminder. |
Type Aliases
| ApproveApprovalTaskParameters | |
| CancelWorkflowRunParameters | |
| CreateOrReplaceWorkflowParameters | |
| DeleteWorkflowParameters | |
| GetArrayType |
Helper type to extract the type of an array |
| GetPage |
The type of a custom function that defines how to get a page and a link to the next one if any. |
| GetWorkflowParameters | |
| GetWorkflowRunParameters | |
| GetWorkflowTaskParameters | |
| ListWorkflowRunsParameters | |
| ListWorkflowTasksParameters | |
| ListWorkflowsParameters | |
| PaginateReturn |
Helper type to infer the Type of the paged elements from the response type
This type is generated based on the swagger information for x-ms-pageable
specifically on the itemName property which indicates the property of the response
where the page items are found. The default value is |
| PurviewWorkflowClient | |
| ReassignWorkflowTaskParameters | |
| RejectApprovalTaskParameters | |
| SubmitUserRequestsParameters | |
| UpdateTaskStatusParameters | |
| WorkflowTaskOutput |
An actionable item assigned to assignees. It is created when approval or task action starts to execute. Approval is one kind of task. |
Functions
Function Details
default(string, TokenCredential, PurviewWorkflowClientOptions)
Initialize a new instance of PurviewWorkflowClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewWorkflowClientOptions): PurviewWorkflowClientParameters
- endpoint
-
string
The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/
- credentials
- TokenCredential
uniquely identify client credential
- options
- PurviewWorkflowClientOptions
the parameter for all optional parameters
Returns
isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)
function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): responseParameters
Returns
response
isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)
function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): responseParameters
- response
Returns
response
isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)
function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): responseParameters
Returns
response
isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)
function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): responseParameters
Returns
response
isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)
function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): responseParameters
Returns
response
isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)
function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): responseParameters
Returns
response
isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)
function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): responseParameters
Returns
response
isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)
function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): responseParameters
Returns
response
isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)
function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): responseParameters
Returns
response
isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)
function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): responseParameters
Returns
response
isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)
function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): responseParameters
Returns
response
isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)
function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): responseParameters
Returns
response
isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)
function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): responseParameters
Returns
response
isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)
function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): responseParameters
Returns
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>Parameters
- client
- Client
Client to use for sending the next page requests
- initialResponse
-
TResponse
Initial response containing the nextLink and current page of elements
- options
-
PagingOptions<TResponse>
Returns
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator to iterate the elements
