ApiDoc
Catalog item.
Schema
id | ID of the catalog item. |
siteId | ID of the parent portal. |
title (required) | Visible name of the catalog item. Must be a non-empty string with a maximum length of 255 characters. |
description | Visible description of the catalog item. Maximum length is 10,000 characters. |
published | Flag that denotes whether the catalog item is published to the portal or is in a draft state. Defaults to |
apiProductName (required) | Name of the associated API product. A portal may have only one catalog item associated with a given API product. Through this link, portal users can create and manage developer apps linked to one or more API products. |
anonAllowed | Flag that manages user access to the catalog item. When Note: When enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI. |
imageUrl | Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for image files stored in the portal, for example, |
modified | Time the catalog item was last modified in milliseconds since epoch. |
categoryIds | IDs of the API categories to which this catalog item belongs. |
requiredCallbackUrl | Flag that specifies whether a callback URL is required when this catalog item's API product is enabled in a developer app. When |
apiId | Not used by Apigee Edge portals. |
visibility | Deprecated. Use |
edgeAPIProductName | Deprecated. Use |
specId | Do not use. Use documentation API instead. |
specContent | Do not use. Use documentation API instead. |
specTitle | Do not use. Use documentation API instead. |
snapshotExists | Not used by Apigee Edge portals. |
snapshotModified | Not used by Apigee Edge portals. |
snapshotState | Do not use. Use documentation API instead. |
specFormat | Do not use. Use documentation API instead. |
specModified | Not used by Apigee Edge portals. |
snapshotOutdated | Not used by Apigee Edge portals. |
snapshotSourceMissing | Not used by Apigee Edge portals. |
graphqlSchema | Do not use. Use documentation API instead. |
graphqlEndpointUrl | Do not use. Use documentation API instead. |
graphqlSchemaDisplayName | Do not use. Use documentation API instead. |
grpcFileName | Not used by Apigee Edge portals. |
grpcZipContent | Not used by Apigee Edge portals. |