Grunderna i Adobe Workfront Planning API

Målet för Adobe Workfront Planning API är att förenkla byggintegreringen med Planning genom att införa en REST-full arkitektur som fungerar över HTTP. I det här dokumentet förutsätts att du känner till REST- och JSON-svar och beskriver den metod som används i Planning API.

Tack vare Workfront Planning-schemat är det lättare att förstå de databasrelationer som kan användas för att hämta data från Workfront Planning för integrering.

Du kan anropa planerings-API:t från ett externt sökfält i ett anpassat Workfront-formulär.

Mer information om externa sökfält finns i Exempel på ett externt sökfält i ett anpassat formulär.

URL för Workfront Planning API

Operationer

Objekten ändras genom att en HTTP-begäran skickas till deras unika URI. Den åtgärd som ska utföras anges av HTTP-metoden.

Standardmetoderna för HTTP motsvarar följande åtgärder:

Mer information och exempel på de olika åtgärderna finns i dokumentationen för Workfront Planning API-utvecklare.

Fälttyper och sökmodifieringar som används med dem

Du kan använda modifierare och filter med fält för att styra vilka data som returneras i resultatet.

Använda sökmodifierare

Workfront Planning stöder följande sökmodifierare:

Fälttyper

Nedan finns en lista över de fälttyper som stöds och vilka sökmodifierare som kan användas för var och en av dessa fälttyper

Använda programsatserna "And" och "Or"

I API-anropet kan du ha filter som baseras på flera kriterier som kombineras med $and" och"$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"
            }
          ]
        }
      ]
    }
  ]
}

Använda fältförfrågningsparametern

Du kan använda fältparametern request för att ange en kommaavgränsad lista med specifika fält som ska returneras. Dessa fältnamn är skiftlägeskänsliga.

Till exempel begäran

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

returnerar ett svar som liknar följande:

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

Sortera frågeresultat i API

Du kan sortera resultatet efter vilket fält som helst om du lägger till följande i ditt API-anrop:

/v1/records/search

Begärandetext:

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

Frågebegränsningar och sidnumrerade svar

Som standard returnerar Planning API-begäranden 500 resultat från början av listan. Om du vill åsidosätta standardbegränsningen för antal resultat kan du använda parametern limit i dina begäranden och ange ett annat tal, upp till 2 000 resultat.

Vi rekommenderar att du använder sidnumrerade svar för stora datauppsättningar genom att lägga till parametern offset i dina förfrågningar. Med sidnumrerade svar kan du ange platsen för det första resultatet som ska returneras.

Om du till exempel vill returnera resultatet 2001-4000 kan du använda följande begäran. I det här exemplet returneras 2000 poster som har aktiv status, från och med resultatet 2001:

POST /v1/records/search

Begärandetext:

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

Använd en sorteringsparameter för att försäkra dig om att resultatet är rätt sidnumrerat. Detta gör att resultaten kan returneras i samma ordning, så att sidnumreringen inte upprepas eller hoppar över resultat.

Mer information om sortering finns i Sortera frågeresultat i API:t i den här artikeln.