Перейти к содержанию

База знаний

API методы для модуля wiki

Разделы

Получение списка

GET /wiki/api/space/list

Метод позволяет получить все доступны разделы.

curl 'https://{HOST}.orgstack.ru/wiki/api/space/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "title": "some_string",
            "slug": "some_string",
            "is_archived": true,
            "is_public": true,
            "icon": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "description": "some_string",
            "home_article_id": 123,
            "order": 123,
            "access": "array[orgschema.access_item]",
            "access_edit": "array[orgschema.access_item]"
        },
        {
            "id": 123,
            "title": "some_string",
            "slug": "some_string",
            "is_archived": true,
            "is_public": true,
            "icon": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "description": "some_string",
            "home_article_id": 123,
            "order": 123,
            "access": "array[orgschema.access_item]",
            "access_edit": "array[orgschema.access_item]"
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
title Заголовок string -
slug Человекочитаемый URL string -
is_archived Статус архивации bool -
is_public Статус публичности bool -
icon Иконка string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
description Описание string -
home_article_id ID домашей страницы int -
order Сортировка int -
access Должности, которые могут просматривать раздел array[orgschema.access_item] -
access_edit Должности, которые могут редактировать раздел array[orgschema.access_item] -

Сохранение

POST /wiki/api/space/save

Метод позволяет создать новый раздел или изменить существующий.

curl 'https://{HOST}.orgstack.ru/wiki/api/space/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"title":"some_string","slug":"some_string","is_archived":true,"is_public":true,"icon":"some_string","creation_date":"2019-01-01 21:00:15","modification_date":"2019-01-01 21:00:15","description":"some_string","home_article_id":123,"order":123,"access":"array[orgschema.access_item]","access_edit":"array[orgschema.access_item]"}'
{
    "status": "success",
    "data": {
        "id": 123,
        "title": "some_string",
        "slug": "some_string",
        "is_archived": true,
        "is_public": true,
        "icon": "some_string",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "description": "some_string",
        "home_article_id": 123,
        "order": 123,
        "access": "array[orgschema.access_item]",
        "access_edit": "array[orgschema.access_item]"
    }
}
Параметр Описание Тип Значения
id ID int -
title Заголовок string -
slug Человекочитаемый URL string -
is_archived Статус архивации bool -
is_public Статус публичности bool -
icon Иконка string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
description Описание string -
home_article_id ID домашей страницы int -
order Сортировка int -
access Должности, которые могут просматривать раздел array[orgschema.access_item] -
access_edit Должности, которые могут редактировать раздел array[orgschema.access_item] -
Параметр Описание Тип Значения
id ID int -
title Заголовок string -
slug Человекочитаемый URL string -
is_archived Статус архивации bool -
is_public Статус публичности bool -
icon Иконка string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
description Описание string -
home_article_id ID домашей страницы int -
order Сортировка int -
access Должности, которые могут просматривать раздел array[orgschema.access_item] -
access_edit Должности, которые могут редактировать раздел array[orgschema.access_item] -

Удаление

POST /wiki/api/space/archive

Метод позволяет скрыть раздел для всех пользователей, сделав его доступным только администратору базы знаний. Все статьи раздела при этом будут удалены.

curl 'https://{HOST}.orgstack.ru/wiki/api/space/archive' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* ID раздела int -

bool

Статьи

Получение списка

GET /wiki/api/article/list

Метод позволяет получить все доступные статьи одного или всех разделов.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"space_id":123}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "space_ids": [
                123,
                123
            ],
            "title": "some_string",
            "slug": "some_string",
            "is_draft": true,
            "content_blocks": "array[wiki.content_block]",
            "parent_ids": [
                123,
                123
            ],
            "author_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "access": "array[orgschema.access_item]",
            "access_edit": "array[orgschema.access_item]",
            "orders": "array",
            "view_count": 123,
            "viewed_user_ids": [
                "some_string",
                "some_string"
            ]
        },
        {
            "id": 123,
            "space_ids": [
                123,
                123
            ],
            "title": "some_string",
            "slug": "some_string",
            "is_draft": true,
            "content_blocks": "array[wiki.content_block]",
            "parent_ids": [
                123,
                123
            ],
            "author_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "access": "array[orgschema.access_item]",
            "access_edit": "array[orgschema.access_item]",
            "orders": "array",
            "view_count": 123,
            "viewed_user_ids": [
                "some_string",
                "some_string"
            ]
        }
    ]
}
Параметр Описание Тип Значения
space_id ID Раздела int -
Параметр Описание Тип Значения
id ID int -
space_ids ID раздела. На данный момент осуществляется поддержка только одного раздела. array[int] -
title Заголовок string -
slug Человекочитаемый URL string -
is_draft Статус публикации bool -
content_blocks Контент блоки array[wiki.content_block] -
parent_ids ID родителя. На данный момент осуществляется поддержка только одного родителя. array[int] -
author_id ID автора string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
access Должности, которые могут просматривать статью array[orgschema.access_item] -
access_edit Должности, которые могут редактировать статью array[orgschema.access_item] -
orders Сортировка array -
view_count Количество просмотров int -
viewed_user_ids ID просмотревших пользователей array[string] -

Получение

GET /wiki/api/article/get

Метод позволяет получить статью по её ID.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/get' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'
{
    "status": "success",
    "data": {
        "id": 123,
        "space_ids": [
            123,
            123
        ],
        "title": "some_string",
        "slug": "some_string",
        "is_draft": true,
        "content_blocks": "array[wiki.content_block]",
        "parent_ids": [
            123,
            123
        ],
        "author_id": "some_string",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "access": "array[orgschema.access_item]",
        "access_edit": "array[orgschema.access_item]",
        "orders": "array",
        "view_count": 123,
        "viewed_user_ids": [
            "some_string",
            "some_string"
        ]
    }
}
Параметр Описание Тип Значения
id* ID статьи int -
Параметр Описание Тип Значения
id ID int -
space_ids ID раздела. На данный момент осуществляется поддержка только одного раздела. array[int] -
title Заголовок string -
slug Человекочитаемый URL string -
is_draft Статус публикации bool -
content_blocks Контент блоки array[wiki.content_block] -
parent_ids ID родителя. На данный момент осуществляется поддержка только одного родителя. array[int] -
author_id ID автора string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
access Должности, которые могут просматривать статью array[orgschema.access_item] -
access_edit Должности, которые могут редактировать статью array[orgschema.access_item] -
orders Сортировка array -
view_count Количество просмотров int -
viewed_user_ids ID просмотревших пользователей array[string] -

Сохранение

POST /wiki/api/article/save

Метод позовляет создать статью или изменить существующую.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"space_ids":[123,123],"title":"some_string","slug":"some_string","content_blocks":"array[wiki.content_block]","parent_ids":[123,123],"access":"array[orgschema.access_item]","access_edit":"array[orgschema.access_item]","orders":"array"}'
{
    "status": "success",
    "data": {
        "id": 123,
        "space_ids": [
            123,
            123
        ],
        "title": "some_string",
        "slug": "some_string",
        "is_draft": true,
        "content_blocks": "array[wiki.content_block]",
        "parent_ids": [
            123,
            123
        ],
        "author_id": "some_string",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "access": "array[orgschema.access_item]",
        "access_edit": "array[orgschema.access_item]",
        "orders": "array",
        "view_count": 123,
        "viewed_user_ids": [
            "some_string",
            "some_string"
        ]
    }
}
Параметр Описание Тип Значения
id ID int -
space_ids ID раздела. На данный момент осуществляется поддержка только одного раздела. array[int] -
title Заголовок string -
slug Человекочитаемый URL string -
content_blocks Контент блоки array[wiki.content_block] -
parent_ids ID родителя. На данный момент осуществляется поддержка только одного родителя. array[int] -
access Должности, которые могут просматривать статью array[orgschema.access_item] -
access_edit Должности, которые могут редактировать статью array[orgschema.access_item] -
orders Сортировка array -
Параметр Описание Тип Значения
id ID int -
space_ids ID раздела. На данный момент осуществляется поддержка только одного раздела. array[int] -
title Заголовок string -
slug Человекочитаемый URL string -
is_draft Статус публикации bool -
content_blocks Контент блоки array[wiki.content_block] -
parent_ids ID родителя. На данный момент осуществляется поддержка только одного родителя. array[int] -
author_id ID автора string -
creation_date Дата создания date -
modification_date Дата последнего изменения date -
access Должности, которые могут просматривать статью array[orgschema.access_item] -
access_edit Должности, которые могут редактировать статью array[orgschema.access_item] -
orders Сортировка array -
view_count Количество просмотров int -
viewed_user_ids ID просмотревших пользователей array[string] -

Удаление

POST /wiki/api/article/delete

Метод позволяет удалить статью по её ID.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* ID статьи int -

bool

Получение списка версий

GET /wiki/api/article/versions

Метод позволяет получить список версий статьи по её ID.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/versions' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"article_id":123}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "article_id": 123,
            "title": "some_string",
            "content_blocks": "array[wiki.content_block]",
            "date": "2019-01-01 21:00:15",
            "author_id": "some_string"
        },
        {
            "id": 123,
            "article_id": 123,
            "title": "some_string",
            "content_blocks": "array[wiki.content_block]",
            "date": "2019-01-01 21:00:15",
            "author_id": "some_string"
        }
    ]
}
Параметр Описание Тип Значения
article_id* ID статьи int -
Параметр Описание Тип Значения
id ID int -
article_id ID статьи int -
title Заголовок статьи string -
content_blocks Контент блоки array[wiki.content_block] -
date Дата date -
author_id ID автора string -

Получение списка вопросов

GET /wiki/api/article/get-questions

Метод позволяет получить список вопросов статьи.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/get-questions' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"article_id":123}'
{
    "status": "success",
    "data": {
        "id": 123,
        "article_id": 123,
        "title": "some_string",
        "type": "some_string",
        "is_exam": true,
        "points": 123,
        "variants": "array[wiki.question_variant]"
    }
}
Параметр Описание Тип Значения
article_id* ID статьи int -
Параметр Описание Тип Значения
id ID int -
article_id ID статьи int -
title Текст вопроса string -
type Тип string -
is_exam Является ли экзаменационным bool -
points Количество баллов за верный ответ int -
variants Варианты ответа array[wiki.question_variant] -

Сохранение вопроса статьи

POST /wiki/api/article/save-question

Метод позволяет создать вопрос к статье или изменить существующий.

curl 'https://{HOST}.orgstack.ru/wiki/api/article/save-question' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"article_id":123,"title":"some_string","type":"some_string","points":123,"variants":"array[wiki.question_variant]"}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "article_id": 123,
            "title": "some_string",
            "type": "some_string",
            "is_exam": true,
            "points": 123,
            "variants": "array[wiki.question_variant]"
        },
        {
            "id": 123,
            "article_id": 123,
            "title": "some_string",
            "type": "some_string",
            "is_exam": true,
            "points": 123,
            "variants": "array[wiki.question_variant]"
        }
    ]
}
Параметр Описание Тип Значения
id ID int -
article_id ID статьи int -
title Текст вопроса string -
type Тип string -
points Количество баллов за верный ответ int -
variants Варианты ответа array[wiki.question_variant] -
Параметр Описание Тип Значения
id ID int -
article_id ID статьи int -
title Текст вопроса string -
type Тип string -
is_exam Является ли экзаменационным bool -
points Количество баллов за верный ответ int -
variants Варианты ответа array[wiki.question_variant] -

Курсы

Получение списка

GET /wiki/api/course/list

Метод позволяет получить список курсов.

curl 'https://{HOST}.orgstack.ru/wiki/api/course/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "title": "some_string",
            "description": "some_string",
            "cover_file_id": 123,
            "steps": "array[wiki.course_step]",
            "is_deleted": true,
            "access_blocks": "array[orgschema.access_item]",
            "blocks_assign_date": "map",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "instructors": [
                "some_string",
                "some_string"
            ],
            "author_id": "some_string",
            "is_periodic": true
        },
        {
            "id": 123,
            "title": "some_string",
            "description": "some_string",
            "cover_file_id": 123,
            "steps": "array[wiki.course_step]",
            "is_deleted": true,
            "access_blocks": "array[orgschema.access_item]",
            "blocks_assign_date": "map",
            "creation_date": "2019-01-01 21:00:15",
            "modification_date": "2019-01-01 21:00:15",
            "instructors": [
                "some_string",
                "some_string"
            ],
            "author_id": "some_string",
            "is_periodic": true
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
title Название string -
description Описание string -
cover_file_id ID файла-обложки int -
steps Шаги курса array[wiki.course_step] -
is_deleted Является ли удаленным bool -
access_blocks Должности, которым назначен курс array[orgschema.access_item] -
blocks_assign_date Дата назначения курса каждой должности map -
creation_date Дата создания date -
modification_date Дата изменения date -
instructors ID инструкторов array[string] -
author_id ID автора string -
is_periodic Является ли автоматическим курсом контроля знаний bool -

Сохранение

POST /wiki/api/course/save

Метод позволяет сохранить курс.

curl 'https://{HOST}.orgstack.ru/wiki/api/course/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"title":"some_string","description":"some_string","cover_file_id":123,"steps":"array[wiki.course_step]"}'
{
    "status": "success",
    "data": {
        "id": 123,
        "title": "some_string",
        "description": "some_string",
        "cover_file_id": 123,
        "steps": "array[wiki.course_step]",
        "is_deleted": true,
        "access_blocks": "array[orgschema.access_item]",
        "blocks_assign_date": "map",
        "creation_date": "2019-01-01 21:00:15",
        "modification_date": "2019-01-01 21:00:15",
        "instructors": [
            "some_string",
            "some_string"
        ],
        "author_id": "some_string",
        "is_periodic": true
    }
}
Параметр Описание Тип Значения
id ID int -
title Название string -
description Описание string -
cover_file_id ID файла-обложки int -
steps Шаги курса array[wiki.course_step] -
Параметр Описание Тип Значения
id ID int -
title Название string -
description Описание string -
cover_file_id ID файла-обложки int -
steps Шаги курса array[wiki.course_step] -
is_deleted Является ли удаленным bool -
access_blocks Должности, которым назначен курс array[orgschema.access_item] -
blocks_assign_date Дата назначения курса каждой должности map -
creation_date Дата создания date -
modification_date Дата изменения date -
instructors ID инструкторов array[string] -
author_id ID автора string -
is_periodic Является ли автоматическим курсом контроля знаний bool -

Удаление

POST /wiki/api/course/delete

Метод позволяет удалить курс.

curl 'https://{HOST}.orgstack.ru/wiki/api/course/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID курса int -

bool