User Requests - Submit

Service:

Purview

API Version:

2023-10-01-preview

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.

POST {endpoint}/workflow/userrequests?api-version=2023-10-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (url)	The account endpoint of your Purview account. Example: https://{accountName}.purview.azure.com/
api-version	query	True	string	Version of Purview APIs

Request Body

Name	Required	Type	Description
operations	True	Operation[]	The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.
comment		string	The comment when submit a user request.

Responses

Name	Type	Description
200 OK	UserRequestResponse	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default	Default authorization scope.

Examples

UserRequests_Submit

Sample request

HTTP

POST {endpoint}/workflow/userrequests?api-version=2023-10-01-preview

{
  "operations": [
    {
      "type": "CreateTerm",
      "payload": {
        "glossaryTerm": {
          "name": "term",
          "anchor": {
            "glossaryGuid": "20031e20-b4df-4a66-a61d-1b0716f3fa48"
          },
          "status": "Approved",
          "nickName": "term"
        }
      }
    }
  ],
  "comment": "Thanks!"
}

Sample response

Status code:

200

{
  "requestId": "26026374-f2f6-4627-b2f4-ba2db93c7e2c",
  "requestor": "eece94d9-0619-4669-bb8a-d6ecec5220bc",
  "operations": [
    {
      "type": "CreateTerm",
      "payload": {
        "glossaryTerm": {
          "name": "term",
          "anchor": {
            "glossaryGuid": "20031e20-b4df-4a66-a61d-1b0716f3fa48"
          },
          "status": "Approved",
          "nickName": "term"
        }
      },
      "workflowRunIds": [
        "26026374-f2f6-4627-b2f4-ba2db93c7e2c"
      ]
    }
  ],
  "comment": "Thanks!",
  "status": "InProgress"
}

Definitions

Name	Description
ErrorModel	Default error model
ErrorResponse	Default error response model
Operation	The operation user wants to perform.
Operations	The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.
OperationType	The operation type.
UserRequestPayload
UserRequestResponse	Describes user ask to do operation(s) on Purview.
UserRequestStatus	The status.

ErrorModel

Object

Default error model

Name	Type	Description
code	string	Gets or sets the code.
details	ErrorModel[]	Gets or sets the details.
message	string	Gets or sets the messages.
target	string	Gets or sets the target.

ErrorResponse

Object

Default error response model

Name	Type	Description
error	ErrorModel	Default error model

Operation

Object

The operation user wants to perform.

Name	Type	Description
payload	object	The payload of each operation which user want to submit.
type	OperationType	The operation type.

Operations

Object

The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.

Name	Type	Description
payload	object	The payload of each operation which user want to submit.
type	OperationType	The operation type.
workflowRunIds	string[] (uuid)	The workflow run id.

OperationType

Enumeration

The operation type.

Value	Description
CreateTerm
UpdateTerm
DeleteTerm
ImportTerms
UpdateAsset
GrantDataAccess

UserRequestPayload

Object

Name	Type	Description
comment	string	The comment when submit a user request.
operations	Operation[]	The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.

UserRequestResponse

Object

Describes user ask to do operation(s) on Purview.

Name	Type	Description
comment	string	The comment when submit a user request.
operations	Operations[]	The list of operations user want to submit, each operation matches one Purview API call and will do the operation directly.
requestId	string (uuid)	The user request id.
requestor	string (uuid)	The person who submitted the user request.
status	UserRequestStatus	The status.

UserRequestStatus

Enumeration

The status.

Value	Description
NotStarted
InProgress
Failed
Completed
Canceling
CancellationFailed
Canceled