{"openapi":"3.0.0","info":{"title":"Bitrix24 REST V3 API","version":"1.0.0"},"servers":[],"tags":[{"name":"main","description":"main module methods"},{"name":"rest","description":"rest module methods"},{"name":"tasks","description":"tasks module methods"}],"paths":{"\/main.eventlog.list":{"post":{"summary":"Метод получения списка","description":"Получить список записей по выбору","tags":["main"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["id","timestampX","severity","auditTypeId","moduleId","itemId","remoteAddr","userAgent","requestUri","siteId","userId","guestId","description"]},"filter":{"type":"array","example":[["id","\u003E=",1],["id",1],["id","in",[1,2,3]]]},"order":{"type":"object","properties":{"id":{"type":"string","example":"ASC"},"timestampX":{"type":"string","example":"ASC"},"auditTypeId":{"type":"string","example":"ASC"},"userId":{"type":"string","example":"ASC"},"guestId":{"type":"string","example":"ASC"}}},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":2},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0}}}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.main.eventlogdto"}}}}}}}}}},"\/main.eventlog.get":{"post":{"summary":"Метод получения элемента","description":"Получить конкретную запись по идентификатору","tags":["main"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":1},"select":{"type":"array","items":{"type":"string"},"example":["id","timestampX","severity","auditTypeId","moduleId","itemId","remoteAddr","userAgent","requestUri","siteId","userId","guestId","description"]}},"required":["id"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.main.eventlogdto"}}}}}}}}}}},"\/main.eventlog.tail":{"post":{"summary":"Метод отслеживания","description":"Получить последние записи","tags":["main"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["id","timestampX","severity","auditTypeId","moduleId","itemId","remoteAddr","userAgent","requestUri","siteId","userId","guestId","description"]},"filter":{"type":"array"},"cursor":{"type":"object","example":{"field":"id","value":0,"order":"ASC"}}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.main.eventlogdto"}}}}}}}}}},"\/rest.documentation.openapi":{"post":{"summary":"Документация Open API","description":"Метод для получения документации продукта в Open API формате","tags":["rest"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":[]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}},"get":{"summary":"Документация Open API","description":"Метод для получения документации продукта в Open API формате","tags":["rest"],"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}}},"\/rest.scope.list":{"post":{"tags":["rest"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"filterModule":{"type":"string","example":"string"},"filterController":{"type":"string","example":"string"},"filterMethod":{"type":"string","example":"string"}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}}},"\/main.eventlog.field.list":{"post":{"tags":["main"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}},"\/main.eventlog.field.get":{"post":{"tags":["main"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"string"},"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}}},"\/tasks.task.chat.message.field.list":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}},"\/tasks.task.chat.message.field.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"string"},"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}}},"\/tasks.task.access.field.list":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}},"\/tasks.task.access.field.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"string"},"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}}},"\/tasks.task.file.field.list":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}},"\/tasks.task.file.field.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"string"},"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}}},"\/tasks.task.field.list":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}},"\/tasks.task.field.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"string"},"select":{"type":"array","items":{"type":"string"},"example":["name","type","title","description","validationRules","requiredGroups","filterable","sortable","editable","multiple","elementType"]}},"required":["name"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.rest.dtofielddto"}}}}}}}}}}},"\/tasks.task.chat.message.send":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"fields":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"taskId":{"type":"integer","format":"int64"},"text":{"type":"string"}},"required":["taskId","text"]}},"required":["fields"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"result":{"type":"boolean"}}}}}}}}}}},"\/tasks.task.access.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":1}},"required":["id"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}}},"\/tasks.task.file.attach":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"taskId":{"type":"integer","example":1},"fileIds":{"type":"array","items":{"type":"integer"}}},"required":["taskId","fileIds"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"result":{"type":"boolean"}}}}}}}}}}},"\/tasks.task.update":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":1},"fields":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"responsibleId":{"type":"integer","format":"int64"},"deadline":{"type":"string","format":"date-time"},"needsControl":{"type":"boolean"},"startPlan":{"type":"string","format":"date-time"},"endPlan":{"type":"string","format":"date-time"},"fileIds":{"type":"array"},"checklist":{"type":"array"},"groupId":{"type":"integer","format":"int64"},"stageId":{"type":"integer","format":"int64"},"epicId":{"type":"integer","format":"int64"},"storyPoints":{"type":"integer","format":"int64"},"flowId":{"type":"integer","format":"int64"},"priority":{"type":"string"},"status":{"type":"string"},"statusChanged":{"type":"string","format":"date-time"},"parentId":{"type":"integer","format":"int64"},"containsChecklist":{"type":"boolean"},"containsSubTasks":{"type":"boolean"},"containsRelatedTasks":{"type":"boolean"},"containsGanttLinks":{"type":"boolean"},"containsPlacements":{"type":"boolean"},"containsResults":{"type":"boolean"},"numberOfReminders":{"type":"integer","format":"int64"},"chatId":{"type":"integer","format":"int64"},"plannedDuration":{"type":"integer","format":"int64"},"actualDuration":{"type":"integer","format":"int64"},"durationType":{"type":"string"},"started":{"type":"string","format":"date-time"},"estimatedTime":{"type":"integer","format":"int64"},"replicate":{"type":"boolean"},"changed":{"type":"string","format":"date-time"},"changedById":{"type":"integer","format":"int64"},"statusChangedById":{"type":"integer","format":"int64"},"closedById":{"type":"integer","format":"int64"},"closed":{"type":"string","format":"date-time"},"activity":{"type":"string","format":"date-time"},"guid":{"type":"string"},"xmlId":{"type":"string"},"exchangeId":{"type":"string"},"exchangeModified":{"type":"string"},"outlookVersion":{"type":"integer","format":"int64"},"mark":{"type":"string"},"allowsChangeDeadline":{"type":"boolean"},"allowsTimeTracking":{"type":"boolean"},"matchesWorkTime":{"type":"boolean"},"addInReport":{"type":"boolean"},"isMultitask":{"type":"boolean"},"siteId":{"type":"string"},"forkedByTemplateId":{"type":"integer","format":"int64"},"deadlineCount":{"type":"integer","format":"int64"},"declineReason":{"type":"string"},"forumTopicId":{"type":"integer","format":"int64"},"link":{"type":"string"},"rights":{"type":"array"},"archiveLink":{"type":"string"},"crmItemIds":{"type":"array"},"reminders":{"type":"array"},"requireResult":{"type":"boolean"},"matchesSubTasksTime":{"type":"boolean"},"autocompleteSubTasks":{"type":"boolean"},"allowsChangeDatePlan":{"type":"boolean"},"emailId":{"type":"integer","format":"int64"},"maxDeadlineChangeDate":{"type":"string","format":"date-time"},"maxDeadlineChanges":{"type":"integer","format":"int64"},"requireDeadlineChangeReason":{"type":"boolean"},"inFavorite":{"type":"array"},"inPin":{"type":"array"},"inGroupPin":{"type":"array"},"inMute":{"type":"array"},"dependsOn":{"type":"array"},"scenarios":{"type":"array"}}},"filter":{"type":"array","example":[["id","\u003E=",1],["id",1],["id","in",[1,2,3]]]}},"required":["fields"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"result":{"type":"boolean"}}}}}}}}}}},"\/tasks.task.delete":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":1},"filter":{"type":"array","example":[["id","\u003E=",1],["id",1],["id","in",[1,2,3]]]}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"result":{"type":"boolean"}}}}}}}}}}},"\/tasks.task.add":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"fields":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"title":{"type":"string"},"description":{"type":"string"},"creatorId":{"type":"integer","format":"int64"},"created":{"type":"string","format":"date-time"},"responsibleId":{"type":"integer","format":"int64"},"deadline":{"type":"string","format":"date-time"},"needsControl":{"type":"boolean"},"startPlan":{"type":"string","format":"date-time"},"endPlan":{"type":"string","format":"date-time"},"fileIds":{"type":"array"},"checklist":{"type":"array"},"groupId":{"type":"integer","format":"int64"},"stageId":{"type":"integer","format":"int64"},"epicId":{"type":"integer","format":"int64"},"storyPoints":{"type":"integer","format":"int64"},"flowId":{"type":"integer","format":"int64"},"priority":{"type":"string"},"status":{"type":"string"},"statusChanged":{"type":"string","format":"date-time"},"parentId":{"type":"integer","format":"int64"},"containsChecklist":{"type":"boolean"},"containsSubTasks":{"type":"boolean"},"containsRelatedTasks":{"type":"boolean"},"containsGanttLinks":{"type":"boolean"},"containsPlacements":{"type":"boolean"},"containsResults":{"type":"boolean"},"numberOfReminders":{"type":"integer","format":"int64"},"chatId":{"type":"integer","format":"int64"},"plannedDuration":{"type":"integer","format":"int64"},"actualDuration":{"type":"integer","format":"int64"},"durationType":{"type":"string"},"started":{"type":"string","format":"date-time"},"estimatedTime":{"type":"integer","format":"int64"},"replicate":{"type":"boolean"},"changed":{"type":"string","format":"date-time"},"changedById":{"type":"integer","format":"int64"},"statusChangedById":{"type":"integer","format":"int64"},"closedById":{"type":"integer","format":"int64"},"closed":{"type":"string","format":"date-time"},"activity":{"type":"string","format":"date-time"},"guid":{"type":"string"},"xmlId":{"type":"string"},"exchangeId":{"type":"string"},"exchangeModified":{"type":"string"},"outlookVersion":{"type":"integer","format":"int64"},"mark":{"type":"string"},"allowsChangeDeadline":{"type":"boolean"},"allowsTimeTracking":{"type":"boolean"},"matchesWorkTime":{"type":"boolean"},"addInReport":{"type":"boolean"},"isMultitask":{"type":"boolean"},"siteId":{"type":"string"},"forkedByTemplateId":{"type":"integer","format":"int64"},"deadlineCount":{"type":"integer","format":"int64"},"declineReason":{"type":"string"},"forumTopicId":{"type":"integer","format":"int64"},"link":{"type":"string"},"rights":{"type":"array"},"archiveLink":{"type":"string"},"crmItemIds":{"type":"array"},"reminders":{"type":"array"},"elapsedTime":{"$ref":"#\/components\/schemas\/bitrix.tasks.elapsedtimedto"},"requireResult":{"type":"boolean"},"matchesSubTasksTime":{"type":"boolean"},"autocompleteSubTasks":{"type":"boolean"},"allowsChangeDatePlan":{"type":"boolean"},"emailId":{"type":"integer","format":"int64"},"maxDeadlineChangeDate":{"type":"string","format":"date-time"},"maxDeadlineChanges":{"type":"integer","format":"int64"},"requireDeadlineChangeReason":{"type":"boolean"},"inFavorite":{"type":"array"},"inPin":{"type":"array"},"inGroupPin":{"type":"array"},"inMute":{"type":"array"},"source":{"$ref":"#\/components\/schemas\/bitrix.tasks.sourcedto"},"dependsOn":{"type":"array"},"scenarios":{"type":"array"}},"required":["title","creatorId","responsibleId"]}},"required":["fields"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.tasks.taskdto"}}}}}}}}}}},"\/tasks.task.get":{"post":{"tags":["tasks"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":1},"select":{"type":"array","items":{"type":"string"},"example":["id","title","description","creatorId","created","responsibleId","deadline","needsControl","startPlan","endPlan","fileIds","checklist","groupId","stageId","epicId","storyPoints","flowId","priority","status","statusChanged","parentId","containsChecklist","containsSubTasks","containsRelatedTasks","containsGanttLinks","containsPlacements","containsResults","numberOfReminders","chatId","plannedDuration","actualDuration","durationType","started","estimatedTime","replicate","changed","changedById","statusChangedById","closedById","closed","activity","guid","xmlId","exchangeId","exchangeModified","outlookVersion","mark","allowsChangeDeadline","allowsTimeTracking","matchesWorkTime","addInReport","isMultitask","siteId","forkedByTemplateId","deadlineCount","declineReason","forumTopicId","link","rights","archiveLink","crmItemIds","reminders","elapsedTime","requireResult","matchesSubTasksTime","autocompleteSubTasks","allowsChangeDatePlan","emailId","maxDeadlineChangeDate","maxDeadlineChanges","requireDeadlineChangeReason","inFavorite","inPin","inGroupPin","inMute","source","dependsOn","scenarios"]}},"required":["id"]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"item":{"$ref":"#\/components\/schemas\/bitrix.tasks.taskdto"}}}}}}}}}}},"\/batch":{"post":{"tags":[],"requestBody":{"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":[],"summary":"Метод Batch","description":"Метод позволяет реализовать вызов нескольких методов в рамках одного запроса"}},"\/documentation":{"post":{"summary":"Документация Open API","description":"Метод для получения документации продукта в Open API формате","tags":["rest"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":[]}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}},"get":{"summary":"Документация Open API","description":"Метод для получения документации продукта в Open API формате","tags":["rest"],"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}}},"\/scopes":{"post":{"tags":["rest"],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"filterModule":{"type":"string","example":"string"},"filterController":{"type":"string","example":"string"},"filterMethod":{"type":"string","example":"string"}}}}}},"responses":{"200":{"description":"Success response","content":{"application\/json":{"schema":{"type":"object","properties":{"result":{"type":"object"}}}}}}}}}},"components":{"schemas":[]}}