InProcessTrackingFieldType

Lists in process tracking field types

Changed on
post/api/in-process-tracking-field-types

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/in-process-tracking-field-types
  • Auth
    none declared

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 in process tracking fields based on their name.

idsstring[] nullable

Filter in process tracking fields based on matching ids.

Response

The in process tracking field types

idstring required

Unique id associated to this entity.

namestring required

The name of the in process tracking field

dataType'boolean' | 'number' | 'dropdown' | 'text' | 'checkbox' required
descriptionstring

Description of the in process tracking field

dropDownOptionsstring[] nullable

Options when the data type is a list type

unitTypeNamestring nullable

The type of quantity when the data type is number

Changes

    • breaking

      the request property's minItems was increased to 1 (media type: application/json-patch+json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/json)

    • breaking

      the request property's minItems was increased to 1 (media type: text/json)

    • breaking

      the request property's minItems was increased to 1 (media type: application/*+json)

    • info

      endpoint added