Partager via


Paramètre de requête d’API personnalisée (CustomAPIRequestParameter) table/référence d’entité (Microsoft Dataverse)

Entité qui définit un paramètre de demande pour une API personnalisée

Messages

Le tableau suivant répertorie les messages de la table Custom API Request Parameter (CustomAPIRequestParameter). Les messages représentent des opérations qui peuvent être effectuées sur la table. Ils peuvent aussi être des événements.

Nom
Est-ce que l’événement ?
Opération de l’API Web Kit de développement logiciel (SDK) pour .NET
Associate
Événement : Vrai
Dossiers associés Dossiers associés
Create
Événement : Vrai
POST /customapirequestparameters
Voir Créer
Créer des enregistrements
Delete
Événement : Vrai
DELETE /customapirequestparameters(customapirequestparameterid)
Voir Supprimer
Supprimer des enregistrements
Disassociate
Événement : Vrai
Dissocier les enregistrements Dissocier les enregistrements
Retrieve
Événement : Vrai
GET /customapirequestparameters(customapirequestparameterid)
Voir Récupérer
Récupérer des enregistrements
RetrieveMultiple
Événement : Vrai
GET /customapirequestparameters
Voir Interroger les données
Données de requête
Update
Événement : Vrai
PATCH /customapirequestparameters(customapirequestparameterid)
Voir Mise à jour
Mettre à jour les enregistrements
Upsert
Événement : Faux
PATCH /customapirequestparameters(customapirequestparameterid)
Voir Upsert une ligne de table
UpsertRequest

Propriétés

Le tableau suivant répertorie les propriétés sélectionnées pour la table CustomAPI Request Parameter (CustomAPIRequestParameter).

Propriété Valeur
DisplayName Paramètre de requête d’API personnalisée
DisplayCollectionName Paramètres de demande d’API personnalisées
SchemaName CustomAPIRequestParameter
CollectionSchemaName CustomAPIRequestParameters
EntitySetName customapirequestparameters
LogicalName customapirequestparameter
LogicalCollectionName customapirequestparameters
PrimaryIdAttribute customapirequestparameterid
PrimaryNameAttribut name
Type de table Standard
Type de propriété None

Colonnes/attributs accessibles en écriture

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

CustomAPIId

Propriété Valeur
Descriptif Identificateur unique de l’API personnalisée propriétaire de ce paramètre de requête d’API personnalisée
DisplayName API personnalisée
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName customapiid
RequiredLevel SystèmeRequis
Type Recherche
Targets CustomAPI

CustomAPIRequestParameterId

Propriété Valeur
Descriptif Identificateur unique pour les instances de paramètres de requête d’API personnalisées
DisplayName Paramètre de requête d’API personnalisée
IsValidForForm Faux
IsValidForRead Vrai
LogicalName customapirequestparameterid
RequiredLevel SystèmeRequis
Type Uniqueidentifier

Descriptif

Propriété Valeur
Descriptif Description localisée pour les instances de paramètres de requête d’API personnalisées
DisplayName Description
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName description
RequiredLevel ApplicationObligatoire
Type Chaîne
Format Texto
FormatName Texto
ImeMode Auto
IsLocalizable Vrai
LongueurMaximale 300

DisplayName

Propriété Valeur
Descriptif Nom complet localisé pour les instances de paramètres de requête d’API personnalisées
DisplayName Nom d’affichage
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName displayname
RequiredLevel ApplicationObligatoire
Type Chaîne
Format Texto
FormatName Texto
ImeMode Auto
IsLocalizable Vrai
LongueurMaximale 100

ImportSequenceNumber

Propriété Valeur
Descriptif Numéro de séquence de l’importation qui a créé cet enregistrement.
DisplayName Numéro de séquence d’importation
IsValidForForm Faux
IsValidForRead Vrai
LogicalName importsequencenumber
RequiredLevel Aucun
Type Nombre entier
Valeur maximale 2147483647
ValeurMinimale -2147483648

IsCustomizable

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName Est personnalisable
IsValidForForm Faux
IsValidForRead Vrai
LogicalName iscustomizable
RequiredLevel SystèmeRequis
Type ManagedProperty

IsOptional

Propriété Valeur
Descriptif Indique si le paramètre de requête d’API personnalisé est facultatif
DisplayName Est facultatif
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName isoptional
RequiredLevel SystèmeRequis
Type Booléen
GlobalChoiceName customapirequestparameter_isoptional
DefaultValue Faux
Véritable étiquette Oui
Fausse étiquette Non

LogicalEntityName

Propriété Valeur
Descriptif Nom logique de l’entité liée au paramètre de requête d’API personnalisée
DisplayName Nom logique de l’entité liée
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName logicalentityname
RequiredLevel Aucun
Type Chaîne
Format Texto
FormatName Texto
ImeMode Auto
IsLocalizable Faux
LongueurMaximale 100

Nom

Propriété Valeur
Descriptif Nom principal du paramètre de requête d’API personnalisée
DisplayName Nom
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName name
RequiredLevel ApplicationObligatoire
Type Chaîne
Format Texto
FormatName Texto
ImeMode Auto
IsLocalizable Faux
LongueurMaximale 100

OverriddenCreatedOn

Propriété Valeur
Descriptif Date et heure de migration de l’enregistrement.
DisplayName Enregistrement créé le
IsValidForForm Faux
IsValidForRead Vrai
LogicalName overriddencreatedon
RequiredLevel Aucun
Type Date et heure
CanChangeDateTimeBehavior Faux
DateTimeBehavior UtilisateurLocal
Format DateOnly
ImeMode Inactif
SourceTypeMask 0

statecode

Propriété Valeur
Descriptif État du paramètre de demande d’API personnalisée
DisplayName État
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName statecode
RequiredLevel SystèmeRequis
Type État
DefaultFormValue
GlobalChoiceName customapirequestparameter_statecode

Choix/Options statecode

Valeur Détails
0 Libellé : Actif
DefaultStatus : 1
Nom de l’invariant : Active
1 Libellé : Inactif
DefaultStatus : 2
Nom de l’invariant : Inactive

statuscode

Propriété Valeur
Descriptif Motif de l’état du paramètre de demande d’API personnalisée
DisplayName Motif statut
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName statuscode
RequiredLevel Aucun
Type Statut
DefaultFormValue
GlobalChoiceName customapirequestparameter_statuscode

statuscode Choix/Options

Valeur Détails
1 Libellé : Actif
État :0
TransitionData : Aucune
2 Libellé : Inactif
État :1
TransitionData : Aucune

TimeZoneRuleVersionNumber

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName Numéro de version de la règle de fuseau horaire
IsValidForForm Faux
IsValidForRead Vrai
LogicalName timezoneruleversionnumber
RequiredLevel Aucun
Type Nombre entier
Valeur maximale 2147483647
ValeurMinimale -1

Type

Propriété Valeur
Descriptif Type de données du paramètre de requête d’API personnalisée
DisplayName Type
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName type
RequiredLevel SystèmeRequis
Type Liste déroulante
DefaultFormValue 0
GlobalChoiceName customapifieldtype

Choix de type/Options

Valeur Étiquette
0 Booléen
1 DateTime
2 Decimal
3 Entité
4 EntityCollection
5 EntityReference
6 Float
7 Entier
8 Argent
9 Liste de sélection
10 Chaîne
11 StringArray
12 GUID

UniqueName

Propriété Valeur
Descriptif Nom unique pour le paramètre de requête d’API personnalisée
DisplayName Nom unique
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName uniquename
RequiredLevel SystèmeRequis
Type Chaîne
Format Texto
FormatName Texto
ImeMode Auto
IsLocalizable Faux
LongueurMaximale 128

UTCConversionTimeZoneCode

Propriété Valeur
Descriptif Code de fuseau horaire utilisé lors de la création de l’enregistrement.
DisplayName Code de fuseau horaire de conversion UTC
IsValidForForm Faux
IsValidForRead Vrai
LogicalName utcconversiontimezonecode
RequiredLevel Aucun
Type Nombre entier
Valeur maximale 2147483647
ValeurMinimale -1

Colonnes/attributs en lecture seule

Ces colonnes/attributs renvoient false pour IsValidForCreate et IsValidForUpdate. Répertorié par SchemaName.

ComponentIdUnique

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName ID de ligne unique
IsValidForForm Faux
IsValidForRead Vrai
LogicalName componentidunique
RequiredLevel SystèmeRequis
Type Uniqueidentifier

ComponentState

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName État du composant
IsValidForForm Faux
IsValidForRead Vrai
LogicalName componentstate
RequiredLevel SystèmeRequis
Type Liste déroulante
DefaultFormValue
GlobalChoiceName componentstate

Choix/options de ComponentState

Valeur Étiquette
0 Publié
1 Inédit
2 Deleted
3 Supprimé Non publié

CreatedBy

Propriété Valeur
Descriptif Identificateur unique de l’utilisateur qui a créé l’enregistrement.
DisplayName Créé par
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName createdby
RequiredLevel Aucun
Type Recherche
Targets systemuser

CreatedOn

Propriété Valeur
Descriptif Date et heure de création de l’enregistrement.
DisplayName Créé le
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName createdon
RequiredLevel Aucun
Type Date et heure
CanChangeDateTimeBehavior Faux
DateTimeBehavior UtilisateurLocal
Format Date et Heure
ImeMode Inactif
SourceTypeMask 0

CreatedOnBehalfBy

Propriété Valeur
Descriptif Identificateur unique de l’utilisateur délégué qui a créé l’enregistrement.
DisplayName Créé par (délégué)
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName createdonbehalfby
RequiredLevel Aucun
Type Recherche
Targets systemuser

IsManaged

Propriété Valeur
Descriptif Indique si le composant de solution fait partie d’une solution gérée.
DisplayName Est géré
IsValidForForm Faux
IsValidForRead Vrai
LogicalName ismanaged
RequiredLevel SystèmeRequis
Type Booléen
GlobalChoiceName ismanaged
DefaultValue Faux
Véritable étiquette Adresses IP gérées
Fausse étiquette Non géré

ModifiedBy

Propriété Valeur
Descriptif Identifiant unique de l’utilisateur qui a modifié l’enregistrement.
DisplayName Modifié par
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName modifiedby
RequiredLevel Aucun
Type Recherche
Targets systemuser

ModifiéSur

Propriété Valeur
Descriptif Date et heure de la modification de l’enregistrement.
DisplayName Modifié le
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName modifiedon
RequiredLevel Aucun
Type Date et heure
CanChangeDateTimeBehavior Faux
DateTimeBehavior UtilisateurLocal
Format Date et Heure
ImeMode Inactif
SourceTypeMask 0

ModifiedOnBehalfBy

Propriété Valeur
Descriptif Identificateur unique de l’utilisateur délégué qui a modifié l’enregistrement.
DisplayName Modifié par (délégué)
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName modifiedonbehalfby
RequiredLevel Aucun
Type Recherche
Targets systemuser

ÉcraserTemps

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName Temps d’écrasement de l’enregistrement
IsValidForForm Faux
IsValidForRead Vrai
LogicalName overwritetime
RequiredLevel SystèmeRequis
Type Date et heure
CanChangeDateTimeBehavior Faux
DateTimeBehavior UtilisateurLocal
Format Date et Heure
ImeMode Inactif
SourceTypeMask 0

OwnerId

Propriété Valeur
Descriptif ID du propriétaire
DisplayName Owner
IsValidForForm Vrai
IsValidForRead Vrai
LogicalName ownerid
RequiredLevel SystèmeRequis
Type Propriétaire
Targets systemuser, équipe

OwnerIdType

Propriété Valeur
Descriptif Type d’ID du propriétaire
DisplayName Type d’ID du propriétaire
IsValidForForm Faux
IsValidForRead Vrai
LogicalName owneridtype
RequiredLevel SystèmeRequis
Type Nom de l'Entité

OwningBusinessUnit

Propriété Valeur
Descriptif Identificateur unique de l’unité commerciale propriétaire de l’enregistrement
DisplayName Unité d’affaires propriétaire
IsValidForForm Faux
IsValidForRead Vrai
LogicalName owningbusinessunit
RequiredLevel Aucun
Type Recherche
Targets unité commerciale

OwningTeam

Propriété Valeur
Descriptif Identificateur unique de l’équipe propriétaire de l’enregistrement.
DisplayName Équipe propriétaire
IsValidForForm Faux
IsValidForRead Vrai
LogicalName owningteam
RequiredLevel Aucun
Type Recherche
Targets team

PropriétaireUtilisateur

Propriété Valeur
Descriptif Identificateur unique de l’utilisateur propriétaire de l’enregistrement.
DisplayName Utilisateur propriétaire
IsValidForForm Faux
IsValidForRead Vrai
LogicalName owninguser
RequiredLevel Aucun
Type Recherche
Targets systemuser

Identificateur de solution

Propriété Valeur
Descriptif Identifiant unique de la solution associée.
DisplayName Solution
IsValidForForm Faux
IsValidForRead Vrai
LogicalName solutionid
RequiredLevel SystèmeRequis
Type Uniqueidentifier

SupportingSolutionId

Propriété Valeur
Descriptif Pour usage interne uniquement.
DisplayName Solution
IsValidForForm Faux
IsValidForRead Faux
LogicalName supportingsolutionid
RequiredLevel Aucun
Type Uniqueidentifier

Numéro de version

Propriété Valeur
Descriptif Numéro de version
DisplayName Numéro de version
IsValidForForm Faux
IsValidForRead Vrai
LogicalName versionnumber
RequiredLevel Aucun
Type BigInt
Valeur maximale 9223372036854775807
ValeurMinimale -9223372036854775808

Relations plusieurs-à-un

Ces relations sont multiples. Répertorié par SchemaName.

customapi_customapirequestparameter

RelationTo-Many unique : customapi_customapirequestparameter customapi

Propriété Valeur
EntitéRéférencée customapi
ReferencedAttribute customapiid
RéférencementAttribut customapiid
ReferencingEntityNavigationPropertyName CustomAPIId
Est hiérarchique
Configuration en cascade Archiver: NoCascade
Assigner: NoCascade
Supprimer: Cascade
Fusionner: NoCascade
Reparenter : Cascade
Vue cumulative : NoCascade
Partager: NoCascade
Déséchanger : NoCascade

lk_customapirequestparameter_createdby

RelationTo-Many : systemuser lk_customapirequestparameter_createdby

Propriété Valeur
EntitéRéférencée systemuser
ReferencedAttribute systemuserid
RéférencementAttribut createdby
ReferencingEntityNavigationPropertyName createdby
Est hiérarchique
Configuration en cascade Archiver: NoCascade
Assigner: NoCascade
Supprimer: NoCascade
Fusionner: NoCascade
Reparenter : NoCascade
Vue cumulative : NoCascade
Partager: NoCascade
Déséchanger : NoCascade

lk_customapirequestparameter_createdonbehalfby

RelationTo-Many : systemuser lk_customapirequestparameter_createdonbehalfby

Propriété Valeur
EntitéRéférencée systemuser
ReferencedAttribute systemuserid
RéférencementAttribut createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
Est hiérarchique
Configuration en cascade Archiver: NoCascade
Assigner: NoCascade
Supprimer: NoCascade
Fusionner: NoCascade
Reparenter : NoCascade
Vue cumulative : NoCascade
Partager: NoCascade
Déséchanger : NoCascade

lk_customapirequestparameter_modifiedby

RelationTo-Many : systemuser lk_customapirequestparameter_modifiedby

Propriété Valeur
EntitéRéférencée systemuser
ReferencedAttribute systemuserid
RéférencementAttribut modifiedby
ReferencingEntityNavigationPropertyName modifiedby
Est hiérarchique
Configuration en cascade Archiver: NoCascade
Assigner: NoCascade
Supprimer: NoCascade
Fusionner: NoCascade
Reparenter : NoCascade
Vue cumulative : NoCascade
Partager: NoCascade
Déséchanger : NoCascade

lk_customapirequestparameter_modifiedonbehalfby

RelationTo-Many : systemuser lk_customapirequestparameter_modifiedonbehalfby

Propriété Valeur
EntitéRéférencée systemuser
ReferencedAttribute systemuserid
RéférencementAttribut modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
Est hiérarchique
Configuration en cascade Archiver: NoCascade
Assigner: NoCascade
Supprimer: NoCascade
Fusionner: NoCascade
Reparenter : NoCascade
Vue cumulative : NoCascade
Partager: NoCascade
Déséchanger : NoCascade

Relations One-to-Many

Ces relations sont un-à-plusieurs. Répertorié par SchemaName.

customapirequestparameter_AsyncOperations

Relation plusieursTo-One : customapirequestparameter_AsyncOperations d’opérations asynchrones

Propriété Valeur
RéférencementEntité asyncoperation
RéférencementAttribut regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

customapirequestparameter_BulkDeleteFailures

Relation plusieursTo-One : bulkdeletefailure customapirequestparameter_BulkDeleteFailures

Propriété Valeur
RéférencementEntité bulkdeletefailure
RéférencementAttribut regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

customapirequestparameter_MailboxTrackingFolders

Relation plusieursTo-One : mailboxtrackingfolder customapirequestparameter_MailboxTrackingFolders

Propriété Valeur
RéférencementEntité mailboxtrackingfolder
RéférencementAttribut regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

customapirequestparameter_PrincipalObjectAttributeAccesses

Relation plusieursTo-One : principalobjectattributeaccess customapirequestparameter_PrincipalObjectAttributeAccesses

Propriété Valeur
RéférencementEntité principalobjectattributeaccess
RéférencementAttribut objectid
ReferencedEntityNavigationPropertyName customapirequestparameter_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

customapirequestparameter_ProcessSession

Relation plusieursTo-One : customapirequestparameter_ProcessSession de session de processus

Propriété Valeur
RéférencementEntité processsession
RéférencementAttribut regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

customapirequestparameter_SyncErrors

Relation plusieursTo-One : syncerror customapirequestparameter_SyncErrors

Propriété Valeur
RéférencementEntité syncerror
RéférencementAttribut regardingobjectid
ReferencedEntityNavigationPropertyName customapirequestparameter_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration DisponibleHors ligne : Vrai
Comportement: DoNotDisplay
Groupe: Details
Étiquette:
MenuId : vide
Commande:
QueryApi : null
ViewId : 00000000-0000-0000-0000-000000000000

Voir aussi

Référence de table/entité Dataverse
Référence de l’API Web Dataverse
customapirequestparameter