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 |