Position Entity Reference

Position of a user in the hierarchy

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/positions
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/positions(positionid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/positions(positionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/positions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/positions(positionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/positions(positionid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Positions
DisplayCollectionName Positions
DisplayName Position
EntitySetName positions
IsBPFEntity False
LogicalCollectionName positions
LogicalName position
OwnershipType OrganizationOwned
PrimaryIdAttribute positionid
PrimaryNameAttribute name
SchemaName Position

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Description

Property Value
Description The description of the position.
DisplayName Description
FormatName TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 100
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Name

Property Value
Description The name of the position.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

ParentPositionId

Property Value
Description Parent position.
DisplayName Parent Position
IsValidForForm True
IsValidForRead True
LogicalName parentpositionid
RequiredLevel None
Targets position
Type Lookup

PositionId

Property Value
Description Unique identifier for position entity instances
DisplayName Position
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName positionid
RequiredLevel SystemRequired
Type Uniqueidentifier

statecode

Property Value
Description Status of the Position
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Reason for the status of the Position
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Unique identifier of the currency associated with the position.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the position with respect to the base currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ParentPositionIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentpositionidname
MaxLength 100
RequiredLevel None
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

position_AsyncOperations

Same as asyncoperation entity position_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName position_AsyncOperations
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

position_ProcessSession

Same as processsession entity position_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName position_ProcessSession
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

position_users

Same as systemuser entity position_users Many-To-One relationship.

Property Value
ReferencingEntity systemuser
ReferencingAttribute positionid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName position_users
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

position_parent_position

Same as position entity position_parent_position Many-To-One relationship.

Property Value
ReferencingEntity position
ReferencingAttribute parentpositionid
IsHierarchical True
IsCustomizable False
ReferencedEntityNavigationPropertyName position_parent_position
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Position_SyncErrors

Same as syncerror entity Position_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Position_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

position_connection2

Same as connection entity position_connection2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName position_connection2
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

position_principalobjectattributeaccess

Same as principalobjectattributeaccess entity position_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName position_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

position_connection1

Same as connection entity position_connection1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName position_connection1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_position_createdby

See systemuser Entity lk_position_createdby One-To-Many relationship.

lk_position_createdonbehalfby

See systemuser Entity lk_position_createdonbehalfby One-To-Many relationship.

lk_position_modifiedby

See systemuser Entity lk_position_modifiedby One-To-Many relationship.

lk_position_modifiedonbehalfby

See systemuser Entity lk_position_modifiedonbehalfby One-To-Many relationship.

organization_position

See organization Entity organization_position One-To-Many relationship.

position_parent_position

See position Entity position_parent_position One-To-Many relationship.

transactioncurrency_position

See transactioncurrency Entity transactioncurrency_position One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
position EntityType