CustomAPIResponseProperty table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Entity that defines a response property for a custom API
Added by: Custom API Framework Solution
Messages
Message | Web API Operation | SDK class or method |
---|---|---|
Create | POST /customapiresponseproperties See Create |
CreateRequest or Create |
Delete | DELETE /customapiresponseproperties(customapiresponsepropertyid) See Delete |
DeleteRequest or Delete |
Retrieve | GET /customapiresponseproperties(customapiresponsepropertyid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveMultiple | GET /customapiresponseproperties See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
Update | PATCH /customapiresponseproperties(customapiresponsepropertyid) See Update |
UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | CustomAPIResponseProperties |
DisplayCollectionName | Custom API Response Properties |
DisplayName | Custom API Response Property |
EntitySetName | customapiresponseproperties |
IsBPFEntity | False |
LogicalCollectionName | customapiresponseproperties |
LogicalName | customapiresponseproperty |
OwnershipType | None |
PrimaryIdAttribute | customapiresponsepropertyid |
PrimaryNameAttribute | name |
SchemaName | CustomAPIResponseProperty |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CustomAPIId
- CustomAPIResponsePropertyId
- Description
- DisplayName
- ImportSequenceNumber
- IsCustomizable
- LogicalEntityName
- Name
- OverriddenCreatedOn
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- Type
- UniqueName
- UTCConversionTimeZoneCode
CustomAPIId
Property | Value |
---|---|
Description | Unique identifier for the custom API that owns this custom API response property |
DisplayName | Custom API |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | customapiid |
RequiredLevel | SystemRequired |
Targets | customapi |
Type | Lookup |
CustomAPIResponsePropertyId
Property | Value |
---|---|
Description | Unique identifier for custom API response property instances |
DisplayName | Custom API Response Property |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | customapiresponsepropertyid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Description
Property | Value |
---|---|
Description | Localized description for custom API response property instances |
DisplayName | Description |
FormatName | Text |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
DisplayName
Property | Value |
---|---|
Description | Localized display name for custom API response property instances |
DisplayName | Display Name |
FormatName | Text |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | displayname |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
ImportSequenceNumber
Added by: Basic Solution Solution
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 |
IsCustomizable
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Is Customizable |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | iscustomizable |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
LogicalEntityName
Property | Value |
---|---|
Description | The logical name of the entity bound to the custom API response property |
DisplayName | Bound Entity Logical Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | logicalentityname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Name
Property | Value |
---|---|
Description | The primary name of the custom API response property |
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 |
statecode
Property | Value |
---|---|
Description | Status of the Custom API Response Property |
DisplayName | Status |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
statecode Choices/Options
Value | Label | DefaultStatus | InvariantName |
---|---|---|---|
0 | Active | 1 | Active |
1 | Inactive | 2 | Inactive |
statuscode
Property | Value |
---|---|
Description | Reason for the status of the Custom API Response Property |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
statuscode Choices/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 |
Type
Property | Value |
---|---|
Description | The data type of the custom API response property |
DisplayName | Type |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | type |
RequiredLevel | SystemRequired |
Type | Picklist |
Type Choices/Options
Value | Label | Description |
---|---|---|
0 | Boolean | |
1 | DateTime | |
2 | Decimal | |
3 | Entity | |
4 | EntityCollection | |
5 | EntityReference | |
6 | Float | |
7 | Integer | |
8 | Money | |
9 | Picklist | |
10 | String | |
11 | StringArray | |
12 | Guid |
UniqueName
Property | Value |
---|---|
Description | Unique name for the custom API response property |
DisplayName | Unique Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | uniquename |
MaxLength | 128 |
RequiredLevel | SystemRequired |
Type | String |
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 columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- CustomAPIIdName
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OverwriteTime
- OwnerId
- OwnerIdType
- OwningBusinessUnit
- OwningTeam
- OwningUser
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Row id unique |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
ComponentState
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
0 | Published | |
1 | Unpublished | |
2 | Deleted | |
3 | Deleted Unpublished |
CreatedBy
Added by: Active Solution Solution
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
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByYomiName
Added by: Active Solution Solution
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
Added by: Active Solution Solution
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
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOnBehalfByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
CustomAPIIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | customapiidname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
IsManaged
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | Indicates whether the solution component is part of a managed solution. |
DisplayName | Is Managed |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ismanaged |
RequiredLevel | SystemRequired |
Type | Boolean |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
ModifiedBy
Added by: Active Solution Solution
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
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByYomiName
Added by: Active Solution Solution
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
Added by: Active Solution Solution
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
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOnBehalfByYomiName
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
OverwriteTime
Added by: Basic Solution Solution
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | For internal use only. |
DisplayName | Record Overwrite Time |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
OwnerId
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Owner Id |
DisplayName | Owner |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | ownerid |
RequiredLevel | SystemRequired |
Targets | systemuser,team |
Type | Owner |
OwnerIdType
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Owner Id Type |
DisplayName | Owner Id Type |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridtype |
RequiredLevel | SystemRequired |
Type | EntityName |
OwningBusinessUnit
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier for the business unit that owns the record |
DisplayName | Owning Business Unit |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owningbusinessunit |
RequiredLevel | None |
Targets | businessunit |
Type | Lookup |
OwningTeam
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier for the team that owns the record. |
DisplayName | Owning Team |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owningteam |
RequiredLevel | None |
Targets | team |
Type | Lookup |
OwningUser
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier for the user that owns the record. |
DisplayName | Owning User |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owninguser |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
SolutionId
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | Unique identifier of the associated solution. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | solutionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
SupportingSolutionId
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | supportingsolutionid |
RequiredLevel | None |
Type | Uniqueidentifier |
VersionNumber
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- customapiresponseproperty_SyncErrors
- customapiresponseproperty_AsyncOperations
- customapiresponseproperty_MailboxTrackingFolders
- customapiresponseproperty_ProcessSession
- customapiresponseproperty_BulkDeleteFailures
- customapiresponseproperty_PrincipalObjectAttributeAccesses
customapiresponseproperty_SyncErrors
Added by: System Solution Solution
Same as the customapiresponseproperty_SyncErrors many-to-one relationship for the syncerror table/entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
customapiresponseproperty_AsyncOperations
Added by: System Solution Solution
Same as the customapiresponseproperty_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
customapiresponseproperty_MailboxTrackingFolders
Added by: System Solution Solution
Same as the customapiresponseproperty_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_MailboxTrackingFolders |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
customapiresponseproperty_ProcessSession
Added by: System Solution Solution
Same as the customapiresponseproperty_ProcessSession many-to-one relationship for the processsession table/entity.
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_ProcessSession |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
customapiresponseproperty_BulkDeleteFailures
Added by: System Solution Solution
Same as the customapiresponseproperty_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
customapiresponseproperty_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the customapiresponseproperty_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | customapiresponseproperty_PrincipalObjectAttributeAccesses |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
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 table. Listed by SchemaName.
- lk_customapiresponseproperty_createdby
- lk_customapiresponseproperty_createdonbehalfby
- lk_customapiresponseproperty_modifiedby
- lk_customapiresponseproperty_modifiedonbehalfby
- customapi_customapiresponseproperty
lk_customapiresponseproperty_createdby
Added by: System Solution Solution
See the lk_customapiresponseproperty_createdby one-to-many relationship for the systemuser table/entity.
lk_customapiresponseproperty_createdonbehalfby
Added by: System Solution Solution
See the lk_customapiresponseproperty_createdonbehalfby one-to-many relationship for the systemuser table/entity.
lk_customapiresponseproperty_modifiedby
Added by: System Solution Solution
See the lk_customapiresponseproperty_modifiedby one-to-many relationship for the systemuser table/entity.
lk_customapiresponseproperty_modifiedonbehalfby
Added by: System Solution Solution
See the lk_customapiresponseproperty_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
customapi_customapiresponseproperty
See the customapi_customapiresponseproperty one-to-many relationship for the customapi table/entity.
See also
Dataverse table/entity reference
Web API Reference
customapiresponseproperty EntityType
Feedback
https://aka.ms/ContentUserFeedback.
În curând: Pe parcursul anului 2024, vom elimina treptat Probleme legate de GitHub ca mecanism de feedback pentru conținut și îl vom înlocui cu un nou sistem de feedback. Pentru mai multe informații, consultați:Trimiteți și vizualizați feedback pentru