customapi EntityType
Entity that defines a custom API
- Entity set path:
- [organization URI]/api/data/v9.2/customapis
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Custom API
- Primary key:
- customapiid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allowedcustomprocessingsteptype | Edm.Int32 |
The type of custom processing step allowed Display name: Allowed Custom Processing Step Type
Default options
|
||||||||||
| bindingtype | Edm.Int32 |
The binding type of the custom API Display name: Binding Type
Default options
|
||||||||||
| boundentitylogicalname | Edm.String |
The logical name of the entity bound to the custom API Display name: Bound Entity Logical Name |
||||||||||
| componentidunique | Edm.Guid |
For internal use only. Display name: Row id unique Read only
|
||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||
| customapiid | Edm.Guid |
Unique identifier for custom API instances Display name: Custom API |
||||||||||
| description | Edm.String |
Localized description for custom API instances Display name: Description |
||||||||||
| displayname | Edm.String |
Localized display name for custom API instances Display name: Display Name |
||||||||||
| executeprivilegename | Edm.String |
Name of the privilege that allows execution of the custom API Display name: Execute Privilege Name |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display name: Is Customizable |
||||||||||
| isfunction | Edm.Boolean |
Indicates if the custom API is a function (GET is supported) or not (POST is supported) Display name: Is Function
Default options
|
||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||
| isprivate | Edm.Boolean |
Indicates if the custom API is private (hidden from metadata and documentation) Display name: Is Private
Default options
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||
| name | Edm.String |
The primary name of the custom API Display name: Name |
||||||||||
| 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
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Custom API Display name: Status
Default options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Custom API Display name: Status Reason
Default options
|
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||
| uniquename | Edm.String |
Unique name for the custom API Display name: Unique Name |
||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
||||||||||
| workflowsdkstepenabled | Edm.Boolean |
Indicates if the custom API is enabled as a workflow action Display name: Enabled for Workflow
Default options
|
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 Lookup property data.
| 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. |
| _fxexpressionid_value | fxexpression |
Unique identifier for fxexpression associated with Custom API. |
| _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. |
| _plugintypeid_value | PluginTypeId | |
| _powerfxruleid_value | powerfxrule |
Unique identifier for powerfxrule associated with Custom API. |
| _sdkmessageid_value | SdkMessageId |
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_customapi_createdby |
| createdonbehalfby | systemuser | lk_customapi_createdonbehalfby |
| fxexpression | fxexpression | fxexpression_customapi |
| modifiedby | systemuser | lk_customapi_modifiedby |
| modifiedonbehalfby | systemuser | lk_customapi_modifiedonbehalfby |
| ownerid | principal | owner_customapi |
| owningbusinessunit | businessunit | business_unit_customapi |
| owningteam | team | team_customapi |
| owninguser | systemuser | user_customapi |
| PluginTypeId | plugintype | CustomAPIId |
| powerfxrule | powerfxrule | powerfxrule_customapi |
| SdkMessageId | sdkmessage | CustomAPIId |
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 |
|---|---|---|
| AIPluginOperation_CustomAPI_CustomAPI | aipluginoperation | CustomAPI |
| CatalogAssignments | catalogassignment | CustomAPIId |
| customapi_AsyncOperations | asyncoperation | regardingobjectid_customapi |
| customapi_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_customapi |
| customapi_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_customapi |
| customapi_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_customapi |
| customapi_ProcessSession | processsession | regardingobjectid_customapi |
| customapi_serviceplanmapping | serviceplanmapping | CustomAPI |
| customapi_SyncErrors | syncerror | regardingobjectid_customapi |
| CustomAPIRequestParameters | customapirequestparameter | CustomAPIId |
| CustomAPIResponseProperties | customapiresponseproperty | CustomAPIId |
| fabricaiskill_customapiid | fabricaiskill | CustomApiId |
| msdyn_customapi_msdyn_pmbusinessruleautomationconfig_CustomApiId | msdyn_pmbusinessruleautomationconfig | CustomApiId |
| msdyn_knowledgeassetconfiguration_customapiid | msdyn_knowledgeassetconfiguration | msdyn_customapiid |
Operations
The following operations can be used with the customapi entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |