mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 16:04:41 +08:00
209 lines
8.6 KiB
JSON
209 lines
8.6 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "Name - Data API",
|
||
"description": "Non-queryable object that provides information about foreign key traversals when the foreign key has more than one parent.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"Alias": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The user alias. This field contains a value only if the related record is a user."
|
||
},
|
||
"Email": {
|
||
"type": "email",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The email address of the user or group (queue)."
|
||
},
|
||
"FirstName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The first name of the user, contact, or lead."
|
||
},
|
||
"IsActive": {
|
||
"type": "boolean",
|
||
"properties": "Defaulted on create, Filter, Group, Sort",
|
||
"description": "Indicates whether the related record is an active user (true) or not (false). This field contains a value only if the related record is a user."
|
||
},
|
||
"LastName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The last name of the user, contact, or lead."
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "datetime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp when the current user last interacted with this record, directly or indirectly."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "datetime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it."
|
||
},
|
||
"MiddleName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The middle name of the user contact, or lead."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the parent of the object queried. If the parent is a user, contact, or lead, the value is a concatenation of the FirstName, MiddleName, LastName, and Suffix fields of the related record."
|
||
},
|
||
"Phone": {
|
||
"type": "phone",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The phone number of the user. This field contains a value only if the related record is a user."
|
||
},
|
||
"Profile": {
|
||
"type": "reference",
|
||
"properties": "Filter, Nillable",
|
||
"description": "The Profile of the user. Only populated if the related record is a user."
|
||
},
|
||
"ProfileId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "ID of the user’s Profile. Only populated if the related record is a user. This field is a relationship field.",
|
||
"relationship_name": "Profile",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Profile"
|
||
},
|
||
"Suffix": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name suffix of the user, contact, or lead."
|
||
},
|
||
"Title": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The title of the user, for example CFO or CEO."
|
||
},
|
||
"Type": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "A list of the types of sObject that can be an owner of this object. You can use this field to filter on a type of owner, for example, return only the leads owned by a user."
|
||
},
|
||
"Username": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Contains the name that a user enters to log into the API or the user interface. The value for this field is in the form of an email address, and is only populated if the related record is a user."
|
||
},
|
||
"UserRole": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Nillable",
|
||
"description": "Name of the Role played by the user. Only populated for user rows."
|
||
},
|
||
"UserRoleId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The ID of the user role associated with this object. This field is a relationship field.",
|
||
"relationship_name": "UserRole",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "UserRole"
|
||
}
|
||
},
|
||
"usage": "To query on relationships where the parent can be more than one type of object, use who, what, or owner relationship fields.",
|
||
"wsdl_segment": "```xml\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<complexType name=\"Name\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Alias\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Email\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FirstName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NameOrAlias\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Phone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Profile\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Profile\"/>\n <element name=\"ProfileId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"RecordType\" nillable=\"true\" minOccurs=\"0\" type=\"ens:RecordType\"/>\n <element name=\"RecordTypeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Title\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserRole\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRole\"/>\n <element name=\"UserRoleId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Username\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"Alias": {
|
||
"field_label": "Alias",
|
||
"type": "string",
|
||
"length": "8"
|
||
},
|
||
"Email": {
|
||
"field_label": "Email",
|
||
"type": "email",
|
||
"length": "80"
|
||
},
|
||
"FirstName": {
|
||
"field_label": "First Name",
|
||
"type": "string",
|
||
"length": "40"
|
||
},
|
||
"Id": {
|
||
"field_label": "ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsActive": {
|
||
"field_label": "Active",
|
||
"type": "boolean"
|
||
},
|
||
"LastName": {
|
||
"field_label": "Last Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"LastReferencedDate": {
|
||
"field_label": "Last Referenced Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastViewedDate": {
|
||
"field_label": "Last Viewed Date",
|
||
"type": "datetime"
|
||
},
|
||
"Name": {
|
||
"field_label": "Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"NameOrAlias": {
|
||
"field_label": "Name or Alias",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"Phone": {
|
||
"field_label": "Phone",
|
||
"type": "phone",
|
||
"length": "40"
|
||
},
|
||
"ProfileId": {
|
||
"field_label": "Profile ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecordTypeId": {
|
||
"field_label": "Record Type ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Title": {
|
||
"field_label": "Title",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"Type": {
|
||
"field_label": "Type",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"UserRoleId": {
|
||
"field_label": "Role ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Username": {
|
||
"field_label": "Username",
|
||
"type": "string",
|
||
"length": "80"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length"
|
||
]
|
||
} |