Table of Contents

Class ConfigObservationController

Namespace
adas_core.Controllers
Assembly
adas-core.dll
[Route("config-observations")]
[ApiController]
public class ConfigObservationController : ControllerBase
Inheritance
ConfigObservationController
Inherited Members
Extension Methods

Constructors

ConfigObservationController(IConfigObservationService, IHistoricalConfigChangesService) 

public ConfigObservationController(IConfigObservationService configObservationService, IHistoricalConfigChangesService historicalConfigChangesService)

Parameters

configObservationService IConfigObservationService
historicalConfigChangesService IHistoricalConfigChangesService

Methods

CreateConfigObservation(ConfigObservation)

Post new config observation

[HttpPost]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> CreateConfigObservation(ConfigObservation configObservation)

Parameters

configObservation ConfigObservation

Returns

Task<IActionResult>

CreateObservation(ConfigObservation)

Post new observation

[HttpPost("item")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> CreateObservation(ConfigObservation configObservationItem)

Parameters

configObservationItem ConfigObservation

Returns

Task<IActionResult>

DeleteSingleConfigObservationItem(ConfigObservation)

Deletes a single configuration observation item.

[HttpDelete("delete/item")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> DeleteSingleConfigObservationItem(ConfigObservation configObservationItem)

Parameters

configObservationItem ConfigObservation

The configuration observation item to delete, provided in the request body.

Returns

Task<IActionResult>

An IActionResult containing the result of the deletion operation.

Exceptions

BadRequestException

Thrown when the configObservationItem is null, indicating missing required parameters.

FindConfigObservationById(string)

Get config by id

[HttpGet("{id}")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> FindConfigObservationById(string id)

Parameters

id string

Returns

Task<IActionResult>

GetActiveConfigObservation()

Retrieves all active configuration observations. Throws a not-found exception when no configurations are available.

[HttpGet]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetActiveConfigObservation()

Returns

Task<IActionResult>

An IActionResult containing the active configuration observations.

Exceptions

NotFoundException

Thrown when no configuration observations are returned by the service.

GetAllCompact()

GetByCodeSysAndCode compact configs

[HttpGet("compact")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetAllCompact()

Returns

Task<IActionResult>

GetConfigNames()

Retrieves the list of configuration names available for observations, restricted to users with the required role and source-level display permission.

[HttpGet("get-name-obs")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetConfigNames()

Returns

Task<IActionResult>

An IActionResult containing the configuration names returned by the observation service wrapped in an HTTP 200 OK response.

GetConfigObservationItemByName(string)

Get by name config observation item list

[HttpGet("itemName/{itemName}")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetConfigObservationItemByName(string itemName)

Parameters

itemName string

Returns

Task<IActionResult>

GetConfigObservationItemsByName(string)

GetByCodeSysAndCode config all observation items by name

[HttpGet("{itemName}/name")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetConfigObservationItemsByName(string itemName)

Parameters

itemName string

Returns

Task<IActionResult>

GetPaginatedItems(PaginationFilter)

Get a list of paginated items

[HttpPost("paginated-items")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetPaginatedItems(PaginationFilter filter)

Parameters

filter PaginationFilter

Returns

Task<IActionResult>

GetSingleConfigObservationItem(string)

GetByCodeSysAndCode config observation item

[HttpGet("item/by-code-sys-and-code/{data}")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> GetSingleConfigObservationItem(string data)

Parameters

data string

Returns

Task<IActionResult>

UpdateConfigObservationItem(string, ConfigObservation)

Update config observation item

[HttpPut("{configId}")]
[AuthorizeRoles(PermissionEnum.RolesType.AuthSome)]
[PermissionAuthorize("Source", "DisplayId")]
public Task<IActionResult> UpdateConfigObservationItem(string configId, ConfigObservation configObservationItem)

Parameters

configId string
configObservationItem ConfigObservation

Returns

Task<IActionResult>