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

139 lines
5.1 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",
"field_reference"
],
"title": "Territory2AlignmentLog - Data API",
"description": "Represents the start and end status of a territory assignment rule run job. This object is available in API version 54.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"EndTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the assignment rule run job finished."
},
"Filter": {
"type": "textarea",
"properties": "Nillable",
"description": "Criteria to filter the rule jobs. For example, {RULE_LAST_MOD_DATE_FORM=2021-08-31, RULE_LAST_MOD_DATE_TO=2021-09-15}."
},
"RunAsId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the Salesforce user who started the assignment rule run job. This is a relationship field.",
"relationship_name": "RunAs",
"relationship_type": "Lookup",
"refers_to": "User"
},
"StartTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the user started the assignment rule run job."
},
"Status": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "The status of the assignment rule run job."
},
"Territory2Id": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the territory for which the assignment rule run was performed. If the assignment rule run was for the territory model, this value is null. This is a relationship field.",
"relationship_name": "Territory2",
"relationship_type": "Lookup",
"refers_to": "Territory2"
},
"Territory2ModelId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the territory model for which the assignment rule run was performed. This is a relationship field.",
"relationship_name": "Territory2Model",
"relationship_type": "Lookup",
"refers_to": "Territory2Model"
}
},
"special_access_rules": "Available if Sales Territories has been enabled. Standard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cant view territory models in other states (such as Planning or Archived).\n\nAvailable if Sales Territories has been enabled.\n\nStandard and partner users can access this object. If a territory model is in Active state, any standard or partner user can view that model, including its territories and assignment rules. For territories in an active model, any standard or partner user can view assigned records and assigned users subject to your Salesforce sharing settings. Users cant view territory models in other states (such as Planning or Archived).",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **Territory2AlignmentLogChangeEvent**: Change events are available for the object.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"EndTime": {
"field_label": "End Time",
"type": "datetime"
},
"Filter": {
"field_label": "Filter Criteria",
"type": "textarea",
"length": "32000"
},
"Id": {
"field_label": "Territory2 Alignment Log ID",
"type": "id",
"length": "18"
},
"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"
},
"RunAsId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"StartTime": {
"field_label": "Start Time",
"type": "datetime"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Territory2Id": {
"field_label": "Territory ID",
"type": "reference",
"length": "18"
},
"Territory2ModelId": {
"field_label": "Territory Model ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}