PATCH /userdefined/series/{id}

Updates userdefined series with metadata

Updates existing userdefined series.

Path Parameters

Name Description Type Required Default
id Userdefined series id. String

Header Parameters

Name Description Type Required Default
Accept-Language Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en
Accept Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ application/json,application/xml]
String json

Query Parameters

Name Description Type Required Default
lang Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en
format Response data format. Default is json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ json,xml]
String json
token Access API key. String
with_model_information If set to true returns the model names as part of the response. Boolean false

FormData Parameters

Name Description Type Required Default
frequency The frequency name.
D - Daily
W - Weekly
M - Monthly
Q - Quarterly
H - Semi-annual
Y - Annual
Z - Quinquennially
T - Decadal
Accepted Values: [ D,W,M,Q,H,Y,Z,T]
String
name Series name. String
unit Unit abbreviation, ex: kg, ha, m3, etc. String
country Country name or ISO code. String
remarks Remark for the current series. String
start_date Series start date in ISO format. String
subnational Subnational. String
user_series_id The series id in the user source String
category The series category String

Responses

All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.

Status Code Description Type
200 Metadata of the updated series. UserdefinedCreatedSeriesResult
400 Incorrect input parameters. BadRequest
401 Authorization error. AuthorizationError
403 Incorrect user permissions. PermissionsError
404 Requested entity not found. NotFound
415 Unsupported data format. Only json, xml are supported. UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 Internal Server Error. InternalError
API Query Builder
Query
Query Result