Content Item - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Lists developer portal's content items specified by the provided content type.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
contentTypeId	path	True	string	Content type identifier.
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.

Responses

Name	Type	Description
200 OK	ContentItemCollection	Returns a collection of Content Type entities.
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

ApiManagementListContentTypeContentItems

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
      "type": "Microsoft.ApiManagement/service/contentTypes/contentItems",
      "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
      "properties": {
        "en_us": {
          "title": "About",
          "description": "Short story about the company.",
          "keywords": "company, about",
          "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
          "permalink": "/about"
        }
      }
    }
  ]
}

Definitions

Name	Description
ContentItemCollection	Paged list of content items.
ContentItemContract	Content type contract details.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ContentItemCollection

Paged list of content items.

Name	Type	Description
nextLink	string	Next page link, if any.
value	ContentItemContract[]	Collection of content items.

ContentItemContract

Content type 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
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

Freigeben über