Tags zu Anlagen¶

Anlagentags sind Tags, die einer Anlage zugeordnet sind.

Mit der bookamat–API können Anlagentags abgefragt, hinzugefügt, geändert und gelöscht werden. Es sind also GET, POST, PUT/PATCH und DELETE Requests möglich.

Liste der Tags zu Anlagen¶

Die Liste aller Anlagentags wird mit einem GET Request auf die Listen URL abgefragt.

/inventories/tags/

Response¶

HTTP/1.0 200 OK
Content-Type: application/json; charset=utf-8

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 9723,
            "inventory": 7896,
            "tag": 5680,
            "name": "Hardware"
        },
        {
            "id": 9724,
            "inventory": 7897,
            "tag": 5690,
            "name": "Software"
        },
    ]
}

Felder¶

id:

Eindeutige Identifikationsnummer

Format: Ganzzahl

inventory:

ID der Anlage

Format: Ganzzahl
Siehe: Anlagen

tag:

ID des Tag

Format: Ganzzahl
Siehe: Tags

name:

Name

Format: String (min. 3 Zeichen, max. 40 Zeichen)

Filter¶

inventory:

ID der Anlage

Format: Ganzzahl
Beispiele: inventory=7896

tag:

ID des Tag

Format: Ganzzahl
Beispiele: tag=5690

Sortierung¶

ordering:

Sortierung

Möglichkeiten: id, inventory, tag, name
Beispiele: ordering=id

Anlagentag Detail¶

Ein einzelner Anlagentag wird mit einem GET Request auf die Detail URL abgefragt. Es sind dieselben Felder verfügbar wie bei der Listenansicht.

/inventories/tags/{id}/

Anlagentag hinzufügen¶

Ein neuer Anlagentag wird mit einem POST Request auf die Listen URL hinzugefügt. Der Request Body muss alle notwendigen Felder beinhalten, als Response wird der neue Anlagentag zurückgegeben.

Warnung

Es können maximal 3 Tags pro Anlage hinzugefügt werden.

/inventories/tags/

Request¶

Content-Type: application/json; charset=utf-8

{
    "inventory": 7898,  // existierende Anlage
    "tag": 5684,  // existierender Tag
}

Response¶

HTTP/1.0 201 CREATED
Content-Type: application/json; charset=utf-8

{
    "id": 9725,
    "inventory": 7898,
    "tag": 5684,
    "name": "Hardware"
}

Felder¶

Notwendige Felder sind mit * gekennzeichnet.

inventory *:

ID der Anlage

Format: Ganzzahl

tag *:

ID des Tag

Format: Ganzzahl

Anlagentag ändern¶

Ein Anlagentag kann mit einem PATCH oder PUT Request auf die Detail URL geändert werden.

/inventories/tags/{id}/

Request (PATCH)¶

Content-Type: application/json; charset=utf-8

{
    "tag": 5685
}

Request (PUT)¶

Content-Type: application/json; charset=utf-8

{
    "inventory": 7898,
    "tag": 5685
}

Response¶

Als Response wird der Anlagentag zurückgegeben.

HTTP/1.0 200 OK
Content-Type: application/json; charset=utf-8

{
    "id": 9725,
    "inventory": 7898,
    "tag": 5685,
    "name": "Software"
}

Felder¶

Die Felder sind deckungsgleich mit dem POST Request (siehe Felder beim Hinzufügen eines Anlagentags). Beim PATCH Request sind nur die geänderten Felder anzugeben, beim PUT Request sind alle Felder notwendig.

Anlagentag löschen¶

Ein Anlagentag kann mit einem DELETE Request auf die Detail URL gelöscht werden.

Bemerkung

Es wird lediglich die Verknüpfung des Tags mit der Anlage gelöscht.

/inventories/tags/{id}/

Response¶

HTTP/1.0 204 NO CONTENT