Partager via


Référence d’entité/de table CustomAPIRequestParameter

Notes

Vous n’êtes pas sûr de la table par rapport à l’entité ? Voir Développeurs : Comprendre la terminologie dans Microsoft Dataverse.

Entity that defines a request parameter for a custom API

Ajouté par : solution Custom API Framework

Messages

Message Opération de l'API web Classe ou méthode SDK
Create POST [org URI]/api/data/v9.0/customapirequestparameters
Voir Créer
CreateRequest ou
Create
Delete DELETE [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Voir Supprimer
DeleteRequest ou
Delete
Retrieve GET [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Voir Récupérer
RetrieveRequest ou
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/customapirequestparameters
Voir Rechercher des données
RetrieveMultipleRequest ou
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/customapirequestparameters(customapirequestparameterid)
Voir Mettre à jour
UpdateRequest ou
Update

Propriétés

Propriété Valeur
CollectionSchemaName CustomAPIRequestParameters
DisplayCollectionName Custom API Request Parameters
DisplayName Custom API Request Parameter
EntitySetName customapirequestparameters
IsBPFEntity False
LogicalCollectionName customapirequestparameters
LogicalName customapirequestparameter
OwnershipType None
PrimaryIdAttribute customapirequestparameterid
PrimaryNameAttribute name
SchemaName CustomAPIRequestParameter

Colonnes/Attributs inscriptibles

Ces colonnes/attributs renvoient la valeur true pour IsValidForCreate ou IsValidForUpdate (généralement les deux). Répertorié par SchemaName.

CustomAPIId

Propriété Valeur
Description Unique identifier for the custom API that owns this custom API request parameter
DisplayName Custom API
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName customapiid
RequiredLevel SystemRequired
Targets customapi
Type Lookup

CustomAPIRequestParameterId

Propriété Valeur
Description Unique identifier for custom API request parameter instances
DisplayName Custom API Request Parameter
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName customapirequestparameterid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Propriété Valeur
Description Localized description for custom API request parameter instances
DisplayName Description
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 300
RequiredLevel ApplicationRequired
Type String

DisplayName

Propriété Valeur
Description Localized display name for custom API request parameter instances
DisplayName Display Name
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName displayname
MaxLength 100
RequiredLevel ApplicationRequired
Type String

ImportSequenceNumber

Ajouté par : solution Basic Solution

Propriété Valeur
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsCustomizable

Ajouté par : solution Basic Solution

Propriété Valeur
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsOptional

Propriété Valeur
Description Indicates if the custom API request parameter is optional
DisplayName Is Optional
IsValidForForm True
IsValidForRead True
LogicalName isoptional
RequiredLevel SystemRequired
Type Boolean

Choix/Options IsOptional

Valeur Étiquette Description
1 Yes
0 No

Valeur par défaut : 0

LogicalEntityName

Propriété Valeur
Description The logical name of the entity bound to the custom API request parameter
DisplayName Bound Entity Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName logicalentityname
MaxLength 100
RequiredLevel None
Type String

Name

Propriété Valeur
Description The primary name of the custom API request parameter
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

OverriddenCreatedOn

Propriété Valeur
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

statecode

Propriété Valeur
Description Status of the Custom API Request Parameter
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

Choix/Options statecode

Valeur Étiquette Statut par défaut Nom invariant
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Propriété Valeur
Description Reason for the status of the Custom API Request Parameter
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

Choix/Options statuscode

Valeur Étiquette État
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Propriété Valeur
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Type

Propriété Valeur
Description The data type of the custom API request parameter
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName type
RequiredLevel SystemRequired
Type Picklist

Choix/Options Type

Valeur Étiquette Description
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

Propriété Valeur
Description Unique name for the custom API request parameter
DisplayName Unique Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName uniquename
MaxLength 128
RequiredLevel SystemRequired
Type String

UTCConversionTimeZoneCode

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

Colonnes/Attributs en lecture seule

Ces colonnes/attributs renvoient la valeur false pour IsValidForCreate ou IsValidForUpdate. Répertorié par SchemaName.

ComponentIdUnique

Ajouté par : solution Basic Solution

Propriété Valeur
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Ajouté par : solution Basic Solution

Propriété Valeur
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

Choix/Options ComponentState

Valeur Étiquette Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Ajouté par : solution Active Solution

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

CreatedByName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Propriété Valeur
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Ajouté par : solution Active Solution

Propriété Valeur
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CustomAPIIdName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customapiidname
MaxLength 100
RequiredLevel None
Type String

IsManaged

Ajouté par : solution Basic Solution

Propriété Valeur
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

Choix/Options IsManaged

Valeur Étiquette Description
1 Managed
0 Unmanaged

Valeur par défaut : 0

ModifiedBy

Ajouté par : solution Active Solution

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

ModifiedByName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Propriété Valeur
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Ajouté par : solution Active Solution

Propriété Valeur
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Ajouté par : solution Active Solution

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Ajouté par : solution Basic Solution

Propriété Valeur
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerId

Ajouté par : solution Active Solution

Propriété Valeur
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Ajouté par : solution Active Solution

Propriété Valeur
Description Owner Id Type
DisplayName Owner Id Type
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Ajouté par : solution Active Solution

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

OwningTeam

Ajouté par : solution Active Solution

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

OwningUser

Ajouté par : solution Active Solution

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

SolutionId

Ajouté par : solution Basic Solution

Propriété Valeur
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Ajouté par : solution Basic Solution

Propriété Valeur
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Ajouté par : solution Active Solution

Propriété Valeur
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

Relations un-à-plusieurs

Répertorié par SchemaName.

customapirequestparameter_SyncErrors

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_SyncErrors pour la table/entité syncerror.

Propriété Valeur
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_AsyncOperations

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_AsyncOperations pour la table/entité asyncoperation.

Propriété Valeur
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_MailboxTrackingFolders

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_MailboxTrackingFolders pour la table/entité mailboxtrackingfolder.

Propriété Valeur
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_ProcessSession

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_ProcessSession pour la table/entité processsession.

Propriété Valeur
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_BulkDeleteFailures

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_BulkDeleteFailures pour la table/entité bulkdeletefailure.

Propriété Valeur
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

customapirequestparameter_PrincipalObjectAttributeAccesses

Ajouté par : solution System Solution

Identique à la relation plusieurs à un customapirequestparameter_PrincipalObjectAttributeAccesses pour la table/entité principalobjectattributeaccess.

Propriété Valeur
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName customapirequestparameter_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Relations plusieurs-à-un

Chaque relation plusieurs-à-un est définie par une relation un-à-plusieurs correspondante avec la table associée. Répertorié par SchemaName.

lk_customapirequestparameter_createdby

Ajouté par : solution System Solution

Voir la relation un à plusieurs lk_customapirequestparameter_createdby pour la table/entité systemuser.

lk_customapirequestparameter_createdonbehalfby

Ajouté par : solution System Solution

Voir la relation un à plusieurs lk_customapirequestparameter_createdonbehalfby pour la table/entité systemuser.

lk_customapirequestparameter_modifiedby

Ajouté par : solution System Solution

Voir la relation un à plusieurs lk_customapirequestparameter_modifiedby pour la table/entité systemuser.

lk_customapirequestparameter_modifiedonbehalfby

Ajouté par : solution System Solution

Voir la relation un à plusieurs lk_customapirequestparameter_modifiedonbehalfby pour la table/entité systemuser.

customapi_customapirequestparameter

Voir la relation un à plusieurs customapi_customapirequestparameter pour la table/entité customapi.

Voir aussi

Référence d’entité/de table Dataverse Référence d’API web customapirequestparameter EntityType