API

მენიუს მიღება

GET/api/crm/v2/application.menuv2
operationId: application.menu

მოაბრუნებს მომხმარებლის მენიუს ხის სახით. ძირითადი პუნქტები დალაგებულია sort-ის მიხედვით, საქაღალდეებს აქვთ children, გვერდებს და ბმულებს — readonly_enabled. შემცველობა დამოკიდებულია მომხმარებლის ყველა როლის და მისი პირადი სექციების გაერთიანებაზე. სექციები, რომლებიც მონიშნულია როგორც API წვდომის წერტილი, საერთოდ არ ბრუნდება. საქაღალდე, რომელშიც აღარ დარჩა ხილული პუნქტი, ასევე არ ბრუნდება. ასეთ სექციაზე წვდომა არ იცვლება — სექცია უბრალოდ არ ჩანს მენიუში.

ავტორიზაცია

api-token + language + role

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataarray of object
idintegerსავალდებულო

მაგალითი: 12

slugstringსავალდებულო

მაგალითი: orders

descriptionstringსავალდებულო

მაგალითი: Orders

typestringსავალდებულო

მნიშვნელობები:folderpagelink

მაგალითი: page

sortintegerსავალდებულო

მაგალითი: 1

readonly_enabledboolean

მხოლოდ ტიპებისთვის page და link: განყოფილება ხელმისაწვდომია მხოლოდ წასაკითხად, ნებისმიერი ცვლილების მცდელობა აბრუნებს შეცდომას 100. ითვალისწინება მომხმარებლის ყველა როლი (ჩაწერის უფლება არსებობს, თუ მას მაინც ერთი როლი აძლევს) და განყოფილების პირადი პარამეტრები. საქაღალდეებს ეს ველი არ აქვთ.

მაგალითი: false

childrenarray of object

მხოლოდ ტიპისთვის folder: ჩაშენებული ელემენტები, დალაგებული sort-ის მიხედვით. საქაღალდე, რომელსაც არ აქვს ხელმისაწვდომი ჩაშენებული ელემენტები, არ ბრუნდება.