Metadata API Developer Guide
jCatalogedApiVersion
Parent Type
This type extends the Metadata metadata type and inherits its
fullName field.
File Suffix and Directory Location
CatalogedApiVersion components have the suffix .catalogedApiVersion and are stored in the catalogedApiVersions folder.
Version
CatalogedApiVersion components are available in API version 65.0 and later.
Special Access Rules
Fields
| Field Name | Field Type | Description |
|---|---|---|
| catalogedApi | string | Required. An API managed for consumption in Salesforce using API Catalog. |
| description | string | The description defined when the API is cataloged. |
| externalSourceIdentifier | string | The ID of the API in the external source that it's imported from. |
| label | string |
Required. The API name as it appears in API Catalog. |
| version | string | Required. The ID of the API version information. |
Declarative Metadata Sample Definition
This XML is an example of a CatalogedApiVersion component.
1<?xml version="1.0" encoding="UTF-8"?>
2<CatalogedApiVersion xmlns="http://soap.sforce.com/2006/04/metadata">
3 <catalogedApi>PetstoreEngineeringv109C60C7C</catalogedApi>
4 <externalSourceIdentifier>urn:ms:03ff2c74-d0ea-4eba-a536-36dfd2d0fdbb:api-project::petstore-engineering/v1</externalSourceIdentifier>
5 <label>petstore-engineering</label>
6 <version>v1lwWZmDFyJYIFValk</version>
7</CatalogedApiVersion>