API zum Planer

Developer Forum
1

Unser Ziel ist es vom aWork Planer einen Export auf Excel zu haben.
Daher wäre die Frage ob es Möglich ist auf den Planer durch die API zuzugreifen, da es aktuell nicht möglich ist den Planer zu exportieren?

2

Hi @alexander.schneider ,

ich vermute du meinst die Workload Ansicht oder?

Die könnt ihr hier abrufen: awork API

Viele Grüße

Nils

3

Okay perfekt. Im Planer steht ja dann als Überschrift „Workload“. Vielen lieben dank.

Wie gebe ich die „userIds“ im Parameter mit? Leider ist kein Beispiel angegeben.

Ich habe mal in folgender URL „/api/v1/users/workload“
Dieses als Parameter mitgegeben:

{
„userIds“: [„809c2217-bb46-4fe4-87e9-67c373ce8685“],
„intervalStart“: „2023-05-10T08:07:14Z“,
„intervalEnd“: „2024-05-10T08:07:14Z“,
„roughPlanningFrom“: 10
}

Leider bekomme ich dafür nichts raus.

Wäre es möglich dafür ein Beispiel zu geben?

4

Hallo Alexander,

es handelt sich um URL Parameter:

curl  -X GET \
  'https://xxx.awork.com/api/v1/users/workload?userIds=dcdfd68f-04b8-ec11-997e-38563d6e6dce&intervalStart=2024-04-02T00:00:00Z&intervalEnd=2024-06-13T00:00:00Z&roughPlanningFrom=0' \
  --header 'accept: application/json'

Der einfachste Weg ist zum Beispiel in awork eine Workload Ansicht zu erstellen und dann den Curl aus der Network Tab zu kopieren, wir nutzen für unser UI die gleichen Endpoints.

Grüße

Nils

5

Zu den Workloads bekomme ich aber nur folgendes heraus:

"workloads": [
            {
                "date": "2024-04-02T00:00:00Z",
                "duration": 0
            },
            {
                "date": "2024-04-03T00:00:00Z",
                "duration": 21121
            },
            {
                "date": "2024-04-04T00:00:00Z",
                "duration": 21121
            },
...

In der Api Dokumentation wird als Beispiel noch viel mehr ausgegeben wie bspw:

"workloads": [
      {
        "date": "2024-04-03T08:47:56.221Z",
        "duration": 0,
        "userCapacity": 0,
        "projects": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "company": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "hasImage": true
            },
            "tasks": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string",
                "duration": 0,
                "taskStatus": {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "name": "Website Design and Implementation",
                  "type": "string"
                },
                "taskSchedules": [
                  {
                    "duration": 0,
                    "from": "2024-04-03T08:47:56.221Z",
                    "to": "2024-04-03T08:47:56.221Z"
                  }
                ],
                "isAnonymized": true,
                "isRecurring": true
              }
            ],
            "timeBookings": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "description": "string",
                "duration": 0,
                "isAnonymized": true
              }
            ],
            "isAnonymized": true,
            "hasImage": true
          }
        ],

So eine Ausgabe würde uns viel weiter helfen um eine Ansicht wie im Planer in einer Excel auszugeben.

6

Habe nun gesehen, dass mit „fetchDetails“ die Ausgabe erstellt werden kann. Aber nur für einen Tag.

Ist ggf. das Feature vorgesehen, diesen Planer in einer Excel exportieren zu können?

7

Hallo Alexander,

ja, geht mit fetchDetails. Du musst das dann pro Tag machen, wir können, gibt aktuell keine alternative. Soweit ich weiss ist aktuell kein Excel export geplant.