Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.

Gebruik dit endpoint om de optielijst van een bestaand dropdown- of multi-select dropdownveld in een vragenlijst te vervangen.

LET OP: Dit endpoint vervangt de volledige lijst met waarden. Om nieuwe waarden toe te voegen, moet je zowel de bestaande als de nieuwe waarden in het verzoek opnemen.

HTTP-responses

HTTP response status code	Interpretatie
200 OK	De veldwaarden zijn succesvol bijgewerkt
400 Bad Request	Het veldtype ondersteunt geen dropdownwaarden, de body is ongeldig of het bijwerken van de repository is mislukt
401 Unauthorized	De API-sleutel is ongeldig
403 Forbidden	De aanvrager is geen Admin
404 Not Found	De vragenlijst bestaat niet of het veld is niet gevonden

Vereisten

Dit endpoint werkt alleen specified_values bij voor één veld. Andere veldeigenschappen worden niet bijgewerkt.

Endpoint: PUT /v1/questionnaires/{id}/fields/{fieldId}/dropdown-values
De header voor je API-verzoek
Parameters, die het volgende moeten bevatten:

Padparameters

Parameter	Vereist	Type	Beschrijving
`id`	Ja	String	Vragenlijst-ID
`fieldId`	Ja	String	ID van het dropdown- of multi-select dropdownveld

Request Body

De request body, die het volgende moet bevatten:

Veld	Type	Vereist	Beschrijving
`specified_values`	array	Ja	Nieuwe optielijst voor het veld. Gebruik een lege array om alle opties te verwijderen. Deze lijst vervangt de bestaande lijst.

Gespecificeerde waarden

Veld	Type	Vereist	Beschrijving
`value`	tekst	Ja	Label/waarde van de optie
`conditional_color`	Hex-kleurcode	Nee	Hex kleurwaarde van de kleur voor de conditionele layout

LET OP: Er geldt een limiet van 7500 waarden die je in dit verzoek kunt instellen.

Curl-voorbeeld:

curl --request PUT \
 --url 'https://<base-url>/v1/questionnaires/<questionnaire-id>/fields/<field-id>/dropdown-values' \
  --header 'X-Api-Key: <api-key>' \
  --header 'tenant: <tenant-name>' \
  --header 'Content-Type: application/json' \
  --data '{
    "specified_values": [
      { "value": "High", "conditional_color": "#48B220" },
      { "value": "Medium", "conditional_color": "#ED1C24" },
      { "value": "Low", "conditional_color": "#854F44" }
    ]
  }'

Response-eigenschappen

Een succesvol verzoek retourneert de volledige vragenlijst, niet alleen het aangepaste veld, met een 200 OK HTTP-statuscode en de volgende response body:

{
    "id": "69f9e06b87476064c2e98d2b",
    "library_template_id": "000000000000000000000000",
    "builtin": false,
    "version": 0,
    "name": "Test API",
    "template_type": "BOEM_Form",
    "target": 0,
    "fields": [
        {
            "id": "f63393cd-81dc-448a-99d7-a33a9a00822c",
            "name": "Tekst",
            "built_in": false,
            "position": 0,
            "field_type": "text",
            "default_value": null,
            "description": "",
            "is_required": false,
            "share_with_library": true,
            "show_in_official_views": false,
            "completeness_item": false,
            "contains_sensitive_information": false,
            "read_only": false,
            "is_sensitive": false,
            "conditional_color_true": "",
            "conditional_color_false": "",
            "conditional_color_not_set": "",
            "currency_symbol": "USD",
            "number_of_decimals": 0,
            "open_in_new_window": false,
            "number_of_lines": 0,
            "is_lookup": false,
            "lookup_collection": "",
            "lookup_display_field": "",
            "specified_values": [],
            "object_definition_name": "",
            "selected_relationship": "",
            "relationship_remark": "",
            "max_length": 50,
            "multiple_values_allowed": false,
            "create_new_object_allowed": false,
            "object_definition_category_internal": "",
            "selected_mode": "",
            "selection_filter": ""
        },
        {
            "id": "9e306f94-305f-4087-85a5-661b177ac497",
            "name": "Dropdown",
            "built_in": false,
            "position": 1,
            "field_type": "dropdown",
            "default_value": "",
            "description": "",
            "is_required": false,
            "share_with_library": true,
            "show_in_official_views": false,
            "completeness_item": false,
            "contains_sensitive_information": false,
            "read_only": false,
            "is_sensitive": false,
            "conditional_color_true": "",
            "conditional_color_false": "",
            "conditional_color_not_set": "",
            "currency_symbol": "USD",
            "number_of_decimals": 0,
            "open_in_new_window": false,
            "number_of_lines": 0,
            "is_lookup": false,
            "lookup_collection": "",
            "lookup_display_field": "",
            "specified_values": [
                {
                    "Id": "69fb07a5db49006f46c54a21",
                    "Value": "Hoog",
                    "ConditionalColor": "#48B220"
                },
                {
                    "Id": "69fb07a5db49006f46c54a23",
                    "Value": "Middel",
                    "ConditionalColor": "#ED1C24"
                },
                {
                    "Id": "69fb07a5db49006f46c54a25",
                    "Value": "Laag",
                    "ConditionalColor": "#854F44"
                }
            ],
            "object_definition_name": "",
            "selected_relationship": "",
            "relationship_remark": "",
            "max_length": 0,
            "multiple_values_allowed": false,
            "create_new_object_allowed": false,
            "object_definition_category_internal": "",
            "selected_mode": "",
            "selection_filter": ""
        },
        {
            "id": "b9c75810-b727-47dc-82a4-260f6fe99ff4",
            "name": "Multi Dropdown",
            "built_in": false,
            "position": 2,
            "field_type": "multiselect",
            "default_value": "",
            "description": "",
            "is_required": false,
            "share_with_library": true,
            "show_in_official_views": false,
            "completeness_item": false,
            "contains_sensitive_information": false,
            "read_only": false,
            "is_sensitive": false,
            "conditional_color_true": "",
            "conditional_color_false": "",
            "conditional_color_not_set": "",
            "currency_symbol": "USD",
            "number_of_decimals": 0,
            "open_in_new_window": false,
            "number_of_lines": 0,
            "is_lookup": false,
            "lookup_collection": "",
            "lookup_display_field": "",
            "specified_values": [
                {
                    "Id": "69f9e080ecc89277672c4fad",
                    "Value": "Eén",
                    "ConditionalColor": "#AF756F"
                },
                {
                    "Id": "69f9e0808447a4f54de450d5",
                    "Value": "Twee",
                    "ConditionalColor": "#00B6C5"
                },
                {
                    "Id": "69f9e080873fe97280395a2f",
                    "Value": "Drie",
                    "ConditionalColor": "#FF913F"
                }
            ],
            "object_definition_name": "",
            "selected_relationship": "",
            "relationship_remark": "",
            "max_length": 0,
            "multiple_values_allowed": false,
            "create_new_object_allowed": false,
            "object_definition_category_internal": "",
            "selected_mode": "",
            "selection_filter": ""
        }
    ]
}

Dropdown-waarden bijwerken in vragenlijst (PUT)