BREAGEN Logo
Document Management

Status Management

Status Management helps track and control the lifecycle status of documents, enabling users to add, update, retrieve, and delete statuses for better workflow monitoring and management.

Status Management - Add Status POST /v1/api/dm/status/

Resource URL/v1/api/dm/status/
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'POST' \
'https://dms-be.braegen.ai/v1/api/dm/status/' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "status": "Pending",
    "description": "Document is pending review"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Responses

{
    "is_error": false,
    "message": "Create Status Success",
    "results": {
        "description": "Document is pending review",
        "id": 6,
        "status": "Pending",
        "create_datetime": "2024-06-11T07:32:09",
        "documents": []
    }
}

HTTP Responses

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

Status Management - Get All Status GET /v1/api/dm/status/get_all

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

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Get All Statuses Success",
    "results": [
        {
        "status": "Approved",
        "id": 2,
        "description": "Document has been approved",
        "create_datetime": "2024-02-28T09:30:00",
        "documents": []
        },
        {
        "status": "Rejected",
        "id": 3,
        "description": "Document has been rejected",
        "create_datetime": "2024-02-28T10:45:00",
        "documents": []
        },
        {
        "status": "Pending",
        "id": 4,
        "description": "Document is pending review",
        "create_datetime": "2024-06-03T12:02:30",
        "documents": []
        }
    ]
}

HTTP Responses

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

Status Management - Get Status By Id GET /v1/api/dm/status/status_id/{status_id}

Resource URL/v1/api/dm/status/status_id/{status_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get Status Success",
    "results": {
        "status": "pending",
        "id": 4,
        "description": "Document is pending review",
        "create_datetime": "2024-06-06T14:26:41",
        "documents": []
    }
}

HTTP Responses

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

Status Management - Update Status PUT /v1/api/dm/status/{status_id}

Resource URL/v1/api/dm/status/{status_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'PUT' \
'https://ams-be.braegen.ai/v1/status/5' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "status": "Closed"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Get Status Success",
    "results": {
        "description": "Document is pending review",
        "id": 4,
        "status": "Pending",
        "create_datetime": "2024-06-03T12:02:30",
        "documents": []
    }
}

HTTP Responses

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

Status Management - Delete Status DELETE /v1/api/dm/status/{status_id}

Resource URL/v1/api/dm/status/{status_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

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

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Delete Status Success",
    "results": {
        "Successfully deleted status:": 5
    }
}

HTTP Responses

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