dynamicproperty EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Information about a product property.

Entity Set path:[organization URI]/api/data/v8.2/dynamicproperties

Base Type: crmbaseentity EntityType

Display Name: Property

Primary Key: dynamicpropertyid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations using the dynamicproperty entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created.

Display Name: Created On

Read-only property

datatype

Edm.Int32

Description: Select the data type of the property.

Default Options:

0 : Option Set
1 : Decimal
2 : Floating Point Number
3 : Single Line Of Text
4 : Whole Number

Display Name: Data Type

defaultvaluedecimal

Edm.Decimal

Description: Shows the default value of the property for a decimal data type.

Display Name: Default Decimal Value

defaultvaluedouble

Edm.Double

Description: Shows the default value of the property for a double data type.

Display Name: Default Double Value

defaultvalueinteger

Edm.Int32

Description: Shows the default value of the property for a whole number data type.

Display Name: Default Whole Number Value

defaultvaluestring

Edm.String

Description: Shows the default value of the property for a string data type.

Display Name: Default String Value

description

Edm.String

Description: Type a description for the property.

Display Name: Description

dmtimportstate

Edm.Int32

Description: Internal Use Only

Display Name: Internal Use Only

dynamicpropertyid

Edm.Guid

Description: Shows the unique identifier of the property.

Display Name: Property ID

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this property.

Display Name: Import Sequence Number

ishidden

Edm.Boolean

Description: Defines whether the attribute is hidden or shown.

Default Options:

1 : Yes
0 : No

Display Name: Hidden

isreadonly

Edm.Boolean

Description: Defines whether the attribute is read-only or if it can be edited.

Default Options:

1 : Yes
0 : No

Display Name: Read-Only

isrequired

Edm.Boolean

Description: Defines whether the attribute is mandatory.

Default Options:

1 : Yes
0 : No

Display Name: Required

maxlengthstring

Edm.Int32

Description: Shows the maximum allowed length of the property for a string data type.

Display Name: Maximum String Length

maxvaluedecimal

Edm.Decimal

Description: Shows the maximum allowed value of the property for a decimal data type.

Display Name: Maximum Decimal Value

maxvaluedouble

Edm.Double

Description: Shows the maximum allowed value of the property for a double data type.

Display Name: Maximum Double Value

maxvalueinteger

Edm.Int32

Description: Shows the maximum allowed value of the property for a whole number data type.

Display Name: Maximum Whole Number Value

minvaluedecimal

Edm.Decimal

Description: Shows the minimum allowed value of the property for a decimal data type.

Display Name: Minimum Decimal Value

minvaluedouble

Edm.Double

Description: Shows the minimum allowed value of the property for a double data type.

Display Name: Minimum Double Value

minvalueinteger

Edm.Int32

Description: Shows the minimum allowed value of the property for a whole number data type.

Display Name: Minimum Whole Number Value

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Type the name of the property.

Display Name: Name

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the attribute was migrated.

Display Name: Attribute Created On

overwrittendynamicpropertyid

Edm.Guid

Description: Shows the related overwritten property.

Display Name: Overwritten Property

precision

Edm.Int32

Description: Shows the allowed precision of the property for a whole number data type.

Display Name: Precision

rootdynamicpropertyid

Edm.Guid

Description: Shows the root property that this property is derived from.

Display Name: Root Property

statecode

Edm.Int32

Description: Shows the state of the property.

Default Options:

0 : Active
1 : Draft
2 : Retired

Display Name: Status

statuscode

Edm.Int32

Description: Shows whether the property is active or inactive.

Default Options:

1 : Active
0 : Draft
2 : Retired

Display Name: Status Reason

versionnumber

Edm.Int64

Description: Version number of the property.

Display Name: Version Number

Read-only property

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 Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_basedynamicpropertyid_value

basedynamicpropertyid

Shows the property in the product family that this property is being inherited from.

_createdby_value

createdby

Shows who created the record.

_createdonbehalfby_value

createdonbehalfby

Shows who created the record on behalf of another user.

_defaultvalueoptionset_value

dynamicpropertyoptionsetvalueid

Shows the default value of the property.

_modifiedby_value

modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value

modifiedonbehalfby

Shows who created the record on behalf of another user.

_organizationid_value

organizationid

Unique identifier of the organization associated with the property.

_regardingobjectid_value

regardingobjectid_productassociation

regardingobjectid_product

Choose the product that the property is associated with.

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

basedynamicpropertyid

dynamicproperty EntityType

dynamicproperty_base_dynamicproperty

createdby

systemuser EntityType

lk_DynamicProperty_createdby

createdonbehalfby

systemuser EntityType

lk_DynamicProperty_createdonbehalfby

dynamicpropertyoptionsetvalueid

dynamicpropertyoptionsetitem EntityType

DefaultValueOptionSet_DynamicProperty

modifiedby

systemuser EntityType

lk_DynamicProperty_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_DynamicProperty_modifiedonbehalfby

organizationid

organization EntityType

dynamicproperty_organization

regardingobjectid_product

product EntityType

Product_DynamicProperty

regardingobjectid_productassociation

productassociation EntityType

ProductAssociation_DynamicProperty

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

dynamicproperty_base_dynamicproperty

dynamicproperty EntityType

basedynamicpropertyid

Dynamicproperty_DynamicPropertyAssociation

dynamicpropertyassociation EntityType

dynamicpropertyid

DynamicProperty_DynamicPropertyInstance

dynamicpropertyinstance EntityType

dynamicpropertyid

DynamicProperty_DynamicPropertyOptionSetItem

dynamicpropertyoptionsetitem EntityType

dynamicpropertyid

Operations using the dynamicproperty entity type.

The following operations use the dynamicproperty entity type in a parameter or return type.

Name

How used

Description

RetrieveProductProperties Function

ReturnType

Retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright