## Endpoint: `/api/tagging-dictionaries/`
**Method**: GET
**Description**: Fetch all available tagging dictionaries.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": <Customer_id>,
"customer_name": "<Customer_name>",
... CUSTOMER DETAILS ...
}
],
"next_page": null
}
---
## Endpoint: `/api/tagging-dictionaries/`
**Method**: POST
**Description**: Create a new tagging dictionary entry.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Request Payload
{
"name": "{name}",
"customer": {customer_id},
"default_value": "{value}",
"rows": [
[
0,
"edit",
"key",
null,
"{key_column_value}"
],
[
0,
"edit",
"value",
null,
"{value_column_value}"
]
]
}
### Example Response
`The details of the request (payload)
---
## Endpoint: `/api/tagging-dictionaries/{id}/`
**Method**: GET
**Description**: Retrieve details of a specific tagging dictionary by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the tagging dictionary|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
`The details of the specific (id) tagging dictionary
---
## Endpoint: `/api/tagging-dictionaries/{id}/`
**Method**: PUT
**Description**: Update details of a specific tagging dictionary by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the tagging dictionary|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Request Body
###### Identical to the POST method (2nd API)
### Example Response
`The details of the request (payload)
---
## Endpoint: `/api/tagging-dictionaries/{id}/`
**Method**: DELETE
**Description**: Delete a specific tagging dictionary entry by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the tagging dictionary|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
`1`
`This response means that the request has succeeded`
---
## Endpoint: `/api/tagging-dictionaries/count/`
**Method**: GET
**Description**: Retrieve the total count of tagging dictionaries.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|None|-|-|No parameters required|-|
### Headers
| Header | Type | Required | Description | Example Value |
| ------------- | ------ | -------- | ------------------------------- | ------------- |
| Authorization | string | Yes | Bearer token for authentication | Bearer |
### Example Response
{
"count": 1
}
---