Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.
Hypothesis14 палёў
idinteger · int32
Id.
namestring
Назва.
previousStartDatestring · date-time
Папярэдняя дата пачатку.
startDatestring · date-time
Пачатак дата.
endDatestring · date-time
Завяршальная дата.
modelIdinteger · int64
Мадэль ID.
modelArticlestring
Мадэль артыкула.
viewIdinteger · int64
Паглядзіце ID.
productIdinteger · int64
Ід прадукту.
organizationIdinteger · int64
Ід арганізацыі.
createdDatestring · date-time
Стварыўся Дата.
createdUserstring
Створаны карыстальнік.
servicestring
Паслуга.
successStatusstring
Статус поспеху.
FindResponseHypothesis1 палёў
rowsHypothesis[]
Рыжкі.
Памылка дагавор
Як вяртаюць памылкі прыкладання
Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.
error
Стабільны машыначытай код для інтэграцыйнай логікі.
localMessage
Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.
params
Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.
文
localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.
RUМясцовасць карыстальніка ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
BEБеларуская (be)
{
"error": "error_brand_already_exists",
"localMessage": "Брэнд Base ужо існуе",
"params": {
"name": "Base"
}
}
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_empty_end_date
Не пазначана дата заканчэння
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_end_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_empty_name
Не пазначана назва
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_name ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_empty_start_date
Не указана дата начала
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_start_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_end_less_then_start_date
Дата заканчэння павінна быць большай за дату пачатку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_end_less_then_start_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
GET
Ід
/api/hypothesis/{id}
Значок з чытальным доступам
ID з выкарыстаннем GET /api/hypothesis/{id}.
Параметры шляху
Поле
Тып
Абавязкова
Апісанне
id
integer · int32
Так
Id.
curl --request GET 'https://api.selsup.ru/api/hypothesis/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
PATCH
Гіпатэза патча
/api/hypothesis/{id}
Знак з пісьмовым доступам
Гіпатэза патча з выкарыстаннем PATCH /api/hypothesis/{id}.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_empty_end_date
Не пазначана дата заканчэння
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_end_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_empty_id
Не пазначаны ідэнтыфікатар
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_id ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_empty_name
Не пазначана назва
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_name ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_empty_start_date
Не указана дата начала
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_empty_start_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_end_less_then_start_date
Дата заканчэння павінна быць большай за дату пачатку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_end_less_then_start_date ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
DELETE
Знішчыць гіпотэзу
/api/hypothesis/{id}
Знак з пісьмовым доступам
Знішчыць гіпотэзу з дапамогай DELETE /api/hypothesis/{id}.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.