NextGen APIs

GET /configurations/characteristics/r1/characteristics

Http Verb

GET

Url

/configurations/characteristics/r1/characteristics

Permissions required

Facility Configuration: View (fsm.core.technicalobject.configuration.view)

or

Facility Configuration: Edit (fsm.core.technicalobject.configuration.edit)

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W1 (FSM 16.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE MULTILANGUAGE-FIELDS

Business Logic

This API returns a list of characteristic filtered by input criteria.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id


Collection of ids

code


Collection of codes

description


Wildcard search enabled

active


 

order



dataTypeId


Collection of ids

format



size



maxLength



notNull



measureUnitId


Collection of ids

precision



valueDomainId


Collection of ids

characteristicClassId


Collection of ids

usageId



meter



negativeValues



Order ℹ️

Default Order

order (ASC)

Possible order values

all response payload fields.

Page ℹ️

Default.

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id

 

code

 

description

 

active

 

order


dataTypeId


format


size


maxLength


notNull


measureUnitId


precision


valueDomainId


characteristicClassId


usageId


isMeter


negativeValues


Response error codes

BASE_0001