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

181 lines
10 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",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "AuthorizationFormText - Data API",
"description": "Represents an authorization forms text and language settings. This object is available in API version 46.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AuthorizationFormId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID of the associated authorization form record. This is a relationship field.",
"relationship_name": "AuthorizationForm",
"relationship_type": "Lookup",
"refers_to": "AuthorizationForm",
"required": true
},
"ContentDocumentId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the ContentDocument that provides the authorization forms text. This is a relationship field.",
"relationship_name": "ContentDocument",
"relationship_type": "Lookup",
"refers_to": "ContentDocument"
},
"DetailAuthorizationFormText": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "A detailed version of the authorization form."
},
"FullAuthorizationFormUrl": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The URL where the full text of the authorization form is located."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed this record. If this value is null, its possible that this record was referenced (LastReferencedDate) and not viewed."
},
"Locale": {
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The combined language and locale ISO code that control the language of the authorization form text. Locale and LocaleSelection have the same function. Note: Locale can contain custom values not included in the picklist if added before version 47.0."
},
"LocaleSelection": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The combined language and locale ISO code that control the language of the authorization form text. Locale and LocaleSelection have the same function."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the authorization form text.",
"required": true
},
"SummaryAuthFormText": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A shortened version of the authorization form that is displayed to the user."
}
},
"special_access_rules": "This object is available if Data Protection and Privacy is enabled.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **AuthorizationFormTextChangeEvent (API version 61.0)**: Change events are available for the object.\n- **AuthorizationFormTextHistory**: History is available for tracked fields of the object.",
"wsdl_segment": "```xml\n<complexType name=\"AuthorizationFormText\">\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=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AuthorizationForm\" nillable=\"true\" minOccurs=\"0\" type=\"ens:AuthorizationForm\"/>\n <element name=\"AuthorizationFormConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AuthorizationFormId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContentDocument\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentDocument\"/>\n <element name=\"ContentDocumentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FullAuthorizationFormUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Histories\" 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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Locale\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LocaleSelection\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SummaryAuthFormText\" 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": {
"AuthorizationFormId": {
"field_label": "Authorization Form ID",
"type": "reference",
"length": "18"
},
"ContentDocumentId": {
"field_label": "Content Document ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DetailAuthorizationFormText": {
"field_label": "Detail Authorization Form Text",
"type": "textarea",
"length": "32768"
},
"FullAuthorizationFormUrl": {
"field_label": "Full Authorization Form URL",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Authorization Form Text ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Is Active",
"type": "boolean"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsReadOnly": {
"field_label": "Is Read Only",
"type": "boolean"
},
"LastActivationDateTime": {
"field_label": "Last Activation Date Time",
"type": "datetime"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Locale": {
"field_label": "Locale",
"type": "picklist",
"length": "255"
},
"LocaleSelection": {
"field_label": "Locale",
"type": "picklist",
"length": "255"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"SummaryAuthFormText": {
"field_label": "Summary Auth Form Text",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}