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

58 lines
3.6 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"wsdl_segment"
],
"title": "UserFieldAccess - Tooling API",
"description": "Represents the access that the current user has to a field. Available in Tooling API version 34.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DurableId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Unique identifier for the field. Always retrieve this value before using it, as the value isnt guaranteed to stay the same from one release to the next. To simplify queries, use this field."
},
"EntityDefinition": {
"type": "EntityDefinition",
"properties": "Filter, Group, Nillable, Sort",
"description": "The entity definition for the object associated with this user entity access record."
},
"EntityDefinitionId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the EntityDefinition."
},
"IsAccessible": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the user specified in the User field has access to view the associated field."
},
"IsCreatable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the user specified in the User field has access to create records of the associated field."
},
"IsUpdatable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "If true, the user specified in the User field has access to edit the associated field."
},
"User": {
"type": "User",
"properties": "Filter, Group, Nillable, Sort",
"description": "The user who has access defined in this user field access record, for the entity specified in the EntityDefinition field. Because this field represents a relationship, use only in subqueries."
},
"UserId": {
"type": "ID",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the user specified in the User field."
}
},
"wsdl_segment": "```xml\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<xsd:complexType name=\"UserFieldAccess\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"DurableId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"EntityDefinition\" minOccurs=\"0\" type=\"ens:EntityDefinition\" nillable=\"true\"/>\n <xsd:element name=\"EntityDefinitionId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"FieldDefinition\" minOccurs=\"0\" type=\"ens:FieldDefinition\" nillable=\"true\"/>\n <xsd:element name=\"FieldDefinitionId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"IsAccessible\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsCreatable\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"IsUpdatable\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"User\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"UserId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
}