Створення запиту на формування Аналітичного звіту¶

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту	HTTP POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)
URL запиту	https://doc.edi-n.com/bdoc/report
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	reportType (визначає тип звіту), reportName, companyId, reportStartDate, reportEndDate

JSON-параметри в тілі HTTP запиту/відповіді¶

REQUEST

Опис json-параметрів запиту метода API:

Таблиця 1 - Опис параметрів запиту

Параметр	Mandatory/Optional	Формат	Опис
reportType	M	int	тип звіту; 1 - по зовнішньому документообігу, 2 - по завданням
reportName	M	String	назва звіту
companyId	M	long	ID компанії
reportFilter	O	об’єкт	в залежності від reportType, містить або «partnerCompanyId», або «taskUser» та «taskUserId»
reportStartDate	M	long	дата початку часового періоду звіту (Unix timestamp)
reportEndDate	M	long	дата закінчення часового періоду звіту (Unix timestamp)

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Report)

Таблиця 2 - Опис параметрів об’єкта Report

Параметр	Формат	Опис
	Об’єкт Report
reportName	String	назва звіту
reportId	long	ID звіту
companyId	long	ID компанії
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
dateCreated	long	дата і час запиту на створення звіту (у форматі Unix timestamp)
dateCompleted	long	дата і час створення звіту (у форматі Unix timestamp)
reportType	int	тип звіту; 1 - по зовнішньому документообігу, 2 - по задачам
userId	long	ID користувача
userEmail	String	Email користувача
reportStatus	int	статус звіту; 1 - IN_PROGRESS, 2 - FINISHED
company	Company_	об’єкт; інформація про компанію
reportFilter	ReportDocumentFilter або ReportTaskFilter	змінна, в залежності про типу звіту містить об’єкт ReportDocumentFilter або об’єкт ReportTaskFilter
reportFileLink	String	посилання на файл

Таблиця 3 - Опис параметрів об’єкта ReportDocumentFilter

Параметр	Формат	Опис
	Об’єкт ReportDocumentFilter
companyId	long	ID компанії
company	Company_	об’єкт; інформація про компанію
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
partnerCompanyId	long	ID компанії-партнера
partnerCompany	Company_	об’єкт; об’єкт; інформація про компанію-партнера

Таблиця 4 - Опис параметрів об’єкта ReportTaskFilter

Параметр	Формат	Опис
	Об’єкт ReportTaskFilter
companyId	long	ID компанії
company	Company_	об’єкт; інформація про компанію, за якою вибираються завдання
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
taskUserId	long	ID користувача, за яким вибираються завдання
taskUser	User_	об’єкт; інформація про користувача
taskStatus	int	тип завдання (1 - узгодження; 2 - підписання; 3 - повідомлення)
taskType	int	Статус завдання - 2-in_progress, 3-finished, 4-canceled, 5-expired (До виконання, Виконано, Відхилено, Прострочена )

Приклади¶

Приклад тіла запиту (json) для Створення звіту по зовнішньому документообігу:

{
 "reportType": 1,
 "reportFilter": {
  "partnerCompanyId": 4
 },
 "reportName": "тижневий звіт",
 "companyId": 1313,
 "reportStartDate": 1572566800,
 "reportEndDate": 1575244600
}

Приклад тіла відповіді (json):

{
  "reportName": "тижневий звіт",
  "reportId": 339,
  "companyId": 1319,
  "reportStartDate": 1575244800,
  "reportEndDate": 1575849600,
  "dateCreated": 1575910632,
  "dateCompleted": 0,
  "reportType": 1,
  "userId": 683,
  "userEmail": "[email protected]",
  "reportStatus": 1,
  "company": {
    "companyId": 1319,
    "accountId": 0,
    "type": 0,
    "name": "ТОВ Альбатрос ",
    "code": "01235896",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}