Get Sy MS Operation Status - Get Sy MS Operation Status

Service:

Synapse

API Version:

2021-04-01

Get the status of validation by operation Id

GET {endpoint}/databases/operations/{operationId}?api-version=2021-04-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string url	The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
operationId	path	True	string	Operation Id.
api-version	query	True	string	The Synapse client API Version.

Responses

Name	Type	Description
200 OK	QueryArtifactsResponse	Successfully returned the status of given operation Id
Other Status Codes	CloudError	SyMS error response.

Examples

Get the status of validation by operation Id,

Sample Request

HTTP

GET exampleWorkspace.dev.azuresynapse.net/databases/operations/exampleOperationId?api-version=2021-04-01

Sample Response

Status code:

200

{
  "items": [
    {
      "name": "exampleName",
      "type": "TABLE"
    }
  ]
}

Status code:

default

{
  "error": {
    "code": "Error code",
    "message": "SyMS response error message"
  }
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Synapse error response.
QueryArtifactsResponse	Query artifacts response.

CloudError

The object that defines the structure of an Azure Synapse error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

QueryArtifactsResponse

Query artifacts response.

Name	Type	Description
continuationToken	string	Continuation token to get next page.
items	object[]	MDEntity (Database/Table/Schema/View/PartitionInfo/PermissionAssignment