Basisbeginselen van de API voor Adobe Workfront-planning

Het doel voor de Planning API van Adobe Workfront is het vereenvoudigen van de bouwintegratie met Planning door een REST-ful architectuur in te voeren die over HTTP werkt. In dit document wordt ervan uitgegaan dat u bekend bent met REST- en JSON-reacties en wordt de aanpak beschreven die door de API voor planning wordt gevolgd.

Een vertrouwdheid met het schema van de Planning van Workfront zal u in het begrip van de gegevensbestandverhoudingen helpen die kunnen worden gebruikt om gegevens uit de Planning van Workfront voor integratiedoeleinden te trekken.

U kunt de API voor planning oproepen vanuit een extern opzoekveld in een aangepast Workfront-formulier.

Voor meer informatie over Externe raadplegingsgebieden, zie Voorbeelden van het Externe raadplegingsgebied in een douanevorm.

URL Workfront-plannings-API

Bewerkingen

Objecten worden gemanipuleerd door een HTTP-aanvraag naar hun unieke URI te verzenden. De uit te voeren bewerking wordt opgegeven door de HTTP-methode.

De standaard HTTP-methoden komen overeen met de volgende bewerkingen:

Voor meer details en voorbeelden van elke verrichting, zie de de ontwikkelaarsdocumentatie van de Planning API van Workfront.

Veldtypen en zoekopties die hiermee worden gebruikt

Met wijzigingstoetsen en filters kunt u bepalen welke gegevens in de resultaten worden geretourneerd.

Zoekopties gebruiken

Workfront Planning ondersteunt de volgende zoekopties:

Veldtypen

Hieronder ziet u de lijst met ondersteunde veldtypen en de zoekopties die u kunt gebruiken voor elk van deze veldtypen

Instructies "And" en "Or" gebruiken

In de API-aanroep kunt u filters hebben die zijn gebaseerd op verschillende criteria gecombineerd met instructies $and" en "$or"

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

De parameter voor veldaanvragen gebruiken

U kunt de parameter van het gebiedsverzoek gebruiken om een komma-gescheiden lijst van specifieke gebieden te specificeren die zouden moeten worden teruggekeerd. Deze veldnamen zijn hoofdlettergevoelig.

De aanvraag

/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
                    },
....

retourneert een reactie die lijkt op het volgende:

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

Zoekresultaten sorteren in de API

U kunt de resultaten op elk veld sorteren als u het volgende aan uw API-aanroep toevoegt:

/v1/records/search

Instantie van aanvraag:

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

Zoeklimieten en gepagineerde reacties

Standaard retourneren API-aanvragen 500 resultaten, vanaf het begin van de lijst. Als u de standaardbeperking voor het aantal resultaten wilt overschrijven, gebruikt u de parameter limit in uw aanvragen en stelt u deze in op een ander getal, met maximaal 2000 resultaten.

We raden u aan gepagineerde reacties voor grote gegevenssets te gebruiken door de parameter offset aan uw aanvragen toe te voegen. Met gepagineerde reacties kunt u de locatie opgeven van het eerste resultaat dat moet worden geretourneerd.

Als u bijvoorbeeld de resultaten 2001-4000 wilt retourneren, kunt u de volgende aanvraag gebruiken. Dit voorbeeld keert 2000 verslagen terug die in actieve status zijn, die van het resultaat van 2001st beginnen:

POST /v1/records/search

Instantie van aanvraag:

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

Gebruik een sorteerparameter om ervoor te zorgen dat de resultaten correct worden gepagineerd. Hierdoor kunnen de resultaten in dezelfde volgorde worden geretourneerd, zodat de paginering de resultaten niet herhaalt of overslaat.

Voor meer informatie bij het sorteren, zie Sorterend vraagresultaten in APIin dit artikel.