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

59 lines
4.5 KiB
JSON

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"special_access_rules",
"wsdl_segment"
],
"title": "DomainProvision - Tooling API",
"description": "Represents provisioned changes to custom domains. This object is available in API version 50.0 and later.",
"supported_soap_calls": "`describeSObjects()`, `query()`, `retrieve()`",
"supported_rest_api_http_methods": "`GET`, `HEAD`, `Query`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CnameTarget": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Represents the canonical name (CNAME) of the external host or server for this domain. If you use a non-Salesforce provider, such as your own external server or CDN provider, to serve your domain, this field points to the CNAME of the external provider."
},
"IsActive": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Represents whether the provisioning for this domain is processing or complete (true) or not (false). When you activate a provisioned domain, this field is set to false. The default value is false."
},
"ProvisionEndDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Represents when the provisioning process was finished."
},
"ProvisionFinalizeDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Represents when the provisioning process was canceled or when the provisioned domain was activated."
},
"ProvisionStartDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Represents when the provisioning process started."
},
"TargetCdnCertificate": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "If the domain is served on the Salesforce Content Delivery Network (CDN), represents the certificate that serves this domain. If your domain uses another domain configuration option, this field is null."
},
"TargetDomainName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Represents the domain name, such as www.example.com."
}
},
"special_access_rules": "Only users with the Salesforce Integration user permission can access this object.",
"wsdl_segment": "```xml\n<xsd:complexType name=\"DomainProvision\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"CnameTarget\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"DomainId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"IsActive\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ProvisionEndDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ProvisionFinalizeDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ProvisionStartDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"TargetCdnCertificate\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"TargetDomainName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"ID\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:length value=\"18\"/>\n <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n </xsd:restriction>\n</xsd:simpleType>\n```"
}