Créer customFieldDefinition

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet customFieldDefinition.

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisation de moindre privilège Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Non prise en charge. Non prise en charge.

Requête HTTP

POST /me/planner/plans_v2/{planId}/customFieldDefinitions
POST /users/{usersId}/planner/plans_v2/{planId}/customFieldDefinitions

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet customFieldDefinition .

Vous pouvez spécifier les propriétés suivantes lors de la création d’une customFieldDefinition.

Propriété Type Description
planId Chaîne ID du plan sur lequel le champ personnalisé est défini. Obligatoire et immuable après la création. Obligatoire.
displayName String Nom du champ personnalisé. Obligatoire.
valueType customFieldValueType Type de données des valeurs du champ personnalisé. Les valeurs possibles sont : text, , utcDateTimedate, , decimalnumber, flag, singleChoiceTextmultipleChoiceTextunknownFutureValue. Facultatif.
rollupType customFieldRollupType Comment les valeurs de ce champ personnalisé sont cumulées entre les tâches. Les valeurs possibles sont noRollup, max, min, sum, average, unknownFutureValue. Facultatif.
archivalInfo plannerArchivalInfo Informations indiquant si l’entité est archivée et quand elle l’a été. Facultatif.

Réponse

En cas de réussite, cette méthode renvoie un 201 Created code de réponse et un objet customFieldDefinition dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/customFieldDefinitions
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customFieldDefinition",
  "planId": "b3d9f9a2-3e14-4a4b-9b2b-6b6d9e6a2f31",
  "displayName": "Budget",
  "valueType": "number",
  "rollupType": "sum",
  "archivalInfo": {
    "@odata.type": "microsoft.graph.plannerArchivalInfo"
  }
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customFieldDefinition",
  "id": "590f4e29-112d-432c-491b-21a16ed31803",
  "planId": "String",
  "displayName": "String",
  "valueType": "String",
  "rollupType": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "deletedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "deletedDateTime": "String (timestamp)",
  "archivalInfo": {
    "@odata.type": "microsoft.graph.plannerArchivalInfo"
  }
}
  • Dernière mise à jour :