customapi EntityType

Entity that defines a custom API

Entity Set Path
[organization URI]/api/data/v9.0/customapis
Base Type
crmbaseentity
Display Name
Custom API
Primary Key
customapiid
Primary Key Attribute
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
Value Label
0 None
1 Async Only
2 Sync and Async
bindingtype Edm.Int32

The binding type of the custom API

Display Name: Binding Type

Default Options
Value Label
0 Global
1 Entity
2 Entity Collection
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
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
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
Value Label
1 Yes
0 No
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
isprivate Edm.Boolean

Indicates if the custom API is private (hidden from metadata and documentation)

Display Name: Is Private

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
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
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Custom API

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

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
Value Label
1 Yes
0 No

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.

_plugintypeid_value PluginTypeId
_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
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
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
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_SyncErrors syncerror regardingobjectid_customapi
CustomAPIRequestParameters customapirequestparameter CustomAPIId
CustomAPIResponseProperties customapiresponseproperty CustomAPIId

Operations

The following operations can be used with the customapi 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 customapi entity type.

Name Description
Custom API Framework

See also