Update a valueset item by id

PATCH 
/v1/valuesets/items/:id

Update a valueset item by id

Request

Path Parameters

id numberrequired

Valueset item identifier

application/json

Body

required

Update valueset item input

valuesetId number

Valueset id

value string

Valueset item unique value

descriptions

object[]

Valueset items descriptions per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Localized field language code

value stringnullablerequired

Localized field value

]

extra string

Valueset item extra value

Responses

200

Valueset item updated

application/json

Schema

Schema

id integerrequired

Valueset item primary identifier

valuesetId integerrequired

Valueset foreign identifier

value stringrequired

Possible values: <= 512 characters

Valueset item value

descriptions

object[]

required

Valueset item descriptions

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

value string

Localized field value

]

extra stringrequired

Possible values: <= 512 characters

Valueset item extra value

Example (from schema)

{
  "id": 12345,
  "valuesetId": 12345,
  "value": "My valueset item value",
  "descriptions": [
    {
      "lang": "EN",
      "value": "my valueset item description"
    }
  ],
  "extra": "My valueset item extra value"
}

400

Bad request

403

Forbidden

404

Valueset item not found

409

Valueset item already exists

500

Unknown update valueset item error

Loading...