Изображения планов контроля доступа API 1.7.0

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

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

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

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

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

`POST /plan_images`

Раздел: Изображения планов контроля доступа.

Сохраняет новое изображение плана контроля доступа.

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

{
  "description": "Save new access control plan 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": "Access control plan 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": "Access control plan 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/plan_images" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "image_data": "string"
}'

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

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

`GET /plan_images/{uuid}`

Раздел: Изображения планов контроля доступа.

Возвращает изображение плана контроля доступа по UUID.

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

{
  "description": "Get access control plan image by UUID",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully returned access control plan 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 access control plan 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/plan_images/{uuid}" \
  -H "Authorization: Bearer <token>"

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

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

`PUT /plan_images/{uuid}`

Раздел: Изображения планов контроля доступа.

Заменяет изображение новым.

Параметры и ответы по 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": "Access control plan 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 access control plan 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/plan_images/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "image_data": "string"
}'

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

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

`DELETE /plan_images/{uuid}`

Раздел: Изображения планов контроля доступа.

Удаляет изображение плана контроля доступа.

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

{
  "description": "Replace image with new",
  "parameters": [
    {
      "in": "path",
      "name": "uuid",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "201": {
      "description": "Access control plan 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 access control plan 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/plan_images/{uuid}" \
  -H "Authorization: Bearer <token>"

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

POST /plan_images​

Примеры по OpenAPI​

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

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

GET /plan_images/{uuid}​

Примеры по OpenAPI​

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

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

PUT /plan_images/{uuid}​

Примеры по OpenAPI​

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

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

DELETE /plan_images/{uuid}​

Примеры по OpenAPI​

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

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

`POST /plan_images`

Примеры по OpenAPI

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

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

`GET /plan_images/{uuid}`

Примеры по OpenAPI

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

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

`PUT /plan_images/{uuid}`

Примеры по OpenAPI

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

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

`DELETE /plan_images/{uuid}`

Примеры по OpenAPI

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