Metadata API Developer Guide
jNewer Version Available
ExternalServiceRegistration
Represents the External Service
configuration for an org.
This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
ExternalServiceRegistration components have the suffix .externalServiceRegistration and are stored in the externalServiceRegistrations folder.
Version
ExternalServiceRegistration components are available in API version 39.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| description | string | Required. The external service description defined when the service is created. |
| label | string | The service name as it appears on the External Services wizard. |
| namedCredential | string | Required. The reference of the named credential to be used for the service. |
| schema | string | Required. The content of the JSON schema in the Interagent format. Nillable. |
| schemaType | string | Required. ID format of the schema, which is InteragentHyperSchema. Nillable. |
| schemaUrl | string | Required. The schema URL defined when registering a service. The path should begin with “/” and be a relative path. |
| status | string | Indicates whether the service registration is finished (complete) or not (incomplete). |
Declarative Metadata Sample Definition
The following is an example of an ExternalServiceRegistration component that references an external credit service.
1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalServicesRegistration xmlns="http://soap.sforce.com/2016/11/metadata">
3 <label>creditService</label>
4 <namedCredential>AcmeCreditService</namedCredential>
5 <schema>/schema</schema>
6 <schemaType>InteragentHyperSchema</schemaType>
7 <schemaUrl>http://interagent.github.io/interagent-hyper-schema</schemaUrl>
8 <status>complete</status>
9</ExternalServicesRegistration>