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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "ObjectTerritory2AssignmentRule - Data API",
  "description": "Represents a territory assignment rule that’s associated with an object, such as Account. ObjectTerritory2AssignmentRuleItem can be created or deleted if the BooleanFilter field on its corresponding ObjectTerritory2AssignmentRule is null. Available if Sales Territories has been enabled.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "BooleanFilter": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Represents advanced filter conditions that were specified for the rule in the online application. For example, “(1 AND 2) OR 3.”"
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. The field label in the user interface is Unique Name. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.",
      "required": true
    },
    "IsActive": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the rule is active (true) or inactive (false). Via the API, active rules run automatically when object records are created and edited. The exception is when the value of the IsExcludedFromRealign field on an object record is true, which prevents record assignment rules from evaluating that record."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The language of the label in the user interface."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The user interface label for the territory type.",
      "required": true
    },
    "ObjectType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The object that the rule is defined for. For API version 31, Account only."
    },
    "Territory2ModelId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the territory model."
    }
  },
  "special_access_rules": "Standard users can access this object. If a territory model is in Active state, any standard user can view that model, including its territories, assignment rules, assigned records, and assigned users. Users cannot view territory models in other states (such as Planning or Archived).",
  "field_reference": {
    "BooleanFilter": {
      "field_label": "Boolean Filter",
      "type": "string",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "Id": {
      "field_label": "Object Territory Assignment Rule ID",
      "type": "id",
      "length": "18"
    },
    "IsActive": {
      "field_label": "Active",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Rule Name",
      "type": "string",
      "length": "80"
    },
    "ObjectType": {
      "field_label": "Object Type",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Territory2ModelId": {
      "field_label": "Territory Model ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}