Добавить комментарий к заказу со стороны исполнителя
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Метод не принимает orgId. Для заказа в onMatch сервер выбирает одну из организаций, которым доступна запись. Если выбранная организация не является единственной подходящей или это нельзя проверить, остановитесь. Передайте data.orderId и data.content. Идентификатор комментария приходит в data.commentId.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/orders/comments/create/by/executer/v0
Тестовый стенд
Body
application/json
{
"data": {
"content": "example",
"fileContainerId": "example",
"orderId": "example",
"viewers": [
"example"
]
}
}
|
Name |
Description |
|
data |
Type: OrdersCommentsCreateByExecuterV0Request Example
|
OrdersCommentsCreateByExecuterV0Request
|
Name |
Description |
|
content |
Type: string Example: |
|
orderId |
Type: string Example: |
|
fileContainerId |
Type: string | null Example: |
|
viewers |
Type: string[] | null Example
|
Example
{
"content": "example",
"fileContainerId": "example",
"orderId": "example",
"viewers": [
"example"
]
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"commentId": "example"
}
}
|
Name |
Description |
|
data |
Type: OrdersCommentsCreateByExecuterV0Response Example
|
OrdersCommentsCreateByExecuterV0Response
|
Name |
Description |
|
commentId |
Type: string Example: |
Example
{
"commentId": "example"
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|