mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 23:41:31 +08:00
71 lines
4.5 KiB
JSON
71 lines
4.5 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"supported_soap_calls",
|
|||
|
|
"supported_rest_api_http_methods",
|
|||
|
|
"fields",
|
|||
|
|
"wsdl_segment"
|
|||
|
|
],
|
|||
|
|
"title": "IPAddressRange - Tooling API",
|
|||
|
|
"description": "Represents a range of IP addresses to include in or exclude from the specified feature.",
|
|||
|
|
"supported_soap_calls": "`create()`, `delete()`, `describeLayout()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
|
|||
|
|
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"properties",
|
|||
|
|
"description"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"Description": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "Not required. The description of the IP address range. For example, the name of the company that owns the IP address range."
|
|||
|
|
},
|
|||
|
|
"DeveloperName": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort",
|
|||
|
|
"description": "The unique name of the IP address range. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
|
|||
|
|
},
|
|||
|
|
"EndAddress": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort",
|
|||
|
|
"description": "The end of the IP address range."
|
|||
|
|
},
|
|||
|
|
"FullName": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Create, Group, Nillable",
|
|||
|
|
"description": "The unique name used as the event delivery identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores."
|
|||
|
|
},
|
|||
|
|
"IpAddressFeature": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
|
|||
|
|
"description": "The feature that uses the range of IP addresses. Possible values are: EmailIpFiltering (default) —Filter email engagement activities such as email opens and email clicks."
|
|||
|
|
},
|
|||
|
|
"IpAddressUsageScope": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
|
|||
|
|
"description": "Whether the specified IP addresses are included or excluded. Possible values are: Exclusion Inclusion"
|
|||
|
|
},
|
|||
|
|
"isProtected": {
|
|||
|
|
"description": "Whether the specified IP address range is protected. The default is false.",
|
|||
|
|
"type": "boolean"
|
|||
|
|
},
|
|||
|
|
"MasterLabel": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort",
|
|||
|
|
"description": "Master label for the IP address range. This internal label doesn’t get translated."
|
|||
|
|
},
|
|||
|
|
"Metadata": {
|
|||
|
|
"type": "complexvalue",
|
|||
|
|
"properties": "Create, Nillable, Update",
|
|||
|
|
"description": "The IP address range metadata."
|
|||
|
|
},
|
|||
|
|
"StartAddress": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, Sort",
|
|||
|
|
"description": "The start of the IP address range."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"wsdl_segment": "```xml\n<xsd:simpleType name=\"IPAddressFeature\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"EmailIpFiltering\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"IPAddressRange\">\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:IPAddressRange\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"IPAddressRange\">\n <xsd:complexContent>\n <xsd:extension base=\"mns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"endIpAddress\" type=\"xsd:string\"/>\n <xsd:element name=\"ipAddressFeature\" type=\"tns:IPAddressFeature\"/>\n <xsd:element name=\"ipAddressUsageScope\" type=\"tns:IPAddressUsageScope\"/>\n <xsd:element name=\"isProtected\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n <xsd:element name=\"startIpAddress\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"IPAddressUsageScope\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Exclusion\"/>\n <xsd:enumeration value=\"Inclusion\"/>\n </xsd:restriction>\n</xsd:simpleType>\n```"
|
|||
|
|
}
|