UNunited-nations
Indicators

Returns a paged list of all active Indicators

<br>Paging options:

<br>* To return paged subset of data, provide PageNumber and PageSize
<br>* To return paging info in the body od the response, set 'pagingInHeader' to FALSE (default). Data is returned in 'response.data' field
<br>* To return paging info in the 'x-pagination' response header, set 'pagingInHeader' to TRUE. Data is returned as the response object

get/api/v1/Indicators

Request

Query parameters

pageNumberinteger

Current response page number

pageSizeinteger

Page size of the request (defaults to 100, maximum 100)

pagingInHeaderboolean

Parameter defining whether Paging information is returned in 'x-pagination' Response Header as opposed to the Body of the Response (default)

sortstring

Field name used for record sorting. Must exist on a Model, otherwise error is thrown. Defaults to Ascending sort by 'id' field. Use hypehn (-) in front of the field name to switch sorting direction to Descending

formatstring

Defines respose return format. Possible values are 'json' (default), 'xml' and 'csv'

Response

Returns list of all Indicators

idinteger
namestring nullable
shortNamestring nullable
descriptionstring nullable
displayNamestring nullable
dimAgeboolean
dimSexboolean
dimVariantboolean
dimCategoryboolean
defaultAgeIdinteger
defaultSexIdinteger
defaultVariantIdinteger
defaultCategoryIdinteger
variableTypestring nullable
valueTypestring nullable
unitScalingnumber double
precisioninteger
isThousandSeparatorSpaceboolean
formatStringstring nullable
unitShortLabelstring nullable
unitLongLabelstring nullable
nClassesDefaultinteger
downloadFileNamestring nullable
sourceIdinteger
sourceNamestring nullable
sourceYearinteger nullable
sourceStartYearinteger nullable
sourceEndYearinteger nullable
sourceCitationstring nullable
sourceUrlstring nullable
topicIdinteger
topicNamestring nullable
topicShortNamestring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.