CorpForge

Список документов

GET /v2/corpforge/
Получить список доступных документов.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

[
    {
        "id": "bd3f-4abed70a9f53",
        "type": 0,
        "name": "Тестовый документ",
        "content": "<p>Это текст документа</p>",
        "filename": "test.pdf",
        "accepted": false,
        "disagree": false,
        "publishedAt": "2024-07-26T23:06:51.000Z",
        "updatedAt": "2024-07-26T23:06:51.000Z"
    }
]

Документ по ID

GET /v2/corpforge/:uuid
Получить документ по ID.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

[
    {
        "id": "bd3f-4abed70a9f53",
        "type": 0,
        "name": "Тестовый документ",
        "content": "<p>Это текст документа</p>",
        "filename": "test.pdf",
        "accepted": false,
        "disagree": false,
        "publishedAt": "2024-07-26T23:06:51.000Z",
        "updatedAt": "2024-07-26T23:06:51.000Z"
    }
]

Получить файл

GET /v2/corpforge/:uuid/file
Получить файл из документа.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

streaming file

Получить админ-информацию по ID

GET /v2/corpforge/:uuid/admin
Получить расширенную информацию (для администраторов).

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

[
    {
        "id": "bd3f-4abed70a9f53",
        "type": 0,
        "name": "Тестовый документ",
        "content": "<p>Это текст документа</p>",
        "filename": "test.pdf",
        "accepted": [
            {
                "id": 1,
                "username": "test",
                "avatar": "_defaultUser.jpg",
                "firstName": "Тестовый",
                "lastName": "Пользователь"
            },
        ],
        "disagree": [],
        "publishedAt": "2024-07-26T23:06:51.000Z",
        "updatedAt": "2024-07-26T23:06:51.000Z"
    }
]

Добавить документ

POST /v2/corpforge
Создать новый документ.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
type	int	Тип документа
name	string	Название документа
content	string	Текст в формате HTML
file	file	Файл (опционально)

Response

{
    "status": "OK",
    "msg": "Created"
}

Обновить документ

POST /v2/corpforge/:uuid
Обновить существующий документ по UUID.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
type	int	Тип документа
name	string	Название документа
content	string	Текст в формате HTML
file	file	Файл (опционально)

Response

{
    "status": "OK",
    "msg": "Updated",
}

Действия с документом

PUT /v2/corpforge/:uuid/action
Действия с документом.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
type	int	Действие

Доступные действия:
0 - Согласен/Ознакомлен
1 - Не согласен

Response

{
    "status": "OK",
    "msg": "Signed"
}

Удалить документ

DELETE /v2/corpforge/:uuid
Удалить документ.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

{
    "status": "OK",
    "msg": "Deleted"
}