Erstellen von customFieldDefinition

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues customFieldDefinition-Objekt.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigung mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Nicht unterstützt	Nicht unterstützt
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Application	Nicht unterstützt	Nicht unterstützt

HTTP-Anforderung

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

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des customFieldDefinition-Objekts an.

Sie können die folgenden Eigenschaften angeben, wenn Sie eine customFieldDefinition erstellen.

Eigenschaft	Typ	Beschreibung
planId	String	ID des Plans, auf dem das benutzerdefinierte Feld definiert ist. Erforderlich und nach der Erstellung unveränderlich. Erforderlich.
displayName	Zeichenfolge	Name des benutzerdefinierten Felds. Erforderlich.
valueType	customFieldValueType	Datentyp der Werte des benutzerdefinierten Felds.. Die möglichen Werte sind: text, date, utcDateTime, number, decimalflag, singleChoiceText, multipleChoiceText. unknownFutureValue Optional.
rollupType	customFieldRollupType	Wie die Werte dieses benutzerdefinierten Felds aufgabenübergreifend hochgerechnet werden Mögliche Werte sind: noRollup, max, min, sum, average, unknownFutureValue. Optional.
archivalInfo	plannerArchivalInfo	Informationen darüber, ob und wann die Entität archiviert wurde. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein customFieldDefinition-Objekt im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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"
  }
}