Skip to content

ParametersApi.md

Latest commit

 

History

History
437 lines (270 loc) · 14.3 KB

ParametersApi.md

File metadata and controls

437 lines (270 loc) · 14.3 KB

ParametersApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2ParametersBulkPost POST /api/v2/parameters/bulk Create multiple parameters
apiV2ParametersBulkPut PUT /api/v2/parameters/bulk Update multiple parameters
apiV2ParametersGroupsGet GET /api/v2/parameters/groups Get parameters as group
apiV2ParametersKeyNameNameExistsGet GET /api/v2/parameters/key/name/{name}/exists Check existence parameter key in system
apiV2ParametersKeyValuesGet GET /api/v2/parameters/{key}/values Get all parameter key values
apiV2ParametersKeysGet GET /api/v2/parameters/keys Get all parameter keys
apiV2ParametersSearchPost POST /api/v2/parameters/search Search for parameters
createParameter POST /api/v2/parameters Create parameter
deleteByName DELETE /api/v2/parameters/name/{name} Delete parameter by name
deleteByParameterKeyId DELETE /api/v2/parameters/keyId/{keyId} Delete parameters by parameter key identifier
deleteParameter DELETE /api/v2/parameters/{id} Delete parameter
getAllParameters GET /api/v2/parameters Get all parameters
getParameterById GET /api/v2/parameters/{id} Get parameter by ID
obsoleteDeleteByName POST /api/v2/parameters/deleteByName
updateParameter PUT /api/v2/parameters Update parameter

apiV2ParametersBulkPost

List apiV2ParametersBulkPost(ParameterPostModel)

Create multiple parameters

<br>Use case  <br>User sets list of parameter model (listed in the request example)  <br>User runs method execution  <br>System creates parameters  <br>System returns list of parameter model (listed in the response example)

Parameters

Name Type Description Notes
ParameterPostModel List [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2ParametersBulkPut

apiV2ParametersBulkPut(ParameterPutModel)

Update multiple parameters

<br>Use case  <br>User sets list of parameter model (listed in the request example)  <br>User runs method execution  <br>System updates parameters

Parameters

Name Type Description Notes
ParameterPutModel List [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2ParametersGroupsGet

List apiV2ParametersGroupsGet(isDeleted, parameterKeyIds, Skip, Take, OrderBy, SearchField, SearchValue)

Get parameters as group

<br>Use case  <br>User runs method execution  <br>System search parameters  <br>System returns parameters models as groups (listed in the response example)

Parameters

Name Type Description Notes
isDeleted Boolean [optional] [default to null]
parameterKeyIds Set [optional] [default to null]
Skip Integer Amount of items to be skipped (offset) [optional] [default to null]
Take Integer Amount of items to be taken (limit) [optional] [default to null]
OrderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2ParametersKeyNameNameExistsGet

Boolean apiV2ParametersKeyNameNameExistsGet(name)

Check existence parameter key in system

<br>Use case  <br>User sets name of parameter key  <br>User runs method execution  <br>System search parameter key  <br>System returns the flag for the existence of the parameter key in the system

Parameters

Name Type Description Notes
name String [default to null]

Return type

Boolean

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2ParametersKeyValuesGet

List apiV2ParametersKeyValuesGet(key)

Get all parameter key values

<br>Use case  <br>User sets parameter key (string format)  <br>User runs method execution  <br>System search parameter values using the key  <br>System returns parameter

Parameters

Name Type Description Notes
key String Parameter key (string format) [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2ParametersKeysGet

List apiV2ParametersKeysGet()

Get all parameter keys

<br>Use case  <br>User runs method execution  <br>System search all parameter keys  <br>System returns parameter keys

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2ParametersSearchPost

List apiV2ParametersSearchPost(Skip, Take, OrderBy, SearchField, SearchValue, ParameterFilterModel)

Search for parameters

Parameters

Name Type Description Notes
Skip Integer Amount of items to be skipped (offset) [optional] [default to null]
Take Integer Amount of items to be taken (limit) [optional] [default to null]
OrderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
ParameterFilterModel ParameterFilterModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createParameter

ParameterModel createParameter(ParameterPostModel)

Create parameter

<br>Use case  <br>User sets parameter model (listed in the request example)  <br>User runs method execution  <br>System creates parameter  <br>System returns parameter model

Parameters

Name Type Description Notes
ParameterPostModel ParameterPostModel [optional]

Return type

ParameterModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteByName

deleteByName(name)

Delete parameter by name

Deletes parameter and all it's values

Parameters

Name Type Description Notes
name String Name of the parameter [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteByParameterKeyId

deleteByParameterKeyId(keyId)

Delete parameters by parameter key identifier

Deletes parameter and all it's values by parameter key identifier

Parameters

Name Type Description Notes
keyId UUID [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteParameter

deleteParameter(id)

Delete parameter

<br>Use case  <br>User sets parameter internal (guid format) identifier  <br>System search and delete parameter  <br>System returns deleted parameter

Parameters

Name Type Description Notes
id UUID Parameter internal (UUID) identifier [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAllParameters

ParameterModel getAllParameters(isDeleted, Skip, Take, OrderBy, SearchField, SearchValue)

Get all parameters

<br>Use case  <br>[Optional] User sets isDeleted field value  <br>[Optional] If User sets isDeleted field value as true, System search all deleted parameters  <br>[Optional] If User sets isDeleted field value as false, System search all parameters which are not deleted  <br>If User did not set isDeleted field value, System search all parameters  <br>System returns array of all found parameters(listed in response model)

Parameters

Name Type Description Notes
isDeleted Boolean If result must consist of only actual/deleted parameters [optional] [default to null]
Skip Integer Amount of items to be skipped (offset) [optional] [default to null]
Take Integer Amount of items to be taken (limit) [optional] [default to null]
OrderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]

Return type

ParameterModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getParameterById

ParameterModel getParameterById(id)

Get parameter by ID

<br>Use case  <br>User sets parameter internal (guid format) identifier  <br>User runs method execution  <br>System search parameter using the identifier  <br>System returns parameter

Parameters

Name Type Description Notes
id UUID Parameter internal (UUID) identifier [default to null]

Return type

ParameterModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

obsoleteDeleteByName

obsoleteDeleteByName(name)

Parameters

Name Type Description Notes
name String [optional] [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateParameter

updateParameter(ParameterPutModel)

Update parameter

<br>Use case  <br>User sets parameter updated properties(listed in the request example)  <br>User runs method execution  <br>System updated parameter using updated properties  <br>System returns no content response

Parameters

Name Type Description Notes
ParameterPutModel ParameterPutModel [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json