afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/ExternalServiceRegistration.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "ExternalServiceRegistration - Tooling API",
  "description": "Represents the external service configuration for an org. Available in API version 39.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`GET`, `PUT`, `POST`, `DELETE`",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "Description": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The description for the external service, defined when the service is created."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort",
      "description": "The developer’s internal name for the external data source used in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores."
    },
    "Language": {
      "type": "string",
      "properties": "Create, DefaultedOnCreate, Filter, Group, Nillable, RestrictedPicklist, Sort, Update",
      "description": "The language of the external service configuration. Chinese (Simplified): zh_CN Chinese (Traditional): zh_TW Danish: da Dutch: nl_NL English: en_US Finnish: fi French: fr German: de Italian: it Japanese: ja Korean: ko Norwegian: no Portuguese (Brazil): pt_BR Russian: ru Spanish: es Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. Swedish: sv Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English."
    },
    "ManageableState": {
      "type": "ManageableState enumerated list",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Label for the external service."
    },
    "NamedCredential": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name reference of the named credential to be used for the service."
    },
    "NamedCredentialReferenceId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name reference of the named credential to be used for the service. References NamedCredential. Available in API version 52.0 and later.",
      "relationship_name": "NamedCredentialReference",
      "relationship_type": "Lookup",
      "refers_to": "NamedCredential"
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace of the package of which the external service is a part."
    },
    "ProviderAssetEndpoint": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Location or ID of the latest schema or metadata at an external site. Currently applies only to MuleSoft assets. Available in API version 57.0 and later."
    },
    "RegistrationProvider": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "A reference to the registration provider. If the registrationProviderType is ExternalConnector, this field contains the external connector name. If the registrationProviderType is Heroku, this field contains the HerokuAppLink ID. For any other registrationProviderType value, this field is blank and reserved for future use."
    },
    "RegistrationProviderAsset": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "A polymorphic foreign key field that contains the name of the asset related to the external service registration. For an external service registration created for a named query, this field contains the named query API name. For an external service registration created for an Apex class that has methods exposed as REST resources or methods that are aura-enabled, this field contains the Apex class name. Available in API version 66.0 and later."
    },
    "RegistrationProviderType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of schema provider used to create this external service. Valid values are: AgentActionOutputs AgentToAgent Anypoint AnypointPublic ApexRest AuraEnabled CodeExtension ContextDef Custom CustomExternalConnector DocumentProcessing ExternalConnector Heroku MuleSoft NamedQuery SchemaInferred Standard For API version 56.0 and later."
    },
    "Schema": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "The content of the OpenAPI 2.0 or OpenAPI 3.0 schema in JSON or YAML format."
    },
    "SchemaAbsoluteUrl": {
      "type": "url",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The full, absolute URL to the schema. For API version 56.0 and later, populated when a user selects Absolute URL during registration."
    },
    "SchemaType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, RestrictedPicklist, Sort, Update",
      "description": "ID format of the schema. For API version 48.0 and later, the valid value is OpenApi. For API version 47.0 and earlier, the valid values are InteragentHyperSchema and OpenApi."
    },
    "SchemaUploadFileExtension": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The file's extension. For API version 56.0 and later, populated when a user selects Upload from local during registration."
    },
    "SchemaUploadFileName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The file's name without the file extension. For API version 56.0 and later, populated when a user selects Upload from local during registration."
    },
    "SchemaUrl": {
      "type": "url",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The schema's URL defined when registering a service. The path must begin with “/” and be a relative path."
    },
    "ServiceBinding": {
      "type": "string",
      "properties": "Nillable",
      "description": "Maps non-supported media types for this external service registration to supported media types. For API version 53.0 and later."
    },
    "ServiceName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the cataloged API service that this external service registration belongs to. Available in API version 63.0 and later. This field was removed in API version 65.0."
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, RestrictedPicklist, Sort",
      "description": "Indicates whether the service registration is finished. Valid values are complete and incomplete."
    },
    "SystemVersion": {
      "type": "integer",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Identifies the external service registration revision. For valid values, see ExternalServiceRegistation in the Metadata API Developer Guide."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"ExternalServiceRegistration\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:ExternalServiceRegistration\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"ExternalServiceRegistration\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"catalogedApiVersion\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n        <xsd:element name=\"namedCredential\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"namedCredentialReference\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"providerAssetEndpoint\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"registrationProvider\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"registrationProviderAsset\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"registrationProviderType\" minOccurs=\"0\" type=\"tns:ExternalServiceRegistrationProviderType\"/>\n        <xsd:element name=\"schema\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"schemaAbsoluteUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"schemaType\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"schemaUploadFileExtension\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"schemaUploadFileName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"schemaUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"serviceBinding\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"serviceDescriptor\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"status\" type=\"xsd:string\"/>\n        <xsd:element name=\"systemVersion\" minOccurs=\"0\" type=\"xsd:int\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ExternalServiceRegistrationProviderType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"MuleSoft\"/>\n    <xsd:enumeration value=\"Custom\"/>\n    <xsd:enumeration value=\"SchemaInferred\"/>\n    <xsd:enumeration value=\"Standard\"/>\n    <xsd:enumeration value=\"ExternalConnector\"/>\n    <xsd:enumeration value=\"CustomExternalConnector\"/>\n    <xsd:enumeration value=\"Heroku\"/>\n    <xsd:enumeration value=\"Anypoint\"/>\n    <xsd:enumeration value=\"ApexRest\"/>\n    <xsd:enumeration value=\"AgentActionOutputs\"/>\n    <xsd:enumeration value=\"IntegProcd\"/>\n    <xsd:enumeration value=\"DocumentProcessing\"/>\n    <xsd:enumeration value=\"NamedQuery\"/>\n    <xsd:enumeration value=\"ModelContextProtocol\"/>\n    <xsd:enumeration value=\"AuraEnabled\"/>\n    <xsd:enumeration value=\"ContextDef\"/>\n    <xsd:enumeration value=\"AgentToAgent\"/>\n    <xsd:enumeration value=\"AnypointPublic\"/>\n    <xsd:enumeration value=\"CodeExtension\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n```"
}