CustomAPI table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Entity that defines a custom API

Added by: Custom API Framework Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH [org URI]/api/data/v9.2/customapis(customapiid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.2/customapis
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.2/customapis(customapiid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.2/customapis(customapiid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.2/customapis
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.2/customapis(customapiid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.2/customapis(customapiid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName CustomAPIs
DisplayCollectionName Custom APIs
DisplayName Custom API
EntitySetName customapis
IsBPFEntity False
LogicalCollectionName customapis
LogicalName customapi
OwnershipType UserOwned
PrimaryIdAttribute customapiid
PrimaryNameAttribute name
SchemaName CustomAPI

Writable columns/attributes

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

AllowedCustomProcessingStepType

Property Value
Description The type of custom processing step allowed
DisplayName Allowed Custom Processing Step Type
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName allowedcustomprocessingsteptype
RequiredLevel SystemRequired
Type Picklist

AllowedCustomProcessingStepType Choices/Options

Value Label Description
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
IsValidForUpdate False
LogicalName bindingtype
RequiredLevel SystemRequired
Type Picklist

BindingType Choices/Options

Value Label Description
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
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName boundentitylogicalname
MaxLength 100
RequiredLevel None
Type String

CustomAPIId

Property Value
Description Unique identifier for custom API instances
DisplayName Custom API
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName customapiid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Property Value
Description Localized description for custom API instances
DisplayName Description
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 300
RequiredLevel SystemRequired
Type String

DisplayName

Property Value
Description Localized display name for custom API instances
DisplayName Display Name
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName displayname
MaxLength 100
RequiredLevel SystemRequired
Type String

ExecutePrivilegeName

Property Value
Description Name of the privilege that allows execution of the custom API
DisplayName Execute Privilege Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName executeprivilegename
MaxLength 100
RequiredLevel None
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

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
IsValidForUpdate False
LogicalName isfunction
RequiredLevel SystemRequired
Type Boolean

IsFunction Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

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

IsPrivate Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

Name

Property Value
Description The primary name of the custom API
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel SystemRequired
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

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
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
Targets plugintype
Type Lookup

SdkMessageId

Property Value
Description
DisplayName Sdk Message
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName sdkmessageid
RequiredLevel None
Targets sdkmessage
Type Lookup

statecode

Property Value
Description Status of the Custom API
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
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

UniqueName

Property Value
Description Unique name for the custom API
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

WorkflowSdkStepEnabled

Property Value
Description Indicates if the custom API is enabled as a workflow action
DisplayName Enabled for Workflow
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName workflowsdkstepenabled
RequiredLevel None
Type Boolean

WorkflowSdkStepEnabled Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

Read-only columns/attributes

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

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

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

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

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
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

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

PluginTypeIdName

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

SdkMessageIdName

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

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.

customapi_SyncErrors

Added by: System Solution Solution

Same as the customapi_SyncErrors many-to-one relationship for the syncerror table/entity.

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

customapi_AsyncOperations

Added by: System Solution Solution

Same as the customapi_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

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

customapi_MailboxTrackingFolders

Added by: System Solution Solution

Same as the customapi_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

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

customapi_ProcessSession

Added by: System Solution Solution

Same as the customapi_ProcessSession many-to-one relationship for the processsession table/entity.

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

customapi_BulkDeleteFailures

Added by: System Solution Solution

Same as the customapi_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

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

customapi_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the customapi_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

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

customapi_customapirequestparameter

Same as the customapi_customapirequestparameter many-to-one relationship for the customapirequestparameter table/entity.

Property Value
ReferencingEntity customapirequestparameter
ReferencingAttribute customapiid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomAPIRequestParameters
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

customapi_customapiresponseproperty

Same as the customapi_customapiresponseproperty many-to-one relationship for the customapiresponseproperty table/entity.

Property Value
ReferencingEntity customapiresponseproperty
ReferencingAttribute customapiid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CustomAPIResponseProperties
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

catalogassignment_customapi

Added by: CatalogFramework Solution

Same as the catalogassignment_customapi many-to-one relationship for the catalogassignment table/entity.

Property Value
ReferencingEntity catalogassignment
ReferencingAttribute object
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName CatalogAssignments
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
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_customapi_createdby

Added by: System Solution Solution

See the lk_customapi_createdby one-to-many relationship for the systemuser table/entity.

lk_customapi_createdonbehalfby

Added by: System Solution Solution

See the lk_customapi_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_customapi_modifiedby

Added by: System Solution Solution

See the lk_customapi_modifiedby one-to-many relationship for the systemuser table/entity.

lk_customapi_modifiedonbehalfby

Added by: System Solution Solution

See the lk_customapi_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

user_customapi

Added by: System Solution Solution

See the user_customapi one-to-many relationship for the systemuser table/entity.

team_customapi

Added by: System Solution Solution

See the team_customapi one-to-many relationship for the team table/entity.

business_unit_customapi

Added by: System Solution Solution

See the business_unit_customapi one-to-many relationship for the businessunit table/entity.

sdkmessage_customapi

Added by: System Solution Solution

See the sdkmessage_customapi one-to-many relationship for the sdkmessage table/entity.

plugintype_customapi

Added by: System Solution Solution

See the plugintype_customapi one-to-many relationship for the plugintype table/entity.

See also

Dataverse table/entity reference
Web API Reference
customapi EntityType