Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Entity that defines a custom API
Messages
The following table lists the messages for the Custom API (CustomAPI) table. Messages represent operations that can be performed on the table. They may also be events.
| Name Is Event? |
Web API Operation | SDK for .NET |
|---|---|---|
AssignEvent: True |
PATCH /customapis(customapiid)Update the ownerid property. |
AssignRequest |
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /customapisSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /customapis(customapiid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
GrantAccessEvent: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccessEvent: True |
ModifyAccess | ModifyAccessRequest |
RetrieveEvent: True |
GET /customapis(customapiid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /customapisSee Query data |
Query data |
RetrievePrincipalAccessEvent: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccessEvent: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccessEvent: True |
RevokeAccess | RevokeAccessRequest |
SetStateEvent: True |
PATCH /customapis(customapiid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /customapis(customapiid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /customapis(customapiid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Properties
The following table lists selected properties for the Custom API (CustomAPI) table.
| Property | Value |
|---|---|
| DisplayName | Custom API |
| DisplayCollectionName | Custom APIs |
| SchemaName | CustomAPI |
| CollectionSchemaName | CustomAPIs |
| EntitySetName | customapis |
| LogicalName | customapi |
| LogicalCollectionName | customapis |
| PrimaryIdAttribute | customapiid |
| PrimaryNameAttribute | name |
| TableType | Standard |
| OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AllowedCustomProcessingStepType
- BindingType
- BoundEntityLogicalName
- CustomAPIId
- Description
- DisplayName
- ExecutePrivilegeName
- FxExpressionId
- ImportSequenceNumber
- IsCustomizable
- IsFunction
- IsPrivate
- Name
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- PluginTypeId
- PowerfxRuleId
- SdkMessageId
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UniqueName
- UTCConversionTimeZoneCode
- WorkflowSdkStepEnabled
AllowedCustomProcessingStepType
| Property | Value |
|---|---|
| Description | The type of custom processing step allowed |
| DisplayName | Allowed Custom Processing Step Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | allowedcustomprocessingsteptype |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | 0 |
| GlobalChoiceName | customapi_allowedcustomprocessingsteptype |
AllowedCustomProcessingStepType Choices/Options
| Value | Label |
|---|---|
| 0 | None |
| 1 | Async Only |
| 2 | Sync and Async |
BindingType
| Property | Value |
|---|---|
| Description | The binding type of the custom API |
| DisplayName | Binding Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | bindingtype |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | 0 |
| GlobalChoiceName | customapi_bindingtype |
BindingType Choices/Options
| Value | Label |
|---|---|
| 0 | Global |
| 1 | Entity |
| 2 | Entity Collection |
BoundEntityLogicalName
| Property | Value |
|---|---|
| Description | The logical name of the entity bound to the custom API |
| DisplayName | Bound Entity Logical Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | boundentitylogicalname |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
CustomAPIId
| Property | Value |
|---|---|
| Description | Unique identifier for custom API instances |
| DisplayName | Custom API |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | customapiid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Description
| Property | Value |
|---|---|
| Description | Localized description for custom API instances |
| DisplayName | Description |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | description |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | True |
| MaxLength | 300 |
DisplayName
| Property | Value |
|---|---|
| Description | Localized display name for custom API instances |
| DisplayName | Display Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | displayname |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | True |
| MaxLength | 100 |
ExecutePrivilegeName
| Property | Value |
|---|---|
| Description | Name of the privilege that allows execution of the custom API |
| DisplayName | Execute Privilege Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | executeprivilegename |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
FxExpressionId
| Property | Value |
|---|---|
| Description | Unique identifier for fxexpression associated with Custom API. |
| DisplayName | FxExpression |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | fxexpressionid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | fxexpression |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Sequence number of the import that created this record. |
| DisplayName | Import Sequence Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | importsequencenumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
IsCustomizable
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Is Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
IsFunction
| Property | Value |
|---|---|
| Description | Indicates if the custom API is a function (GET is supported) or not (POST is supported) |
| DisplayName | Is Function |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | isfunction |
| RequiredLevel | SystemRequired |
| Type | Boolean |
| GlobalChoiceName | customapi_isfunction |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
IsPrivate
| Property | Value |
|---|---|
| Description | Indicates if the custom API is private (hidden from metadata and documentation) |
| DisplayName | Is Private |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | isprivate |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | customapi_isprivate |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
Name
| Property | Value |
|---|---|
| Description | The primary name of the custom API |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OverriddenCreatedOn
| Property | Value |
|---|---|
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateOnly |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
OwnerId
| Property | Value |
|---|---|
| Description | Owner Id |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Type | Owner |
| Targets | systemuser, team |
OwnerIdType
| Property | Value |
|---|---|
| Description | Owner Id Type |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
PluginTypeId
| Property | Value |
|---|---|
| Description | |
| DisplayName | Plugin Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | plugintypeid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | plugintype |
PowerfxRuleId
| Property | Value |
|---|---|
| Description | Unique identifier for powerfxrule associated with Custom API. |
| DisplayName | PowerFx Rule |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | powerfxruleid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | powerfxrule |
SdkMessageId
| Property | Value |
|---|---|
| Description | |
| DisplayName | Sdk Message |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | sdkmessageid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | sdkmessage |
statecode
| Property | Value |
|---|---|
| Description | Status of the Custom API |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | customapi_statecode |
statecode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Custom API |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | customapi_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
UniqueName
| Property | Value |
|---|---|
| Description | Unique name for the custom API |
| DisplayName | Unique Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | uniquename |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 128 |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
WorkflowSdkStepEnabled
| Property | Value |
|---|---|
| Description | Indicates if the custom API is enabled as a workflow action |
| DisplayName | Enabled for Workflow |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | workflowsdkstepenabled |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | customapi_workflowsdkstepenabled |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OverwriteTime
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | |
| GlobalChoiceName | componentstate |
ComponentState Choices/Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
CreatedOn
| Property | Value |
|---|---|
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
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 |
| Type | Lookup |
| Targets | systemuser |
IsManaged
| 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 |
| GlobalChoiceName | ismanaged |
| DefaultValue | False |
| True Label | Managed |
| False Label | Unmanaged |
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ModifiedOn
| Property | Value |
|---|---|
| Description | Date and time when the record was modified. |
| DisplayName | Modified On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
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 |
| Type | Lookup |
| Targets | systemuser |
OverwriteTime
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
OwnerIdName
| Property | Value |
|---|---|
| Description | Name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | Yomi name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Unique identifier for the business unit that owns the record |
| DisplayName | Owning Business Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Type | Lookup |
| Targets | businessunit |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier for the team that owns the record. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Type | Lookup |
| Targets | team |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier for the user that owns the record. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
VersionNumber
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| RequiredLevel | None |
| Type | BigInt |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- business_unit_customapi
- fxexpression_customapi
- lk_customapi_createdby
- lk_customapi_createdonbehalfby
- lk_customapi_modifiedby
- lk_customapi_modifiedonbehalfby
- owner_customapi
- plugintype_customapi
- powerfxrule_customapi
- sdkmessage_customapi
- team_customapi
- user_customapi
business_unit_customapi
One-To-Many Relationship: businessunit business_unit_customapi
| Property | Value |
|---|---|
| ReferencedEntity | businessunit |
| ReferencedAttribute | businessunitid |
| ReferencingAttribute | owningbusinessunit |
| ReferencingEntityNavigationPropertyName | owningbusinessunit |
| IsHierarchical | |
| CascadeConfiguration | Archive: RestrictAssign: NoCascadeDelete: RestrictMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
fxexpression_customapi
One-To-Many Relationship: fxexpression fxexpression_customapi
| Property | Value |
|---|---|
| ReferencedEntity | fxexpression |
| ReferencedAttribute | fxexpressionid |
| ReferencingAttribute | fxexpressionid |
| ReferencingEntityNavigationPropertyName | fxexpression |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: RemoveLinkMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_customapi_createdby
One-To-Many Relationship: systemuser lk_customapi_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_customapi_createdonbehalfby
One-To-Many Relationship: systemuser lk_customapi_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_customapi_modifiedby
One-To-Many Relationship: systemuser lk_customapi_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_customapi_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_customapi_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
owner_customapi
One-To-Many Relationship: owner owner_customapi
| Property | Value |
|---|---|
| ReferencedEntity | owner |
| ReferencedAttribute | ownerid |
| ReferencingAttribute | ownerid |
| ReferencingEntityNavigationPropertyName | ownerid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
plugintype_customapi
One-To-Many Relationship: plugintype plugintype_customapi
| Property | Value |
|---|---|
| ReferencedEntity | plugintype |
| ReferencedAttribute | plugintypeid |
| ReferencingAttribute | plugintypeid |
| ReferencingEntityNavigationPropertyName | PluginTypeId |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: RemoveLinkMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
powerfxrule_customapi
One-To-Many Relationship: powerfxrule powerfxrule_customapi
| Property | Value |
|---|---|
| ReferencedEntity | powerfxrule |
| ReferencedAttribute | powerfxruleid |
| ReferencingAttribute | powerfxruleid |
| ReferencingEntityNavigationPropertyName | powerfxrule |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: RemoveLinkMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
sdkmessage_customapi
One-To-Many Relationship: sdkmessage sdkmessage_customapi
| Property | Value |
|---|---|
| ReferencedEntity | sdkmessage |
| ReferencedAttribute | sdkmessageid |
| ReferencingAttribute | sdkmessageid |
| ReferencingEntityNavigationPropertyName | SdkMessageId |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: RemoveLinkMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
team_customapi
One-To-Many Relationship: team team_customapi
| Property | Value |
|---|---|
| ReferencedEntity | team |
| ReferencedAttribute | teamid |
| ReferencingAttribute | owningteam |
| ReferencingEntityNavigationPropertyName | owningteam |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
user_customapi
One-To-Many Relationship: systemuser user_customapi
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | owninguser |
| ReferencingEntityNavigationPropertyName | owninguser |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- AIPluginOperation_CustomAPI_CustomAPI
- catalogassignment_customapi
- customapi_AsyncOperations
- customapi_BulkDeleteFailures
- customapi_customapirequestparameter
- customapi_customapiresponseproperty
- customapi_MailboxTrackingFolders
- customapi_msdyn_function_customapi
- customapi_plugin_CustomAPI
- customapi_PrincipalObjectAttributeAccesses
- customapi_ProcessSession
- customapi_serviceplanmapping
- customapi_SyncErrors
- fabricaiskill_customapiid
- msdyn_customapi_msdyn_pmbusinessruleautomationconfig_CustomApiId
- msdyn_formmapping_customapiid
- msdyn_knowledgeassetconfiguration_customapiid
AIPluginOperation_CustomAPI_CustomAPI
Many-To-One Relationship: aipluginoperation AIPluginOperation_CustomAPI_CustomAPI
| Property | Value |
|---|---|
| ReferencingEntity | aipluginoperation |
| ReferencingAttribute | customapi |
| ReferencedEntityNavigationPropertyName | AIPluginOperation_CustomAPI_CustomAPI |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
catalogassignment_customapi
Many-To-One Relationship: catalogassignment catalogassignment_customapi
| Property | Value |
|---|---|
| ReferencingEntity | catalogassignment |
| ReferencingAttribute | object |
| ReferencedEntityNavigationPropertyName | CatalogAssignments |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_AsyncOperations
Many-To-One Relationship: asyncoperation customapi_AsyncOperations
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | customapi_AsyncOperations |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure customapi_BulkDeleteFailures
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | customapi_BulkDeleteFailures |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_customapirequestparameter
Many-To-One Relationship: customapirequestparameter customapi_customapirequestparameter
| Property | Value |
|---|---|
| ReferencingEntity | customapirequestparameter |
| ReferencingAttribute | customapiid |
| ReferencedEntityNavigationPropertyName | CustomAPIRequestParameters |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_customapiresponseproperty
Many-To-One Relationship: customapiresponseproperty customapi_customapiresponseproperty
| Property | Value |
|---|---|
| ReferencingEntity | customapiresponseproperty |
| ReferencingAttribute | customapiid |
| ReferencedEntityNavigationPropertyName | CustomAPIResponseProperties |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder customapi_MailboxTrackingFolders
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | customapi_MailboxTrackingFolders |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_msdyn_function_customapi
Many-To-One Relationship: msdyn_function customapi_msdyn_function_customapi
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_function |
| ReferencingAttribute | customapi |
| ReferencedEntityNavigationPropertyName | customapi_msdyn_function_customapi |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_plugin_CustomAPI
Many-To-One Relationship: plugin customapi_plugin_CustomAPI
| Property | Value |
|---|---|
| ReferencingEntity | plugin |
| ReferencingAttribute | customapi |
| ReferencedEntityNavigationPropertyName | customapi_plugin_CustomAPI |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess customapi_PrincipalObjectAttributeAccesses
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| ReferencedEntityNavigationPropertyName | customapi_PrincipalObjectAttributeAccesses |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_ProcessSession
Many-To-One Relationship: processsession customapi_ProcessSession
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | customapi_ProcessSession |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_serviceplanmapping
Many-To-One Relationship: serviceplanmapping customapi_serviceplanmapping
| Property | Value |
|---|---|
| ReferencingEntity | serviceplanmapping |
| ReferencingAttribute | customapi |
| ReferencedEntityNavigationPropertyName | customapi_serviceplanmapping |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
customapi_SyncErrors
Many-To-One Relationship: syncerror customapi_SyncErrors
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | customapi_SyncErrors |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
fabricaiskill_customapiid
Many-To-One Relationship: fabricaiskill fabricaiskill_customapiid
| Property | Value |
|---|---|
| ReferencingEntity | fabricaiskill |
| ReferencingAttribute | customapiid |
| ReferencedEntityNavigationPropertyName | fabricaiskill_customapiid |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_customapi_msdyn_pmbusinessruleautomationconfig_CustomApiId
Many-To-One Relationship: msdyn_pmbusinessruleautomationconfig msdyn_customapi_msdyn_pmbusinessruleautomationconfig_CustomApiId
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_pmbusinessruleautomationconfig |
| ReferencingAttribute | customapiid |
| ReferencedEntityNavigationPropertyName | msdyn_customapi_msdyn_pmbusinessruleautomationconfig_CustomApiId |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_formmapping_customapiid
Many-To-One Relationship: msdyn_formmapping msdyn_formmapping_customapiid
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_formmapping |
| ReferencingAttribute | customapiid |
| ReferencedEntityNavigationPropertyName | msdyn_formmapping_customapiid |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
msdyn_knowledgeassetconfiguration_customapiid
Many-To-One Relationship: msdyn_knowledgeassetconfiguration msdyn_knowledgeassetconfiguration_customapiid
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_knowledgeassetconfiguration |
| ReferencingAttribute | msdyn_customapiid |
| ReferencedEntityNavigationPropertyName | msdyn_knowledgeassetconfiguration_customapiid |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
customapi