Table of Contents

Class IdentifiersController

Namespace
OpenSettings.AspNetCore.Controllers.v1
Assembly
OpenSettings.AspNetCore.dll
[Route("v1/identifiers")]
public class IdentifiersController : ControllerBase
Inheritance
IdentifiersController
Inherited Members

Constructors

IdentifiersController(IIdentifiersService)

public IdentifiersController(IIdentifiersService identifiersService)

Parameters

identifiersService IIdentifiersService

Methods

CreateIdentifier(CreateIdentifierRequest, CancellationToken)

[HttpPost]
public Task<IActionResult> CreateIdentifier(CreateIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIdentifierRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

DeleteIdentifier(DeleteIdentifierRequest, CancellationToken)

[HttpDelete("{IdentifierId}")]
public Task<IActionResult> DeleteIdentifier(DeleteIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteIdentifierRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

DeleteUnmappedIdentifiers(CancellationToken)

[HttpDelete("unmapped")]
public Task<IActionResult> DeleteUnmappedIdentifiers(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IActionResult>

DragIdentifier(DragItemSortOrderRequest, CancellationToken)

[HttpPost("{SourceId}/drag/{TargetId}")]
public Task<IActionResult> DragIdentifier(DragItemSortOrderRequest request, CancellationToken cancellationToken = default)

Parameters

request DragItemSortOrderRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetIdentifierById(GetIdentifierRequest, CancellationToken)

[HttpGet("{IdentifierIdOrSlug}")]
public Task<IActionResult> GetIdentifierById(GetIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request GetIdentifierRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetIdentifierBySlug(GetIdentifierRequest, CancellationToken)

[HttpGet("slug/{IdentifierIdOrSlug}")]
public Task<IActionResult> GetIdentifierBySlug(GetIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request GetIdentifierRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetIdentifiers(GetIdentifiersRequest, CancellationToken)

[HttpGet]
public Task<IActionResult> GetIdentifiers(GetIdentifiersRequest request, CancellationToken cancellationToken = default)

Parameters

request GetIdentifiersRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

GetPaginatedIdentifiers(GetPaginatedRequest, CancellationToken)

[HttpGet("paginated")]
public Task<IActionResult> GetPaginatedIdentifiers(GetPaginatedRequest request, CancellationToken cancellationToken = default)

Parameters

request GetPaginatedRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

ReorderIdentifiers()

[HttpPost("reorder")]
public Task<IActionResult> ReorderIdentifiers()

Returns

Task<IActionResult>

UpdateIdentifier(UpdateIdentifierRequest, CancellationToken)

[HttpPut("{IdentifierId}")]
public Task<IActionResult> UpdateIdentifier(UpdateIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateIdentifierRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>

UpdateIdentifierSortOrder(UpdateIdentifierSortOrderRequest, CancellationToken)

[HttpPost("{IdentifierId}/sort-order")]
public Task<IActionResult> UpdateIdentifierSortOrder(UpdateIdentifierSortOrderRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateIdentifierSortOrderRequest
cancellationToken CancellationToken

Returns

Task<IActionResult>