Api Issue - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

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=2024-05-01

With optional parameters:

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=2024-05-01

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	string	API identifier. Must be unique in the current API Management service instance.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$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 \| \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.
expandCommentsAttachments	query		boolean	Expand the comment attachments.

Responses

Name	Type	Description
200 OK	IssueCollection	Paged Result response of issues for the API.
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
user_impersonation	impersonate your user account

Examples

ApiManagementListApiIssues

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IssueCollection	Paged Issue list representation.
IssueContract	Issue Contract details.
State	Status of the issue.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IssueCollection

Paged Issue list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	IssueContract[]	Issue values.

IssueContract

Issue Contract details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
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	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	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

Share via