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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "AuthorizationFormConsent - Data API",
  "description": "Represents the date and way in which a user consented to an authorization form. This object is available in API version 46.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to",
    "picklist_values"
  ],
  "fields": {
    "AuthorizationFormTextId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The authorization form text that the Individual consented to. This is a relationship field.",
      "relationship_name": "AuthorizationFormText",
      "relationship_type": "Lookup",
      "refers_to": "AuthorizationFormText",
      "required": true
    },
    "ConsentCapturedDateTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date and time that consent was given.",
      "required": true
    },
    "ConsentCapturedSource": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The source through which consent was captured. For example, user@example.com, www.example.com.",
      "required": true
    },
    "ConsentCapturedSourceType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The source type through which consent was captured. For example, phone, email, or website.",
      "picklist_values": "Email InPerson MailingAddress Phone Social Video Web",
      "required": true
    },
    "ConsentGiverId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The ID of the person consenting to the authorization form. This is a polymorphic relationship field.",
      "relationship_name": "ConsentGiver",
      "relationship_type": "Lookup",
      "refers_to": "Account, Contact, Individual, Lead, User",
      "required": true
    },
    "DocumentVersionId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the document version for which consent is given. This is a relationship field.",
      "relationship_name": "DocumentVersion",
      "relationship_type": "Lookup",
      "refers_to": "ContentVersion"
    },
    "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, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of the authorization form consent.",
      "required": true
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the owner of the account associated with this customer. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User",
      "required": true
    },
    "RelatedRecordId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of a record showing consent of an authorization form. This is a polymorphic relationship field.",
      "relationship_name": "RelatedRecord",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The status of the authorization form. Possible values are: Rejected Seen Signed"
    },
    "PartyId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "This field was removed in API version 47.0. UseConsentGiverId instead."
    }
  },
  "special_access_rules": "This object is available if Data Protection and Privacy is enabled.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **AuthorizationFormConsentChangeEvent (API version 47.0)**: Change events are available for the object.\n- **AuthorizationFormConsentHistory**: History is available for tracked fields of the object.\n- **AuthorizationFormConsentOwnerSharingRule**: Sharing rules are available for the object.\n- **AuthorizationFormConsentShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"AuthorizationFormConsent\">\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=\"AuthorizationFormText\" nillable=\"true\" minOccurs=\"0\" type=\"ens:AuthorizationFormText\"/>\n        <element name=\"AuthorizationFormTextId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ConsentCapturedDateTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ConsentCapturedSource\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ConsentCapturedSourceType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ConsentGiver\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ConsentGiverId\" 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=\"DigitalSignatures\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"DocumentVersion\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentVersion\"/>\n        <element name=\"DocumentVersionId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"RelatedRecord\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"RelatedRecordId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Status\" 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
  "field_reference": {
    "AuthorizationFormTextId": {
      "field_label": "Authorization Form Text ID",
      "type": "reference",
      "length": "18"
    },
    "Browser": {
      "field_label": "Browser",
      "type": "string",
      "length": "255"
    },
    "ConsentCapturedDateTime": {
      "field_label": "Consent Captured Date Time",
      "type": "datetime"
    },
    "ConsentCapturedSource": {
      "field_label": "Consent Captured Source",
      "type": "string",
      "length": "255"
    },
    "ConsentCapturedSourceType": {
      "field_label": "Consent Captured Source Type",
      "type": "picklist",
      "length": "255"
    },
    "ConsentExpirationDateTime": {
      "field_label": "Consent Expiration Date Time",
      "type": "datetime"
    },
    "ConsentGiverId": {
      "field_label": "Consent Giver ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DocumentVersionId": {
      "field_label": "Content Version ID",
      "type": "reference",
      "length": "18"
    },
    "Email": {
      "field_label": "Email",
      "type": "email",
      "length": "80"
    },
    "Id": {
      "field_label": "Authorization Form Consent ID",
      "type": "id",
      "length": "18"
    },
    "InfoAuthRequestFormId": {
      "field_label": "Info Authorization Request Form ID",
      "type": "reference",
      "length": "18"
    },
    "Ip": {
      "field_label": "IP",
      "type": "string",
      "length": "39"
    },
    "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"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Location": {
      "field_label": "Location",
      "type": "string",
      "length": "255"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "RelatedRecordId": {
      "field_label": "Related Record ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}