Grundlagen der Adobe Workfront-Planungs-API

Das Ziel der Adobe Workfront Planning API besteht darin, das Erstellen von Integrationen mit der Planung zu vereinfachen, indem eine REST-fähige Architektur eingeführt wird, die über HTTP ausgeführt wird. In diesem Dokument wird davon ausgegangen, dass Sie mit REST- und JSON-Antworten vertraut sind, und der von der Planungs-API verfolgte Ansatz beschrieben.

Die Kenntnis des Workfront-Planungs-Schemas hilft Ihnen dabei, die Datenbankbeziehungen zu verstehen, die zum Abrufen von Daten aus der Workfront-Planung für Integrationszwecke genutzt werden können.

Sie können die Planungs-API über ein externes Suchfeld in einem benutzerdefinierten Workfront-Formular aufrufen.

Weitere Informationen zu externen Suchfeldern finden Sie unter Beispiele für das externe Suchfeld in einem benutzerdefinierten Formular.

API-URL für die Workfront-Planung

Vorgänge

Objekte werden bearbeitet, indem eine HTTP-Anfrage an ihren eindeutigen URI gesendet wird. Der auszuführende Vorgang wird durch die HTTP-Methode angegeben.

Die standardmäßigen HTTP-Methoden entsprechen den folgenden Vorgängen:

Weitere Informationen und Beispiele zu den einzelnen Vorgängen finden Sie in der Dokumentation zur Workfront Planning API für Entwickler .

Feldtypen und Suchmodifikatoren, die mit ihnen verwendet werden

Sie können Modifikatoren und Filter mit Feldern verwenden, um zu steuern, welche Daten in den Ergebnissen zurückgegeben werden.

Verwenden von Suchmodifikatoren

Workfront Planning unterstützt die folgenden Suchmodifikatoren:

Feldtypen

Nachstehend finden Sie eine Liste der unterstützten Feldtypen und darüber, welche Suchmodifikatoren mit jedem dieser Feldtypen verwendet werden können

Verwenden von "And"- und "Or"-Anweisungen

Im API-Aufruf können Sie Filter haben, die auf mehreren Kriterien basieren, die durch die Anweisungen $and" und "$or"kombiniert werden

{
  "recordTypeId": "recordTypeId",
  "offset": "integer",
  "limit": "integer",
  "filters": [
    {
      "$or": [
        {
          "launch_date": {
            "$isBetween": [
              "2024-03-31T20:00:00.000Z",
              "2024-04-01T20:00:00.000Z"
            ]
          }
        },
        {
          "$and": [
            {
              "launch_date": {
                "$isBetween": [
                  "2024-03-31T20:00:00.000Z",
                  "2024-04-01T20:00:00.000Z"
                ]
              }
            },
            {
              "status": "active"
            }
          ]
        },
        {
          "$and": [
            {
              "launch_date": {
                "$isBetween": [
                  "2024-04-15T00:00:00.000Z",
                  "2024-04-16T00:00:00.000Z"
                ]
              }
            },
            {
              "status": "planned"
            }
          ]
        }
      ]
    }
  ]
}

Verwenden des Feldanfrageparameters

Mit dem Feldanforderungsparameter können Sie eine kommagetrennte Liste bestimmter Felder angeben, die zurückgegeben werden sollen. Bei diesen Feldnamen wird zwischen Groß- und Kleinschreibung unterschieden.

Beispielsweise die Anfrage

/v1/records/search?attributes=data,createdBy

{
    "records": [
        {
            "id": "Rc6527ecb35df57c441d92ba00",
            "createdBy": "61a9cc0500002f9fdaa7a6f824f557e1",
            "createdAt": null,
            "updatedBy": null,
            "updatedAt": null,
            "customerId": null,
            "imsOrgId": null,
            "recordTypeId": null,
            "data": {
                "F666c0b58b6fee61a2ea6ea81": [
                    {
                        "externalId": null,
                        "id": "Rc665728ff95730b58bc757b13",
                        "value": null
                    },
....

gibt eine Antwort ähnlich der folgenden zurück:

{
    "priority": 2,
    "name": "first task",
    "ID": "4c7c08fa0000002ff924e298ee148df4",
    "plannedStartDate": "2010-08-30T09:00:00:000-0600"
}

Sortieren von Abfrageergebnissen in der API

Sie können Ihre Ergebnisse nach jedem Feld sortieren, wenn Sie Folgendes an Ihren API-Aufruf anhängen:

/v1/records/search

Anfrageinhalt:

{
    "recordTypeId": "Rt6527ecb25df57c441d92b9fa",
    "filters": [],
    "sorting": [
        {
            "fieldId": "F6527ecb25df57c441d92b9fc",
            "direction": "asc"
        },
        {
            "fieldId": "F658afcbd4a0273c67c346fd5",
            "direction": "desc"
        }
    ],
    "limit": 500,
    "offset": 0,
    "rowOrderViewId": "V6527ecb75df57c441d92ba03",
    "groupingFieldIds": []
}

Abfragebeschränkungen und paginierte Antworten

Standardmäßig geben API-Anfragen zur Planung 500 Ergebnisse zurück, beginnend mit dem Anfang der Liste. Um die Standardbegrenzung für die Anzahl der Ergebnisse zu überschreiben, können Sie den Parameter limit in Ihren Anforderungen verwenden und ihn auf eine andere Zahl mit bis zu 2000 Ergebnissen setzen.

Es wird empfohlen, paginierte Antworten für große Datensätze zu verwenden, indem Sie den Parameter offset zu Ihren Anforderungen hinzufügen. Paginierte Antworten ermöglichen es Ihnen, den Speicherort des ersten zurückzugebenden Ergebnisses anzugeben.

Wenn Sie beispielsweise die Ergebnisse 2001-4000 zurückgeben möchten, können Sie die folgende Anfrage verwenden. In diesem Beispiel werden seit dem 2001. Ergebnis 2000 Datensätze zurückgegeben, die sich im aktiven Status befinden:

POST /v1/records/search

Anfrageinhalt:

{
    "recordTypeId": "recordTypeId",
    "offset": "2001",
    "limit": "2000",
    "filters": [
        { "status": "active" }
    ]
}

Verwenden Sie einen Sortierparameter, um sicherzustellen, dass Ihre Ergebnisse korrekt paginiert werden. Dadurch können die Ergebnisse in derselben Reihenfolge zurückgegeben werden, sodass die Paginierung die Ergebnisse nicht wiederholt oder überspringt.

Weitere Informationen zum Sortieren finden Sie unter Sortieren von Abfrageergebnissen in der API in diesem Artikel.