environmentvariabledefinition EntityType

Contains information about the settable variable: its type, default value, and etc.

Entity Set Path
[organization URI]/api/data/v9.0/environmentvariabledefinitions
Base Type
crmbaseentity
Display Name
Environment Variable Definition
Primary Key
environmentvariabledefinitionid
Primary Key Attribute
schemaname
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
defaultvalue Edm.String

Default variable value to be used if no associated EnvironmentVariableValue entities exist.

Display Name: Default Value

description Edm.String

Description of the variable definition.

Display Name: Description

displayname Edm.String

Display Name of the variable definition.

Display Name: Display Name

environmentvariabledefinitionid Edm.Guid

Unique identifier for entity instances

Display Name: Environment Variable Definition

environmentvariabledefinitionidunique Edm.Guid

For internal use only.

Read Only
hint Edm.String

For internal use only.

Display Name: Hint

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable BooleanManagedProperty

Tells whether the component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
isrequired Edm.Boolean

For internal use only.

Display Name: Is Required

Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
schemaname Edm.String

Unique entity name.

Display Name: Schema Name

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Environment Variable Definition

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Environment Variable Definition

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

type Edm.Int32

Environment variable value type.

Display Name: Type

Default Options
Value Label
100000000 String
100000001 Number
100000002 Boolean
100000003 JSON
100000004 Connection reference
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

valueschema Edm.String

For internal use only.

Display Name: Value Schema

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

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

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_environmentvariabledefinition_createdby
createdonbehalfby systemuser lk_environmentvariabledefinition_createdonbehalfby
modifiedby systemuser lk_environmentvariabledefinition_modifiedby
modifiedonbehalfby systemuser lk_environmentvariabledefinition_modifiedonbehalfby
ownerid principal owner_environmentvariabledefinition
owningbusinessunit businessunit business_unit_environmentvariabledefinition
owningteam team team_environmentvariabledefinition
owninguser systemuser user_environmentvariabledefinition

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
environmentvariabledefinition_AsyncOperations asyncoperation regardingobjectid_environmentvariabledefinition
environmentvariabledefinition_BulkDeleteFailures bulkdeletefailure regardingobjectid_environmentvariabledefinition
environmentvariabledefinition_DuplicateBaseRecord duplicaterecord baserecordid_environmentvariabledefinition
environmentvariabledefinition_DuplicateMatchingRecord duplicaterecord duplicaterecordid_environmentvariabledefinition
environmentvariabledefinition_environmentvariablevalue environmentvariablevalue EnvironmentVariableDefinitionId
environmentvariabledefinition_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_environmentvariabledefinition
environmentvariabledefinition_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_environmentvariabledefinition
environmentvariabledefinition_ProcessSession processsession regardingobjectid_environmentvariabledefinition
environmentvariabledefinition_SyncErrors syncerror regardingobjectid_environmentvariabledefinition

Operations

The following operations can be used with the environmentvariabledefinition entity type.

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the environmentvariabledefinition entity type.

Name Description
Environment Variables

See also