ApiDocResponse

Catalog item resource wrapped with response status, errorCode, etc.

Schema

ApiDocResponse
status

string

Status of the operation.

message

string

Description of the operation.

requestId

string

Unique ID of the request.

errorCode

boolean

Unique error code for the request, if any.

data

array

Catalog item resource.

ApiDoc

Catalog item.

id

integer

ID of the catalog item.

siteId

string

ID of the parent portal.

title (required)

string

Visible name of the catalog item. Must be a non-empty string with a maximum length of 255 characters.

description

string

Visible description of the catalog item. Maximum length is 10,000 characters.

published

boolean

Flag that denotes whether the catalog item is published to the portal or is in a draft state. Defaults to false. When published, you can manage the visibility of the API as described in Manage the visibility of an API in your portal.

apiProductName (required)

string

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

boolean

Flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Defaults to false. For more information about setting this flag, see Manage the visibility of an API in your portal.

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

string

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, /files/book-tree.jpg. When specifying the URL of an external image, the image will not be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by content security policies. Maximum length of file path is 2083 characters.

modified

integer

Time the catalog item was last modified in milliseconds since epoch.

categoryIds

array

IDs of the API categories to which this catalog item belongs.

requiredCallbackUrl

boolean

Flag that specifies whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).

apiId

string

Not used by Apigee Edge portals.

visibility

boolean

Deprecated. Use published.

edgeAPIProductName

string

Deprecated. Use apiProductName.

specId

string

Do not use. Use documentation API instead.

specContent

string

Do not use. Use documentation API instead.

specTitle

string

Do not use. Use documentation API instead.

snapshotExists

boolean

Not used by Apigee Edge portals.

snapshotModified

string

Not used by Apigee Edge portals.

snapshotState

string

Do not use. Use documentation API instead.

specFormat

string

Do not use. Use documentation API instead.

specModified

string

Not used by Apigee Edge portals.

snapshotOutdated

boolean

Not used by Apigee Edge portals.

snapshotSourceMissing

boolean

Not used by Apigee Edge portals.

graphqlSchema

string

Do not use. Use documentation API instead.

graphqlEndpointUrl

string

Do not use. Use documentation API instead.

graphqlSchemaDisplayName

string

Do not use. Use documentation API instead.

grpcFileName

string

Not used by Apigee Edge portals.

grpcZipContent

string

Not used by Apigee Edge portals.