Add

Add tags to a transport

post

Add tags to a transport. Each tag can be referenced either by its pk (an existing tag) or by its name. When a tag is referenced by name and no tag with that name exists yet, it is created on the fly (get-or-create), in the same way as the POST/PATCH /transports/ endpoints. The optional color, tag_group_id and tag_group_name fields are only used when creating a new tag.

This endpoint is idempotent - adding a tag that is already assigned will succeed silently.

If a tag being added belongs to a tag group, and the transport already has another tag from the same group, the old tag will be replaced by the new one (only one tag per group allowed).

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

uidstring · uuidRequired

The unique identifier of the transport

Bodyany of[]

application/json

List of tags to add to the transport. Each item references a tag either by its pk (an existing tag) or by its name. When a tag is referenced by name and no tag with that name exists yet, it is created on the fly (get-or-create). The optional color, tag_group_id and tag_group_name fields are only used when creating a new tag; they are ignored when the tag is matched by pk or by an already existing name.

objectOptional

or

objectOptional

Responses

200

Tags added successfully. Returns the updated list of tags on the transport.

application/json

pkintegerRequired

The unique identifier of the tag

Example: 1

namestringRequired

The name of the tag

Example: Urgent

colorstringRequired

The color of the tag in hex format

Example: #E5291D

tag_group_idinteger · nullableOptional

The ID of the tag group this tag belongs to, if any

400

Invalid request. For example, one or more tag PKs do not exist or do not belong to your company (invalid_tag_pks), a referenced tag group id does not belong to your company (tag_group_not_found), or several tags in the payload belong to the same tag group (only_one_tag_per_group_allowed).

application/json

404

Transport not found or not accessible

post/transports/{uid}/tags/add

HTTPcURLJavaScriptPython

POST /api/v4/transports/{uid}/tags/add HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

[
  {
    "pk": 1
  },
  {
    "name": "Urgent"
  },
  {
    "name": "Fragile",
    "color": "#E5291D",
    "tag_group_name": "Handling"
  }
]

[
  {
    "pk": 1,
    "name": "Urgent",
    "color": "#E5291D",
    "tag_group_id": 1
  }
]