Editar

Compartilhar via

Custom API Request Parameter (CustomAPIRequestParameter) table/entity reference

  • Artigo

Entity that defines a request parameter for a custom API

Messages

The following table lists the messages for the Custom API Request Parameter (CustomAPIRequestParameter) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Create
Event: True		 POST /customapirequestparameters
See Create		 Create records
Delete
Event: True		 DELETE /customapirequestparameters(customapirequestparameterid)
See Delete		 Delete records
Retrieve
Event: True		 GET /customapirequestparameters(customapirequestparameterid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /customapirequestparameters
See Query data		 Query data
Update
Event: True		 PATCH /customapirequestparameters(customapirequestparameterid)
See Update		 Update records
Upsert
Event: False		 PATCH /customapirequestparameters(customapirequestparameterid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Custom API Request Parameter (CustomAPIRequestParameter) table.

Property Value
DisplayName Custom API Request Parameter
DisplayCollectionName Custom API Request Parameters
SchemaName CustomAPIRequestParameter
CollectionSchemaName CustomAPIRequestParameters
EntitySetName customapirequestparameters
LogicalName customapirequestparameter
LogicalCollectionName customapirequestparameters
PrimaryIdAttribute customapirequestparameterid
PrimaryNameAttribute name
TableType Standard
OwnershipType None

Writable columns/attributes

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

CustomAPIId

Property Value
Description Unique identifier for the custom API that owns this custom API request parameter
DisplayName Custom API
IsValidForForm True
IsValidForRead True
LogicalName customapiid
RequiredLevel SystemRequired
Type Lookup
Targets customapi

CustomAPIRequestParameterId

Property Value
Description Unique identifier for custom API request parameter instances
DisplayName Custom API Request Parameter
IsValidForForm False
IsValidForRead True
LogicalName customapirequestparameterid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Property Value
Description Localized description for custom API request parameter instances
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 300

DisplayName

Property Value
Description Localized display name for custom API request parameter instances
DisplayName Display Name
IsValidForForm True
IsValidForRead True
LogicalName displayname
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 100

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsOptional

Property Value
Description Indicates if the custom API request parameter is optional
DisplayName Is Optional
IsValidForForm True
IsValidForRead True
LogicalName isoptional
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName customapirequestparameter_isoptional
DefaultValue False
True Label Yes
False Label No

LogicalEntityName

Property Value
Description The logical name of the entity bound to the custom API request parameter
DisplayName Bound Entity Logical Name
IsValidForForm True
IsValidForRead True
LogicalName logicalentityname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

Name

Property Value
Description The primary name of the custom API request parameter
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

statecode

Property Value
Description Status of the Custom API Request Parameter
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName customapirequestparameter_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

statuscode

Property Value
Description Reason for the status of the Custom API Request Parameter
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName customapirequestparameter_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Type

Property Value
Description The data type of the custom API request parameter
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName type
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName customapifieldtype

Type Choices/Options

Value Label
0 Boolean
1 DateTime
2 Decimal
3 Entity
4 EntityCollection
5 EntityReference
6 Float
7 Integer
8 Money
9 Picklist
10 String
11 StringArray
12 Guid

UniqueName

Property Value
Description Unique name for the custom API request parameter
DisplayName Unique Name
IsValidForForm True
IsValidForRead True
LogicalName uniquename
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Read-only columns/attributes

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

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

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

IsManaged

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
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

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

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description Owner Id Type
DisplayName Owner Id Type
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

customapi_customapirequestparameter

One-To-Many Relationship: customapi customapi_customapirequestparameter

Property Value
ReferencedEntity customapi
ReferencedAttribute customapiid
ReferencingAttribute customapiid
ReferencingEntityNavigationPropertyName CustomAPIId
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_customapirequestparameter_createdby

One-To-Many Relationship: systemuser lk_customapirequestparameter_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_customapirequestparameter_createdonbehalfby

One-To-Many Relationship: systemuser lk_customapirequestparameter_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_customapirequestparameter_modifiedby

One-To-Many Relationship: systemuser lk_customapirequestparameter_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_customapirequestparameter_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_customapirequestparameter_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

customapirequestparameter_AsyncOperations

Many-To-One Relationship: asyncoperation customapirequestparameter_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure customapirequestparameter_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder customapirequestparameter_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess customapirequestparameter_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName customapirequestparameter_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_ProcessSession

Many-To-One Relationship: processsession customapirequestparameter_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

customapirequestparameter_SyncErrors

Many-To-One Relationship: syncerror customapirequestparameter_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
customapirequestparameter