afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/EntitlementContact.json

102 lines
5.0 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "EntitlementContact - Data API",
"description": "Represents a Contact eligible to receive customer support via an Entitlement. This object is available in API version 18.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ContactId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the Contact associated with the entitlement. Must be a valid ID.",
"required": true
},
"EntitlementId": {
"type": "reference",
"properties": "Create, Filter",
"description": "ID of the Entitlement associated with the entitlement contact. Must be a valid ID.",
"required": true
},
"IsDeleted": {
"type": "boolean",
"properties": "Defaulted on create, Filter",
"description": "Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Nillable",
"description": "Name of the entitlement contact.",
"required": true
}
},
"usage": "Use to query and manage entitlement contacts.",
"wsdl_segment": "```xml\n<complexType name=\"EntitlementContact\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Contact\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Contact\"/>\n <element name=\"ContactId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Entitlement\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Entitlement\"/>\n <element name=\"EntitlementId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
"field_reference": {
"ContactId": {
"field_label": "Contact ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"EntitlementId": {
"field_label": "Entitlement ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Entitlement Contact ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Entitlement Contact",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}