Api Schema - List By Api

Get the schema configuration at the API level.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas?api-version=2019-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2019-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

apiId
path True
  • string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Regex pattern: ^[^*#&+:<>?]+$

$filter
query
  • string

| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$top
query
  • integer
int32

Number of records to return.

$skip
query
  • integer
int32

Number of records to skip.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Apis Schema Collection.

Other Status Codes

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
user_impersonation impersonate your user account

Examples

ApiManagementListApiSchemas

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas?api-version=2019-01-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e",
      "type": "Microsoft.ApiManagement/service/apis/schemas",
      "name": "59d5b28e1f7fab116402044e",
      "properties": {
        "contentType": "application/vnd.ms-azure-apim.swagger.definitions+json"
      }
    }
  ],
  "nextLink": ""
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

SchemaCollection

The response of the list schema operation.

SchemaContract

Schema Contract details.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

SchemaCollection

The response of the list schema operation.

Name Type Description
nextLink
  • string

Next page link if any.

value

Api Schema Contract value.

SchemaContract

Schema Contract details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.contentType
  • string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.

properties.document
  • object

Properties of the Schema Document.

type
  • string

Resource type for API Management resource.