BREAGEN Logo
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 AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

categorystring category
descriptionstring description

Example Request

curl -X 'POST' \
'https://dms-be.braegen.ai/v1/api/dm/category/craete' \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'category=sales&description=Documents%20related%20to%20sales%20activities'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Responses

{
    "is_error": false,
    "message": "Create Category Success",
    "results": {
        "id": 5,
        "create_datetime": "2024-06-11T07:24:03",
        "category": "sales",
        "description": "Documents related to sales activities",
        "doc_categories": []
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
404Invalid page number or missing
404Invalid 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 FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Example Request

curl -X 'GET' \
'https://dms-be.braegen.ai/v1/api/dm/category/get_all_categories' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Get All Categories Success",
    "results": [
        {
        "category": "Finance",
        "description": "Documents related to financial matters",
        "id": 1,
        "create_datetime": "2024-02-28T08:00:00",
        "doc_categories": []
        },
        {
        "category": "HR",
        "description": "Documents related to human resources",
        "id": 2,
        "create_datetime": "2024-02-28T08:15:00",
        "doc_categories": []
        },
        {
        "category": "Sales",
        "description": "Documents related to sales activities",
        "id": 3,
        "create_datetime": "2024-02-28T09:00:00",
        "doc_categories": []
        }
    ]
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid 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 FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'GET' \
'https://dms-be.braegen.ai/v1/api/dm/category/category_id/2' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get Category Success",
    "results": {
        "id": 2,
        "create_datetime": "2024-02-28T08:15:00",
        "category": "HR",
        "description": "Documents related to human resources",
        "doc_categories": []
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Category Management - Update Category PUT /v1/api/dm/category/{category_id}

Resource URL/v1/api/dm/category/{category_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'PUT' \
'https://dms-be.braegen.ai/v1/api/dm/category/5' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "category": "Sale",
    "description": "Documents related to sales activities"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Update Category Success",
    "results": {
        "id": 5,
        "create_datetime": "2024-06-11T07:28:54",
        "category": "Sale",
        "description": "Documents related to sales activities",
        "doc_categories": []
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Category Management - Delete Category DELETE /v1/api/dm/category/{category_id}

Resource URL/v1/api/dm/category/{category_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'DELETE' \
'https://dms-be.braegen.ai/v1/api/dm/category/4' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Delete Category Success",
    "results": {
        "message": "Category deleted successfully"
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type