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

109 lines
4.5 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "CaseHistory - Data API",
"description": "Represents historical information about changes that have been made to the associated Case.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"CaseId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the Case associated with this record. This is a relationship field.",
"relationship_name": "Case",
"relationship_type": "Lookup",
"refers_to": "Case"
},
"DataType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Data type of the field that was changed."
},
"Field": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Name of the case field that was modified, or a special value to indicate some other modification to the case. The possible values, in addition to the case field names, are: ownerAssignment—The owner of the case was changed. ownerAccepted—A user took ownership of a case from a queue. ownerEscalated—The owner of the case was changed due to case escalation. external—A user made the case visible to customers in the Customer Self-Service Portal."
},
"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."
},
"NewValue": {
"type": "anyType",
"properties": "Nillable, Sort",
"description": "New value of the modified case field. Maximum of 255 characters."
},
"OldValue": {
"type": "anyType",
"properties": "Nillable, Sort",
"description": "Previous value of the modified case field. Maximum of 255 characters."
}
},
"special_access_rules": "This object is always read-only.",
"usage": "Case history entries are indirectly created each time a case is modified.",
"wsdl_segment": "```xml\n<complexType name=\"CaseHistory\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Case\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Case\"/>\n <element name=\"CaseId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\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=\"DataType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Field\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"NewValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:anyType\"/>\n <element name=\"OldValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:anyType\"/>\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```",
"field_reference": {
"CaseId": {
"field_label": "Case ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DataType": {
"field_label": "Datatype",
"type": "picklist",
"length": "40"
},
"Field": {
"field_label": "Changed Field",
"type": "picklist",
"length": "255"
},
"Id": {
"field_label": "Case History ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"NewValue": {
"field_label": "New Value",
"type": "anyType",
"length": "255"
},
"OldValue": {
"field_label": "Old Value",
"type": "anyType",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}