territory EntityType
Territory represents sales regions.
- Entity set path:
- [organization URI]/api/data/v9.2/territories
- Base type:
- crmbaseentity
- Display name:
- Territory
- Primary key:
- territoryid
- Primary key attribute:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details |
|---|---|---|
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
| description | Edm.String |
Description of the territory. Display name: Description |
| entityimage | Edm.Binary |
The default image for the entity. Display name: Entity Image |
| entityimage_timestamp | Edm.Int64 |
Read only
|
| entityimage_url | Edm.String |
Read only
|
| entityimageid | Edm.Guid |
Read only
|
| exchangerate | Edm.Decimal |
Exchange rate for the currency associated with the territory with respect to the base currency. Display name: Exchange Rate Read only
|
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
| name | Edm.String |
Name of the territory. Display name: Territory Name |
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
| territoryid | Edm.Guid |
Unique identifier of the territory. Display name: Territory |
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the territory. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the territory. |
| _managerid_value | managerid |
Unique identifier of the manager of the territory. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the territory. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the territory. |
| _organizationid_value | organizationid |
Unique identifier for the organization |
| _parentterritoryid_value | parentterritoryid |
Choose the parent for this territory. |
| _transactioncurrencyid_value | transactioncurrencyid |
Unique identifier of the currency associated with the territory. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_territorybase_createdby |
| createdonbehalfby | systemuser | lk_territorybase_createdonbehalfby |
| managerid | systemuser | system_user_territories |
| modifiedby | systemuser | lk_territorybase_modifiedby |
| modifiedonbehalfby | systemuser | lk_territorybase_modifiedonbehalfby |
| organizationid | organization | organization_territories |
| parentterritoryid | territory | territory_parent_territory |
| transactioncurrencyid | transactioncurrency | TransactionCurrency_Territory |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| Territory_AsyncOperations | asyncoperation | regardingobjectid_territory |
| Territory_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_territory |
| territory_connections1 | connection | record1id_territory |
| territory_connections2 | connection | record2id_territory |
| territory_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_territory |
| territory_parent_territory | territory | parentterritoryid |
| territory_principalobjectattributeaccess | principalobjectattributeaccess | objectid_territory |
| Territory_ProcessSessions | processsession | regardingobjectid_territory |
| Territory_SyncErrors | syncerror | regardingobjectid_territory_syncerror |
| territory_system_users | systemuser | territoryid |
Operations
The following operations can be used with the territory entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| UpdateMultiple | Not Bound |