Api Issue - List By Service

Lists all issues associated with the specified API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues?api-version=2019-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues?$filter={$filter}&expandCommentsAttachments={expandCommentsAttachments}&$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 identifier. Must be unique in the current API Management service instance.

$filter
query
  • string

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

expandCommentsAttachments
query
  • boolean

Expand the comment attachments.

$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

Paged Result response of issues for the API.

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

ApiManagementListApiIssues

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/issues",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "title": "New API issue",
        "description": "New API issue description",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "state": "open",
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"
      }
    }
  ],
  "nextLink": ""
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

IssueCollection

Paged Issue list representation.

IssueContract

Issue Contract details.

State

Status of the issue.

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.

IssueCollection

Paged Issue list representation.

Name Type Description
nextLink
  • string

Next page link if any.

value

Issue values.

IssueContract

Issue Contract details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.apiId
  • string

A resource identifier for the API the issue was created for.

properties.createdDate
  • string

Date and time when the issue was created.

properties.description
  • string

Text describing the issue.

properties.state

Status of the issue.

properties.title
  • string

The issue title.

properties.userId
  • string

A resource identifier for the user created the issue.

type
  • string

Resource type for API Management resource.

State

Status of the issue.

Name Type Description
closed
  • string

The issue was closed.

open
  • string

The issue is opened.

proposed
  • string

The issue is proposed.

removed
  • string

The issue was removed.

resolved
  • string

The issue is now resolved.