Interfejs REST API AMAGE - zlecenia pracy

Wstęp/Kontekst

Kontekst dla operacji na obiektach modułu zleceń pracy (Work Orders) w systemie AMAGE, którą należy w zapytaniu rozszerzyć o odpowiednią metodę.

rest/amage/v1/work-orders

Struktury danych

Struktury i typy danych wykorzystywane w zapytaniach i odpowiedziach.

Rezultat:

W polach ID/UUID znajduje się identyfikator nowo utworzonego lub edytowanego obiektu. W przypadku poprawnego wykonania operacji pole success jest ustawiane na true. W przypadku wystąpienia błędu pole success jest ustawiane na false, a w polu message znajduje się opis błędu. Kod błędu zawiera wtedy kod HTTP typu NOT_FOUND lub BAD_REQUEST. Zwracany w zapytaniu wtedy jest również kod BAD_REQUEST. W zależności od typu błędu podczas przetwarzania zapytania kod błędu może być różny niż zwracany główny kod zapytania. Kod zapytania będzie BAD_REQUEST, a kod wewnętrzny będzie ustawiony na NOT_FOUND w przypadku takim, gdy zapytanie będzie ustawiało właściwość obiektu na inny obiekt w systemie. Parametr JSON będzie poprawny (UUID rekordu), ale takiego rekordu nie będzie w systemie. W związku z tym w polu errorCode pojawi się kod NOT_FOUND. W polu opisowym message komunikat informujący jakiego rekordu nie znaleziono, a główny kod błędu zapytania będzie wynosił BAD_REQUEST.

{
    "id": 1,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Standardowy rezultat operacji (WorkOrdersOperationResultDto):

Każda operacja modyfikująca zwraca obiekt:

{
    "id": 12345,
    "uuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success": true,
    "errorCode": 0,
    "message": ""
}

Znaczenie pól:

id – identyfikator rekordu w bazie (może być null przy błędzie).
uuid – UUID rekordu (może być null przy błędzie).
success – flaga powodzenia operacji (true/false).
errorCode – kod błędu (np. 400 przy błędnym UUID, 404 gdy encja nie istnieje).
message – krótki opis błędu lub pusty przy sukcesie.

W przypadku błędów HTTP 400 (np. niepoprawny format UUID) lub 404 (np. brak encji) ciało nadal zwiera powyższą strukturę z success=false i odpowiednim errorCode/message.

Przykładowe odpowiedzi błędów (400/404)

Niepoprawny format UUID:

{
    "id": null,
    "uuid": null,
    "success": false,
    "errorCode": 400,
    "message": "Wrong Work Order UUID format or non-existent"
}

Brak encji (np. zlecenie nie istnieje):

{
    "id": null,
    "uuid": null,
    "success": false,
    "errorCode": 404,
    "message": "Work Order not found"
}

Nagłówki autoryzacji (podpis API)

Każde wywołanie wymaga podpisu API w nagłówkach:

device-uuid – identyfikator urządzenia/klienta
api-key – klucz aplikacji
api-sign – podpis żądania zgodnie z polityką integracji
Content-Type – application/json lub text/plain (zgodnie z sekcją endpointu)

Brak lub niepoprawny podpis może skutkować odpowiedzią 400 Bad Request.

Typ stanu zlecenia pracy:

NEW,
SCHEDULED,
IN_PROGRESS,
ON_HOLD,
FINISHED,
VOID

Priorytet zlecenia pracy:

LOW,
NORMAL,
HIGH

Zlecenie pracy

Metoda	Ścieżka	Body	Zwraca	Typowe kody
GET	/rest/amage/v1/work-orders/count	brak	liczba (Long)	200, 400
GET	/rest/amage/v1/work-orders/list?page=&size=	brak	lista WorkOrderDto	200, 404
GET	/rest/amage/v1/work-orders/get/by-uuid/{uuid}	brak	WorkOrderDto	200, 400, 404
POST	/rest/amage/v1/work-orders/add	WorkOrderDto	WorkOrdersOperationResultDto	200, 400
POST	/rest/amage/v1/work-orders/edit/{uuid}	WorkOrderDto	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/add-history/{uuid}	WorkOrderHistoryDto	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/edit-history/{uuid}	WorkOrderHistoryDto	WorkOrdersOperationResultDto	200, 400, 404
DELETE	/rest/amage/v1/work-orders/delete-history/{uuid}	brak	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/add-workorder-elementtype-plan/{uuid}	WorkOrderElementTypePlanItemDto	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/edit-workorder-elementtype-plan/{uuid}	WorkOrderElementTypePlanItemDto	WorkOrdersOperationResultDto	200, 400, 404
DELETE	/rest/amage/v1/work-orders/delete-workorder-elementtype-plan/{uuid}	brak	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/join-asset-to-plan-by-uuid/{uuid}	brak	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/remove-asset-from-plan-by-uuid/{uuid}	brak	WorkOrdersOperationResultDto	200, 400, 404
POST	/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/remove-asset-plan-by-uuid/{uuid}	brak	WorkOrdersOperationResultDto	200, 400, 404

Metoda

Ścieżka

Body

Zwraca

Typowe kody

GET

/rest/amage/v1/work-orders/count

brak

liczba (Long)

200, 400

GET

/rest/amage/v1/work-orders/list?page=&size=

brak

lista WorkOrderDto

200, 404

GET

/rest/amage/v1/work-orders/get/by-uuid/{uuid}

brak

WorkOrderDto

200, 400, 404

POST

/rest/amage/v1/work-orders/add

WorkOrderDto

WorkOrdersOperationResultDto

200, 400

POST

/rest/amage/v1/work-orders/edit/{uuid}

WorkOrderDto

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/add-history/{uuid}

WorkOrderHistoryDto

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/edit-history/{uuid}

WorkOrderHistoryDto

WorkOrdersOperationResultDto

200, 400, 404

DELETE

/rest/amage/v1/work-orders/delete-history/{uuid}

brak

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/add-workorder-elementtype-plan/{uuid}

WorkOrderElementTypePlanItemDto

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/edit-workorder-elementtype-plan/{uuid}

WorkOrderElementTypePlanItemDto

WorkOrdersOperationResultDto

200, 400, 404

DELETE

/rest/amage/v1/work-orders/delete-workorder-elementtype-plan/{uuid}

brak

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/join-asset-to-plan-by-uuid/{uuid}

brak

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/remove-asset-from-plan-by-uuid/{uuid}

brak

WorkOrdersOperationResultDto

200, 400, 404

POST

/rest/amage/v1/work-orders/asset-plan/{work-order-uuid}/remove-asset-plan-by-uuid/{uuid}

brak

WorkOrdersOperationResultDto

200, 400, 404

Pobieranie liczby typów elementów

Metoda: GET
Ścieżka: /count
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Zwraca liczbę wszystkich zleceń pracy w systemie.

Kody odpowiedzi:

200 OK – poprawne zapytanie, zwracany jest licznik.
400 Bad Request – błędne nagłówki/podpis lub niepoprawny format.

{
    123456
}

Pobranie listy zleceń pracy

Metoda: GET
Ścieżka: /list
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

page - RequestParam - strona - liczona od 1 (domyślnie 1)
size - RequestParam - rozmiar strony - liczba rekordów na stronie (domyślnie 50). Sugerujemy ograniczenie do 1000 elementów, implementacja może narzucać mniejszą wartość.

Zwracane dane to tablica obiektów JSON ze strukturą:

{
    "uuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "name": "Nazwa zlecenia",
    "description": "Opis zlecenia",
    "typeUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "stateName": "IN_PROGRESS",
    "priorityName": "NORMAL",
    "archived": false,
    "contractUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "contractScopeUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "accountUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "created": "2021-01-01T12:00:00",
    "beginDate": "2021-01-01T12:00:00",
    "deadlineDate": "2021-01-01T12:00:00",
    "notes": "notes",
    "startDate": "2021-01-01T12:00:00",
    "finishDate": "2021-01-01T12:00:00",
    "assignedDepartmentUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "assignedUserUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "assignedContractorUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "verifyUserUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "protocolNumber": "A/23/330/2000",
    "parentUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "customerUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "locationUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "placeOfWorkUuid": "f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "budget": 1000.0,
    "hoursEstimated": 10.0,
    "workAmount": 100.0,
    "workAmountUnit": "metry",
    "workUnitMinutesTotal": 150.0,
    "workUnitMinutes": 100.0,
    "workUnitPrice": 156.0,
    "progressCompleted": 75,
    "elementTypePlanCompleted": false,
    "elementTypePlanTotalCount": 10,
    "elementTypePlanCompletedCount": 7,
    "progressCompletedUpdated": "2021-01-02T10:00:00",
    "elementTypePlanUpdated": "2021-01-02T10:05:00"
}

W przypadku pobierania danych z systemu pole ID, UUID będą w zwracanej strukturze wypełnione danymi pochodzącymi z systemu. Pole ID to identyfikator lokalnej bazy danych. Pole UUID to identyfikator globalny w systemie AMAGE, który może służyć jako identyfikator jednoznacznie identyfikujący obiekt w systemie i w integracjach pomiędzy systemami.

Kody odpowiedzi:

200 OK – zwrócono listę zleceń.
404 Not Found – brak danych (np. błąd obsługi danych).

Pobranie zlecenia pracy po UUID

Metoda: GET
Ścieżka: /get/by-uuid/{uuid}
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator zlecenia pracy

Zwracane dane to pojedynczy obiekt JSON ze strukturą typu elementu tożsamą z metodą /list.

Kody odpowiedzi:

200 OK – zwrócono obiekt.
400 Bad Request – niepoprawny format UUID lub zduplikowany wpis.
404 Not Found – brak zlecenia o podanym UUID.

Dodanie nowego zlecenia pracy

Metoda: POST
Ścieżka: /add
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

W treści zapytania (body) należy zamieścić obiekt JSON z danymi zlecenia pracy. Obiekt ma strukturę tożsamą z metodą /list.

Zapytanie

/rest/amage/v1/work-orders/add

Odpowiedź

{
    "id": 12345,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

W przypadku zapisu danych z systemu pole ID nie może być wypełnione. Zostaje ono uzupełnione podczas zapisu rekordu do bazy danych i zwrócone w strukturze odpowiedzi. Jeśli pole UUID zostanie podane, to taka wartość zostanie przypisana do rekordu. System nie sprawdza unikalności UUID w ramach struktur lub kontekstu całego systemu. Jeśli UUID nie zostanie podane, to system wygeneruje własne unikalne UUID.

Kody odpowiedzi:

200 OK – utworzono zlecenie, w odpowiedzi zwracane id i uuid.
400 Bad Request – błąd walidacji danych wejściowych.

Edycja zlecenia pracy

Metoda: POST
Ścieżka: /edit/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator zlecenia pracy

W treści zapytania (body) należy zamieścić obiekt JSON z danymi zlecenia pracy. Obiekt ma strukturę taką jak dla przypadku dodania zlecenia pracy. Pola niepuste zostaną zaktualizowane w zleceniu pracy.

Zapytanie

/rest/amage/v1/work-orders/edit/f25e62ea-0100-4f4e-aad2-853cf48df2b9

Odpowiedź

{
    "id": 12345,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – zapisano zmiany, w odpowiedzi id i uuid rekordu.
400 Bad Request – niepoprawny UUID w ścieżce lub błąd walidacji.
404 Not Found – zlecenie do edycji nie istnieje (zwracane jako 400 z errorCode=404).

Historia zlecenia pracy

Zapisanie historii do istniejącego zlecenia pracy

Metoda: POST
Ścieżka: /add-history/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator zlecenia pracy

W treści zapytania (body) należy zamieścić obiekt JSON z danymi historii zlecenia pracy. Obiekt ma strukturę:

{
    "workOrderUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "reportedOn":"2021-01-01T12:00:00",
    "reportedByUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "tstamp":"2021-01-01T12:00:00",
    "stateName":"IN_PROGRESS",
    "message":"message",
    "hoursReported":8.0,
    "workAmountReported":10.0,
    "participantCount":5,
    "valid":true,
    "participants":[
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527"
        },
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527"
        }
    ],
    "workOrderExpenditures":[
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
            "tstamp":"2021-01-01T12:00:00",
            "elementTypeUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
            "itemCount":10.0,
            "message":"message"
        }
    ]
}

Zapytanie

/rest/amage/v1/work-orders/add-history/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – dodano wpis historii.
400 Bad Request – niepoprawny UUID zlecenia lub błąd walidacji danych historii.
404 Not Found – zlecenie nie istnieje (zwracane jako 400 z errorCode=404).

Edycja historii zlecenia pracy

Metoda: POST
Ścieżka: /edit-history/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator wpisu historii

W treści zapytania (body) należy zamieścić obiekt JSON z danymi historii zlecenia pracy. Obiekt ma strukturę j/n. W przypadku podania listy użytkowników, istniejąca lista zostanie wyczyszczona i zastąpiona podaną. Tak samo w przypadku zużycia.

{
    "workOrderUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "reportedOn":"2021-01-01T12:00:00",
    "reportedByUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "tstamp":"2021-01-01T12:00:00",
    "stateName":"IN_PROGRESS",
    "message":"message",
    "hoursReported":8.0,
    "workAmountReported":10.0,
    "participantCount":5,
    "valid":true,
    "participants":[
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527"
        },
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527"
        }
    ],
    "workOrderExpenditures":[
        {
            "uuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
            "tstamp":"2021-01-01T12:00:00",
            "elementTypeUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
            "itemCount":10.0,
            "message":"message"
        }
    ]
}

Zapytanie

/rest/amage/v1/work-orders/edit-history/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – zaktualizowano wpis historii.
400 Bad Request – niepoprawny UUID wpisu historii lub błąd walidacji danych.
404 Not Found – wpis historii nie istnieje (zwracane jako 400 z errorCode=404).

Usunięcie historii zlecenia pracy

Metoda: DELETE
Ścieżka: /delete-history/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator wpisu historii

Treść zapytania (body) pusta.

Zapytanie

/rest/amage/v1/work-orders/delete-history/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – usunięto wpis historii.
400 Bad Request – niepoprawny UUID lub błąd walidacji.
404 Not Found – wpis historii nie istnieje (zwracane jako 400 z errorCode=404).

Plan materiałowy zlecenia pracy

Zapisanie planu materiałowego do istniejącego zlecenia pracy

Metoda: POST
Ścieżka: /add-workorder-elementtype-plan/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator zlecenia pracy

W treści zapytania (body) należy zamieścić obiekt JSON z danymi planu materiałowego zlecenia pracy. Obiekt ma strukturę:

{
    "workOrderUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "elementTypeUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "itemCount":10.0,
    "category":"category",
    "code":"code"
}

Zapytanie

/rest/amage/v1/work-orders/add-workorder-elementtype-plan/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – dodano pozycję planu materiałowego.
400 Bad Request – niepoprawny UUID zlecenia lub błąd walidacji danych planu.
404 Not Found – zlecenie nie istnieje (zwracane jako 400 z errorCode=404).

Edycja planu materiałowego dla zlecenia pracy

Metoda: POST
Ścieżka: /edit-workorder-elementtype-plan/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator wpisu planu materiałowego

W treści zapytania (body) należy zamieścić obiekt JSON z danymi planu materiałowego dla zlecenia pracy. Obiekt ma strukturę:

{
    "workOrderUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "elementTypeUuid":"1c4066e6-cdd6-4903-803a-b6bffe689527",
    "itemCount":10.0,
    "category":"category",
    "code":"code"
}

Zapytanie

/rest/amage/v1/work-orders/edit-workorder-elementtype-plan/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – zaktualizowano pozycję planu materiałowego.
400 Bad Request – niepoprawny UUID pozycji lub błąd walidacji danych.
404 Not Found – pozycja nie istnieje (zwracane jako 400 z errorCode=404).

Usunięcie planu materiałowego zlecenia pracy

Metoda: DELETE
Ścieżka: /delete-workorder-elementtype-plan/{uuid}
Generuje: application/json
Wymaga: application/json
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

UUID - identyfikator planu materiałowego

Treść zapytania (body) pusta.

Zapytanie

/rest/amage/v1/work-orders/delete-workorder-elementtype-plan/1c4066e6-cdd6-4903-803a-b6bffe689527

Odpowiedź

{
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – usunięto pozycję planu materiałowego.
400 Bad Request – niepoprawny UUID pozycji lub błąd walidacji.
404 Not Found – pozycja nie istnieje (zwracane jako 400 z errorCode=404).

Plan zasobów zlecenia pracy

Plan zasobów zlecenia pracy pozwala na operacje na liście zasobów przypisanych do danego zlecenia pracy.

Połączenie istniejącego zasobu do zlecenia pracy

Metoda: POST
Ścieżka: /asset-plan/{work-order-uuid}/join-asset-to-plan-by-uuid/{uuid}
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

work-order-uuid - UUID zlecenia pracy
uuid - identyfikator zasobu

Zwracane dane to obiekt JSON ze strukturą zawierającą ID/UUID nowo utworzonego rekordu planu zasobów zlecenia pracy.

{
    "id": 123456,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – przypięto zasób do planu zlecenia.
400 Bad Request – niepoprawny UUID zlecenia lub zasobu, błąd walidacji, duplikat zasobu w planie.
404 Not Found – brak zlecenia lub zasobu (zwracane jako 400 z errorCode=404).

Usunięcie zasobu z planu zlecenia pracy

Metoda: POST
Ścieżka: /asset-plan/{work-order-uuid}/remove-asset-from-plan-by-uuid/{uuid}
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

work-order-uuid - UUID zlecenia pracy
uuid - identyfikator zasobu

Zwracane dane to obiekt JSON ze strukturą zawierającą ID/UUID usuniętego rekordu planu zasobów zlecenia pracy.

{
    "id": 123456,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – usunięto zasób z planu.
400 Bad Request – niepoprawny UUID zlecenia lub zasobu.
404 Not Found – brak zlecenia lub zasobu (zwracane jako 400 z errorCode=404).

Jeśli zasób będzie dodany wielokrotnie do danego zlecenia pracy, to zapytanie zwróci błąd. Należy skorzystać z metody jawnie wskazującej identyfikator rekordu planu zasobu dla zlecenia pracy.

Usunięcie elementu planu zasobu związanego ze zleceniem pracy

Ta metoda w polu UUID wymaga podania konkretnego identyfikatora rekordu planu zasobów zlecenia pracy.

Metoda: POST
Ścieżka: /asset-plan/{work-order-uuid}/remove-asset-plan-by-uuid/{uuid}
Generuje: application/json
Wymaga: application/json, text/plain
Autoryzacja: podpis API (device-uuid, api-key, api-sign)

Parametry:

work-order-uuid - UUID zlecenia pracy
uuid - identyfikator wpisu w planie zasobów dla zleenia pracy

Zwracane dane to obiekt JSON ze strukturą zawierającą ID/UUID usuniętego rekordu planu zasobów zlecenia pracy.

{
    "id": 123456,
    "uuid":"f25e62ea-0100-4f4e-aad2-853cf48df2b9",
    "success":true,
    "errorCode":0,
    "message":""
}

Kody odpowiedzi:

200 OK – usunięto wpis planu zasobów.
400 Bad Request – niepoprawny UUID zlecenia lub wpisu planu.
404 Not Found – brak zlecenia lub wpisu planu (zwracane jako 400 z errorCode=404).