BREAGEN Logo
Document Management

Document Management

The Document Management service provides a robust platform for managing documents, including version control, categorization, and status tracking. Through a comprehensive set of API endpoints, clients can efficiently handle all aspects of document management. This service includes APIs for adding, retrieving, updating, and deleting documents and their versions, as well as managing document categories and statuses. This Document Management service is designed to enhance document control and accessibility, making it an invaluable tool for organizations seeking efficient document management solutions. Through these APIs, clients can seamlessly integrate document management capabilities into their existing systems, ensuring organized and easily retrievable documentation across various domains.

Document Operations

Perform CRUD operations on documents and their versions, ensuring effective document management. Document Operations enable users to manage documents effectively by adding, updating, retrieving, and downloading documents, along with managing document versions and their availability.

Document Operations - Add Document GET /v1/api/dm/upload/

Resource URL/v1/api/dm/upload/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_namestring document name
uploaded_userstring uploaded user
document_statusinteger document status
document_categoryinteger document category
expire_datetimedatetime formatted expire datetime
meta_datastring meta data
versioninteger version
fileUploadFile File to upload

Example Request

curl -X 'POST' \
'https://dms-be.braegen.ai/v1/api/dm/upload' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'document_name=Don data' \
-F '[email protected]' \
-F 'document_status=2' \
-F 'document_category=1' \
-F 'expire_datetime=2024-08-18 04:37:30' \
-F 'meta_data={}' \
-F 'version=1.0' \
-F '[email protected];type=image/png'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Document Created Successfully",
    "results": {
        "document_name": "Don data",
        "uploaded_user": "[email protected]",
        "is_deleted": false,
        "expire_datetime": "2024-08-18 04:37:30",
        "update_datetime": "None",
        "id": 78,
        "document_format": ".png",
        "create_datetime": "2024-06-06 14:05:33",
        "document_versions": [
        {
            "id": 70,
            "create_user": "[email protected]",
            "is_active": true,
            "create_datetime": "2024-06-06 14:05:33",
            "version": "1.0",
            "document_path": "/v1/api/dm/download/78/1.0",
            "update_datetime": "None"
        }
        ],
        "category": {
        "create_user": "[email protected]",
        "category": {
            "category": "Finance",
            "description": "Documents related to financial matters",
            "id": 1,
            "create+datetime": "2024-02-28 08:00:00"
        },
        "meta_data": "{}",
        "id": 58,
        "create_datetime": "2024-06-06 14:05:33"
        },
        "status": {
            "id": 2,
            "status_name": "Approved",
            "description": "Document has been approved",
            "create_datetime": "2024-02-28 09:30:00"
        }
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
404Invalid page number or missing
404Invalid page size or missing

Document Operations - Get Document Versions GET /v1/api/dm/document_versions/

Resource URL/v1/api/dm/document_versions/
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'GET' \
'https://dms-be.braegen.ai/v1/api/dm/document_versions?_id=78' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
[
    {
        "is_active": true,
        "id": 70,
        "create_user": "[email protected]",
        "create_datetime": "2024-06-06T14:05:33",
        "document": 78,
        "version": "1.0",
        "document_path": "/v1/api/dm/download/78/1.0",
        "update_datetime": null
    }
]

HTTP Responses

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

Document Operations - Download Document GET /v1/api/dm/download/{document_id}/{version}

Resource URL/v1/api/dm/download/{document_id}/{version}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
versionversion must be added from referenced add private/public api calls

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

HTTP Request

{
    "success": true
}

HTTP Responses

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

Document Operations - Get All Documents GET /v1/api/dm/get_all/

Resource URL/v1/api/dm/get_all/
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Example Request

curl -X 'GET' \
'https://dms-be.braegen.ai/v1/api/dm/get_all?page=1&page_size=10' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get all documents success",
    "total_records": 53,
    "page_number": 1,
    "page_size": 2,
    "total_pages": 27,
    "results": [
        {
        "document_name": "doc info",
        "uploaded_user": "Analyst",
        "is_deleted": false,
        "expire_datetime": "2026-12-31 23:12:00",
        "update_datetime": "2024-06-06 09:43:26",
        "id": 27,
        "document_format": ".png",
        "create_datetime": "2024-03-17 07:10:19",
        "document_versions": [
            {
            "id": 8,
            "create_user": "Analyst",
            "is_active": true,
            "create_datetime": "2024-06-06 09:43:26",
            "version": "new",
            "document_path": "/v1/api/dm/download/27/new",
            "update_datetime": "2024-06-06 09:43:26"
            }
        ],
        "category": {
            "create_user": "Analyst",
            "category": {
            "category": "Finance",
            "description": "Documents related to financial matters",
            "id": 1,
            "create+datetime": "2024-02-28 08:00:00"
            },
            "meta_data": "{}",
            "id": 7,
            "create_datetime": "2024-06-06 09:43:26"
        },
        "status": {
            "id": 4,
            "status_name": "Pending",
            "description": "Document is pending review",
            "create_datetime": "2024-06-03 12:02:30"
        }
        }
    ]
}

HTTP Responses

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

Document Operations - Get Document By Id GET /v1/api/dm/get_by_id/{document_id}

Resource URL/v1/api/dm/get_by_id/{document_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get document by ID success",
    "results": {
        "document_name": "Don data",
        "uploaded_user": "[email protected]",
        "is_deleted": false,
        "expire_datetime": "2024-08-18 04:37:30",
        "update_datetime": "None",
        "id": 78,
        "document_format": ".png",
        "create_datetime": "2024-06-06 14:05:33",
        "document_versions": [
        {
            "id": 70,
            "create_user": "[email protected]",
            "is_active": true,
            "create_datetime": "2024-06-06 14:05:33",
            "version": "1.0",
            "document_path": "/v1/api/dm/download/78/1.0",
            "update_datetime": "None"
        }
        ],
        "category": {
        "create_user": "[email protected]",
        "category": {
            "category": "Finance",
            "description": "Documents related to financial matters",
            "id": 1,
            "create+datetime": "2024-02-28 08:00:00"
        },
        "meta_data": "{}",
        "id": 58,
        "create_datetime": "2024-06-06 14:05:33"
        },
        "status": {
            "id": 2,
            "status_name": "Approved",
            "description": "Document has been approved",
            "create_datetime": "2024-02-28 09:30:00"
        }
    }
}

HTTP Responses

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

Document Operations - Get Document Version GET /v1/api/dm/get_document_version/{document_id}/{version}

Resource URL/v1/api/dm/get_document_version/{document_id}/{version}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
versionversion must be added from referenced add private/public api calls

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get document version success",
    "results": {
        "is_active": true,
        "id": 70,
        "create_user": "[email protected]",
        "create_datetime": "2024-06-06T14:05:33",
        "document": 78,
        "version": "1.0",
        "document_path": "/v1/api/dm/download/78/1.0",
        "update_datetime": null
    }
}

HTTP Responses

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

Document Operations - Update Document PUT /v1/api/dm/update/

Resource URL/v1/api/dm/update/
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
document_namestring document name
uploaded_userstring uploaded user
document_statusinteger document status
document_categoryinteger document category
expire_datetimedatetime formatted expire datetime
meta_datastring meta data
versioninteger version
fileUploadFile File to upload

Example Request

curl -X 'PUT' \
'https://dms-be.braegen.ai/v1/api/dm/update' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'uploaded_user=' \
-F 'document_id=78'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Document Updated Successfully",
    "results": {
        "document_name": "Don data",
        "uploaded_user": "[email protected]",
        "is_deleted": false,
        "expire_datetime": "2024-08-18 04:37:30",
        "update_datetime": "2024-06-06 14:18:47",
        "id": 78,
        "document_format": ".png",
        "create_datetime": "2024-06-06 14:05:33",
        "document_versions": [
        {
            "id": 70,
            "create_user": "[email protected]",
            "is_active": true,
            "create_datetime": "2024-06-06 14:05:33",
            "version": "1.0",
            "document_path": "/v1/api/dm/download/78/1.0",
            "update_datetime": "None"
        }
        ],
        "category": {
        "create_user": "[email protected]",
        "category": {
            "category": "Finance",
            "description": "Documents related to financial matters",
            "id": 1,
            "create+datetime": "2024-02-28 08:00:00"
        },
        "meta_data": "{}",
        "id": 58,
        "create_datetime": "2024-06-06 14:05:33"
        },
        "status": {
        "id": 2,
        "status_name": "Approved",
        "description": "Document has been approved",
        "create_datetime": "2024-02-28 09:30:00"
        }
    }
}

HTTP Responses

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

Document Operations - Document Enable Disable PATCH /v1/api/dm/document/{document_id}/{is_disabled}

Resource URL/v1/api/dm/document/{document_id}/{is_disabled}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
is_disabledbool Document is disabled or not

Example Request

curl -X 'PATCH' \
'https://dms-be.braegen.ai/v1/api/dm/document/78/false' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Enable document success",
    "results": {
        "document_id": 78
    }
}

HTTP Responses

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

Document Operations - Document Version Enable Disable PATCH /v1/api/dm/document/{document_id}/{version}/{is_disabled}

Resource URL/v1/api/dm/document/{document_id}/{version}/{is_disabled}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
versionstring Document version
is_disabledbool Document is disabled or not

Example Request

curl -X 'PATCH' \
'https://dms-be.braegen.ai/v1/api/dm/document_version/78/1.0/true' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Disable document version success",
    "results": {
        "document_id": 78,
        "version": "1.0"
    }
}

HTTP Responses

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

Document Operations - Delete Document Version DELETE /v1/api/dm/delete_document_version/{document_id}/{version}

Resource URL/v1/api/dm/delete_document_version/{document_id}/{version}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

document_iddocument_id must be added from referenced add private/public api calls
versionversion must be added from referenced add private/public api calls

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Delete Document Version success",
    "results": {
        "document_id": 78,
        "version": "1.0"
    }
}

HTTP Responses

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

Previous

Category Management

Next

Status Management

On this page

Document OperationsDocument Operations - Add Document GET /v1/api/dm/upload/ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Get Document Versions GET /v1/api/dm/document_versions/ParametersExample RequestHTTP ResponsesHTTP ResponsesDocument Operations - Download Document GET /v1/api/dm/download/{document_id}/{version}ParametersExample RequestHTTP ResponsesHTTP RequestHTTP ResponsesDocument Operations - Get All Documents GET /v1/api/dm/get_all/Example RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Get Document By Id GET /v1/api/dm/get_by_id/{document_id}ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Get Document Version GET /v1/api/dm/get_document_version/{document_id}/{version}ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Update Document PUT /v1/api/dm/update/ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Document Enable Disable PATCH /v1/api/dm/document/{document_id}/{is_disabled}ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Document Version Enable Disable PATCH /v1/api/dm/document/{document_id}/{version}/{is_disabled}ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesDocument Operations - Delete Document Version DELETE /v1/api/dm/delete_document_version/{document_id}/{version}ParametersExample RequestHTTP ResponsesExample ResponseHTTP Responses