Document Management
Category Management
Organize documents into categories for easier retrieval and management. Category Management allows users to organize documents into categories, making it easier to classify, find, and manage documents based on their categorization.
Category Management - Add Category POST /v1/api/dm/category/create
| Resource URL | /v1/api/dm/category/create |
|---|---|
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Parameters
| category | string category |
|---|---|
| description | string description |
Example Request
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 403 | Authentication Required |
Example Responses
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Succcess |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Invalid page number or missing |
| 404 | Invalid page size or missing |
Category Management - Get All Categories GET /v1/api/dm/category/get_all_categories
| Resource URL | /v1/api/dm/category/get_all_categories |
|---|---|
| Response Format | Json |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Example Request
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 403 | Authentication Required |
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Succcess |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Invalid Input |
| 404 | invalid or not founc type |
Category Management - Get Category By Id GET /v1/api/dm/category/category_id/{category_id}
| Resource URL | /v1/api/dm/category/category_id/{category_id} |
|---|---|
| Response Format | Json |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Parameters
Example Request
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 403 | Authentication Required |
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Succcess |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Invalid Input |
| 404 | invalid or not founc type |
Category Management - Update Category PUT /v1/api/dm/category/{category_id}
| Resource URL | /v1/api/dm/category/{category_id} |
|---|---|
| Response Format | Json |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Parameters
Example Request
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 403 | Authentication Required |
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Succcess |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Invalid Input |
| 404 | invalid or not founc type |
Category Management - Delete Category DELETE /v1/api/dm/category/{category_id}
| Resource URL | /v1/api/dm/category/{category_id} |
|---|---|
| Response Format | Json |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Parameters
Example Request
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 403 | Authentication Required |
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Succcess |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Invalid Input |
| 404 | invalid or not founc type |