Microsoft Azure

Azure Synapse Analytics: Syms API

SyMS API Service Client.

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

SyMS API Service Client.

Endpoints 19

  • POSTBatch execution of DDL Payload./databases/ExecuteChange?api-version=stringBatch execution of DDL Payload
  • POSTBatch execution of DDL Payload./databases/ExecuteChangeWithValidation?validationType=string&api-version=stringBatch execution of DDL Payload
  • GETGet all databases in a workspace./databases?api-version=string&continuationToken=string&maxPageSize=0Get all databases in a workspace
  • GETList all Artifacts of a type in a database./databases/:databaseName/:artifactTypes?api-version=string&continuationToken=string&maxPageSize=0List all Artifacts of a type in a database
  • GETList all artifacts in schema by type./databases/:databaseName/schemas/:schemaName/:artifactTypes?api-version=string&continuationToken=string&maxPageSize=0List all Artifacts in schema by type
  • GETList all partition information for a table./databases/:databaseName/tables/:tableName/partitionInfos?api-version=string&continuationToken=string&maxPageSize=0List all partition information for a table
  • GETList all partition information for a view./databases/:databaseName/views/:viewName/partitionInfos?api-version=string&continuationToken=string&maxPageSize=0List all partition information for a view
  • GETList all partition information for table in schema./databases/:databaseName/schemas/:schemaName/tables/:tableName/partitionInfos?api-version=string&continuationToken=string&maxPageSize=0List all partition information for a table in schema
  • GETList all partition information for a view in schema./databases/:databaseName/schemas/:schemaName/views/:viewName/partitionInfos?api-version=string&continuationToken=string&maxPageSize=0List all partition information for a view in schema
  • GETGet details about a database./databases/:databaseName?api-version=stringGet details about a database
  • PUTPut a database./databases/:databaseName?api-version=stringPut a database
  • DELETEDelete a database./databases/:databaseName?api-version=stringDelete a database
  • GETGet an artifact from database./databases/:databaseName/:artifactTypes/:artifactName?api-version=stringGet an artifact from database
  • PUTPut an artifact in a Database./databases/:databaseName/:artifactTypes/:artifactName?api-version=string&continuationToken=string&maxPageSize=0Put an artifact in a Database
  • DELETEDelete an artifact in a Database./databases/:databaseName/:artifactTypes/:artifactName?api-version=stringDelete an artifact in a Database
  • GETGet an artifact from schema./databases/:databaseName/schemas/:schemaName/:artifactTypes/:artifactName?api-version=stringGet an artifact from schema
  • PUTCreate or Update an artifact in a schema./databases/:databaseName/schemas/:schemaName/:artifactTypes/:artifactName?api-version=stringCreate or Update an artifact in a schema
  • DELETEDelete an artifact from Schema./databases/:databaseName/schemas/:schemaName/:artifactTypes/:artifactName?api-version=stringDelete an artifact from Schema
  • GETGet the status of validation by operation Id./databases/operations/:operationId?api-version=stringGet the status of validation by operation Id

API details

Authentication
None declared in the description
Operations
19 operations on 13 pathsGET 11PUT 3DELETE 3POST 2
Response formats
application/json
Description format
Swagger 2.0, API version 2021-04-01

How to test the Azure Synapse Analytics: Syms API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Synapse Analytics: Syms API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Batch execution of DDL Payload.” (POST /databases/ExecuteChange?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Synapse Analytics: Syms API?

SyMS API Service Client. It is listed under Data & analytics and has 19 endpoints.

Who publishes the Azure Synapse Analytics: Syms API?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Synapse Analytics: Syms API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Synapse Analytics: Syms API have?

19 operations on 13 paths (11 GET, 3 PUT, 3 DELETE, 2 POST).

Is forking the Azure Synapse Analytics: Syms API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.