Справочники API 1.7.0

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

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

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

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

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

`GET /directories`

Раздел: Справочники.

Возвращает список всех справочников со значениями

Источник в Teamly

Назначение	URL запроса
Возвращает список всех справочников со значениями	https://{IP_контроллера}/api/v1/directories

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

Отсутствуют

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

Code 200 (Successfully returned list of directories) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
name*	string	minLength: 1	Название справочника
value_type*	string	[ string, integer]	Тип данных справочника
values*	string		Список значений справочника

Пример:

[
  {
    "name": "string",
    "value_type": "string",
    "values": [
      "string"
    ]
  }
]

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

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

{
  "description": "Returns list of directories",
  "parameters": [],
  "responses": {
    "200": {
      "description": "Successfully returned list of directories",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "value_type",
                "values"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1
                },
                "value_type": {
                  "type": "string",
                  "enum": [
                    "string",
                    "integer"
                  ]
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "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/directories" \
  -H "Authorization: Bearer <token>"

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

[
  {
    "name": "string",
    "value_type": "string",
    "values": [
      "string"
    ]
  }
]

`POST /directories`

Раздел: Справочники.

Добавляет новый справочник

Источник в Teamly

Назначение	URL запроса
Добавляет новый справочник	https://{IP_контроллера}/api/v1/directories

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

Название	Тип	Описание
directory *	object (body)	Тело запроса
BODY
Название * - обязательный	Тип	Формат	Назначение
name*	string	minLength: 1	Название справочника
value_type*	string	[string, integer]	Тип данных справочника
values*	string		Список значений справочника

Пример:

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

Body

Пример с исправленным синтаксисом JSON

Закрыты кавычки последнего значения массива.

{
        "name": "График работы",
        "value_type": "string",
        "values": [
            "Пятидневка",
            "Шестидневка",
            "Сменный 2Х2"
        ]
    }

Исходный пример Teamly

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
        "name": "График работы",
        "value_type": "string",
        "values": [
            "Пятидневка",
            "Шестидневка",
            "Сменный 2Х2
        ]
    }

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

Code 201 (Successfully) - удачное выполнение запроса

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

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

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

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

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

{
  "description": "Add new directory",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "name",
            "value_type",
            "values"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1
            },
            "value_type": {
              "type": "string",
              "enum": [
                "string",
                "integer"
              ]
            },
            "values": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Derectory has been successfully added"
    },
    "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": "Directory 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/directories" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}'

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

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

`GET /directories/{name}`

Раздел: Справочники.

Возвращает список значений конкретного справочника

Источник в Teamly

Назначение	URL запроса
Возвращает список значений конкретного справочника	https://{IP_контроллера}/api/v1/directories/{name}

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

Наименование	Описание
name* string (path)	Название справочника

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

Code 200 (Successfully returned list of directories) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
name*	string	minLength: 1	Название справочника
value_type*	string	[string, integer]	Тип данных справочника
values*	string		Список значений справочника

Пример:

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

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

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

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

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

{
  "description": "Get specified directory by name",
  "parameters": [
    {
      "name": "name",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully got directory with specified name",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "name",
              "value_type",
              "values"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1
              },
              "value_type": {
                "type": "string",
                "enum": [
                  "string",
                  "integer"
                ]
              },
              "values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "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 directory 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/directories/{name}" \
  -H "Authorization: Bearer <token>"

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

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

`PUT /directories/{name}`

Раздел: Справочники.

Редактирует существующий справочник

Источник в Teamly

Назначение	URL запроса
Редактирует существующий справочник	https://{IP_контроллера}/api/v1/directories/{name}

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

Название	Тип	Описание
nane*	string (path)	Имя справочника
BODY
Название * - обязательный	Тип	Формат	Назначение
name*	string	minLength: 1	Название справочника
value_type*	string	[string, integer]	Тип данных справочника
values*	string		Список значений справочник

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

Code 201 (Successfully) - удачное выполнение запроса

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

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

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

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

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

{
  "description": "Update specified directory data",
  "parameters": [
    {
      "name": "name",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "name",
            "value_type",
            "values"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1
            },
            "value_type": {
              "type": "string",
              "enum": [
                "string",
                "integer"
              ]
            },
            "values": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successfully updated directory with specified name",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "name",
              "value_type",
              "values"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1
              },
              "value_type": {
                "type": "string",
                "enum": [
                  "string",
                  "integer"
                ]
              },
              "values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "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 directory 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/directories/{name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}'

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

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

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

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}

`DELETE /directories/{name}`

Раздел: Справочники.

Удаляет существующий справочник

Источник в Teamly

Назначение	URL запроса
Удаляет существующий справочник	https://{IP_контроллера}/api/v1/directories/{name}

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

Наименование, * - обязательный	Описание
name* string (path)	Имя справочника

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

Code 200 (Successfully returned staff page) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

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

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

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

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

{
  "description": "Delete specified directory data",
  "parameters": [
    {
      "name": "name",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successfully deleted directory",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "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 directory 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/directories/{name}" \
  -H "Authorization: Bearer <token>"

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

{
  "success": false,
  "message": "string",
  "data": {}
}

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

GET /directories​

Примеры по OpenAPI​

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

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

POST /directories​

Примеры по OpenAPI​

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

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

GET /directories/{name}​

Примеры по OpenAPI​

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

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

PUT /directories/{name}​

Примеры по OpenAPI​

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

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

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

DELETE /directories/{name}​

Примеры по OpenAPI​

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

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

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

`GET /directories`

Примеры по OpenAPI

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

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

`POST /directories`

Примеры по OpenAPI

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

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

`GET /directories/{name}`

Примеры по OpenAPI

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

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

`PUT /directories/{name}`

Примеры по OpenAPI

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

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

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

`DELETE /directories/{name}`

Примеры по OpenAPI

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

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