customapirequestparameter EntityType
Entity that defines a request parameter for a custom API
- Entity Set Path
- [organization URI]/api/data/v9.2/customapirequestparameters
- Base Type
- crmbaseentity
- Display Name
- Custom API Request Parameter
- Primary Key
- customapirequestparameterid
- 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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
|
||||||||||||||||||||||||||||
customapirequestparameterid | Edm.Guid |
Unique identifier for custom API request parameter instances Display Name: Custom API Request Parameter |
||||||||||||||||||||||||||||
description | Edm.String |
Localized description for custom API request parameter instances Display Name: Description |
||||||||||||||||||||||||||||
displayname | Edm.String |
Localized display name for custom API request parameter instances Display Name: Display 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 |
||||||||||||||||||||||||||||
ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display Name: Is Managed Read Only
Default Options
|
||||||||||||||||||||||||||||
isoptional | Edm.Boolean |
Indicates if the custom API request parameter is optional Display Name: Is Optional
Default Options
|
||||||||||||||||||||||||||||
logicalentityname | Edm.String |
The logical name of the entity bound to the custom API request parameter Display Name: Bound Entity Logical Name |
||||||||||||||||||||||||||||
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 request parameter 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 Request Parameter Display Name: Status
Default Options
|
||||||||||||||||||||||||||||
statuscode | Edm.Int32 |
Reason for the status of the Custom API Request Parameter Display Name: Status Reason
Default Options
|
||||||||||||||||||||||||||||
timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||||||||||||||||||||
type | Edm.Int32 |
The data type of the custom API request parameter Display Name: Type
Default Options
|
||||||||||||||||||||||||||||
uniquename | Edm.String |
Unique name for the custom API request parameter 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
|
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. |
_customapiid_value | CustomAPIId |
Unique identifier for the custom API that owns this custom API request parameter |
_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. |
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_customapirequestparameter_createdby |
createdonbehalfby | systemuser | lk_customapirequestparameter_createdonbehalfby |
CustomAPIId | customapi | CustomAPIRequestParameters |
modifiedby | systemuser | lk_customapirequestparameter_modifiedby |
modifiedonbehalfby | systemuser | lk_customapirequestparameter_modifiedonbehalfby |
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 |
---|---|---|
customapirequestparameter_AsyncOperations | asyncoperation | regardingobjectid_customapirequestparameter |
customapirequestparameter_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_customapirequestparameter |
customapirequestparameter_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_customapirequestparameter |
customapirequestparameter_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_customapirequestparameter |
customapirequestparameter_ProcessSession | processsession | regardingobjectid_customapirequestparameter |
customapirequestparameter_SyncErrors | syncerror | regardingobjectid_customapirequestparameter |