Share via

Api Issue - Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Updates an existing issue for an API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}?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.
issueId
 path True

string

Issue identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$
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.

Request Header

Name Required Type Description
If-Match True

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name Type Description
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.

Responses

Name Type Description
200 OK

IssueContract

Api issue updated successfully.

Headers

ETag: string
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

ApiManagementUpdateApiIssue

Sample request

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


{
  "properties": {
    "state": "closed"
  }
}

Sample response

Status code:
200 
{
  "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"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
IssueContract

Issue Contract details.
IssueUpdateContract

Issue update Parameters.
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.

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"

IssueUpdateContract

Issue update Parameters.

Name Type Description
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.

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.