CommonFileObject

Moduł odpowiedzialny za zarządzanie powiązaniem pliku z obiektami (IssueSentence, Template) - listowanie, tworzenie, modyfikacja, usuwanie.

Endpointy obsługujące żądanie:

• https://api.5ways.com
• https://api.client.5ways.com

Pobieranie listy powiązań plików z obiektami

GET /rest/common_file_object

Zwraca listę powiązań

Zwracane dane

HTTP/1.1 200 OK
{
    "CommonFileObject": {
        "id": "3",
        "customer_id": "82",
        "common_file_id": "10",
        "object_name": "IssueSentence",
        "object_id": "10"
    }
},
{
    "CommonFileObject": {
        "id": "4",
        "customer_id": "82",
        "common_file_id": "11",
        "object_name": "IssueSentence",
        "object_id": "10"
    }
},

Pobieranie wybranego powiązania pliku z obiektem

GET /rest/common_file_object/{id}

Zwraca dane powiązania na podstawie podanego ID

Zwracane dane

HTTP/1.1 200 OK
{
    "CommonFileObject": {
        "id": "3",
        "customer_id": "82",
        "common_file_id": "10",
        "object_name": "IssueSentence",
        "object_id": "10"
    }
}

Tworzenie powiązania pliku z obiektem

POST /rest/common_file_object

Tworzy nowe powiązanie

Treść żądania

{
    "CommonFileObject": {
        "common_file_id": "2",
        "object_name": "IssueSentence",
        "object_id": "1"
    }
}

Odpowiedź

Zwraca obiekt z id nowo utworzonego powiązania

HTTP/1.1 201 Created
location: https://api.5ways.com/rest/common_file_object/{id}
{
    "id": 115
}

Modyfikowanie powiązania pliku z obiektem

PUT /rest/common_file_object/{id}

Modyfikuje dane powiązania

Treść żądania

{
    "CommonFileObject": {
        "common_file_id": "4"
    }
}

Odpowiedź

HTTP/1.1 200 OK
{
    "status": "OK"
}

Usuwanie powiązania pliku z obiektem

DELETE /rest/common_file_object/{id}

Trwale usuwa powiązanie w przypadku, gdy plik nie jest już powiązany z innymi obiektami, zostaje skasowany.

Odpowiedź

HTTP/1.1 200 OK
{
    "status": "OK"
}