Изображения API 1.7.0

Методы API для работы с разделом «Изображения».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела

Метод	Путь
`POST`	`/images`
`GET`	`/images/{uuid}`
`PUT`	`/images/{uuid}`
`DELETE`	`/images/{uuid}`

`POST /images`

Раздел: Изображения.

Добавляет новую фотографию персоне

Источник в Teamly

Назначение	URL запроса
Добавляет новую фотографию персоне	https://{IP_контроллера}/api/v1/images

Параметры запроса:

Название	Тип	Описание
image_data*	object(body)	Тело запроса
BODY
Название * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	UUID персоны
image_data*	string	$byte[]	Бинарные данные изображения

Пример:

URL запроса: POST
https://{IP_контроллера}/api/v1/images

Body

{
  "uuid": "9c362f3d-9d7e-4ae7-a572-86c497d97d0c",
  "image_data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAoHBwgHBgoICAgLCgoLDhgQDg0NDh0VFhEYIx8lJCIfIiEmKzcvJik0KSEiMEExNDk7"
}

Варианты ответа:

Code 201 (mage has been successfully saved) - удачное выполнение запроса

{ 
  "success": true,  
  "message": "string"
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 409 (Image already exists) - запрос не выполнен, указанное изображение уже добавлено

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Save new image",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "image_data"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "image_data": {
              "type": "string",
              "format": "byte[]"
            }
          }
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "description": "Image has been successfully saved"
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Image already exists",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X POST "https://{IP_контроллера}/api/v1/images" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "image_data": "string"
}'

Пример тела запроса

{
  "uuid": "string",
  "image_data": "string"
}

`GET /images/{uuid}`

Раздел: Изображения.

Возвращает фотографию персоны по UUID

Источник в Teamly

Назначение	URL запроса
Возвращает фотографию персоны по UUID	https://{IP_контроллера}/api/v1/images/{uuid}

Параметры запроса:

Наименование, * - обязательный	Описание
uuid* string($uuid) (path)	UUID персоны

Варианты ответа:

Code 200 (Successfully returned image with specified UUID) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	UUID персоны
image_data*	string	$byte[]	Бинарные данные изображения

Пример:

{
  "uuid": "string",
  "image_data": "string"
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Specified image does not exist) - запрос не выполнен, указанное изображение не найдено

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Get image by UUID",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully returned image with specified UUID",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "uuid",
              "image_data"
            ],
            "properties": {
              "uuid": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
              },
              "image_data": {
                "type": "string",
                "format": "byte[]"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Specified image does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/images/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример ответа

{
  "uuid": "string",
  "image_data": "string"
}

`PUT /images/{uuid}`

Раздел: Изображения.

Заменяет фотографию персоны по UUID

Источник в Teamly

Назначение	URL запроса
Заменяет фотографию персоны по UUID	https://{IP_контроллера}/api/v1/images/{uuid}

Параметры запроса:

Название	Тип	Описание
uuid *	string($uuid) (path)	UUID персоны
BODY
Название * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	UUID персоны
image_data*	string	$byte[]	Бинарные данные изображения

Пример:

URL запроса: PUT

https://{IP_контроллера}/api/v1/images

Body

{
  "uuid": "9c362f3d-9d7e-4ae7-a572-86c497d97d0c",
  "image_data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAoHBwgHBgoICAgLCgoLDhgQDg0NDh0VFhEYIx8lJCIfIiEmKzcvJik0KSEiMEExNDk7"
}

Варианты ответа:

Code 201 (Image has been successfully saved) - удачное выполнение запроса

{ 
  "success": true,  
  "message": "string"
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Specified image does not exist) - запрос не выполнен, указанное изображение не найдено

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Replace image with new",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "image_data"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "image_data": {
              "type": "string",
              "format": "byte[]"
            }
          }
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "description": "Image has been successfully saved"
    },
    "400": {
      "description": "Invalid UUID",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Specified image does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/images/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "image_data": "string"
}'

Пример тела запроса

{
  "uuid": "string",
  "image_data": "string"
}

`DELETE /images/{uuid}`

Раздел: Изображения.

Удаляет фотографию персоны по UUID

Источник в Teamly

Назначение	URL запроса
Удаляет фотографию персоны по UUID	https://{IP_контроллера}/api/v1/images/{uuid}

Параметры запроса:

Наименование, * - обязательный	Описание
uuid* string($uuid) (path)	UUID персоны

Варианты ответа:

Code 201 (mage has been successfully saved) - удачное выполнение запроса

{ 
  "success": true,  
  "message": "string"
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Specified image does not exist) - запрос не выполнен, указанное изображение не найдено

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Replace image with new",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "201": {
      "description": "Image has been successfully saved"
    },
    "400": {
      "description": "Invalid UUID",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Specified image does not exist",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Something went wrong. It seems there is a bug on server",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X DELETE "https://{IP_контроллера}/api/v1/images/{uuid}" \
  -H "Authorization: Bearer <token>"

Методы раздела​

POST /images​

Примеры по OpenAPI​

Пример запроса​

Пример тела запроса​

GET /images/{uuid}​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

PUT /images/{uuid}​

Примеры по OpenAPI​

Пример запроса​

Пример тела запроса​

DELETE /images/{uuid}​

Примеры по OpenAPI​

Пример запроса​

Методы раздела

`POST /images`

Примеры по OpenAPI

Пример запроса

Пример тела запроса

`GET /images/{uuid}`

Примеры по OpenAPI

Пример запроса

Пример ответа

`PUT /images/{uuid}`

Примеры по OpenAPI

Пример запроса

Пример тела запроса

`DELETE /images/{uuid}`

Примеры по OpenAPI

Пример запроса