Sign in
Gauge Code

Find gauge codes based on search parameters.

post/api/gauge-codes/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

namestring nullable

Filter tags based on their name.

idsstring[] nullable

Filter tags based on matching ids.

Response

List of gauge codes matching the filters

idstring required

Unique Id associated to the referenced object

namestring required

Descriptive name associated to the object

style'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark' | 'connected' required

Style enum (for tags).

descriptionstring nullable

Descriptive name associated to the object

typesCommonEnumTagTypeEnum[] required

Represents where/how this tag is used.

deletedboolean nullable

Indicate if this tag has been deleted.

Changes