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

Dit artikel beschrijft hoe je de vragenlijst uit je repository kunt ophalen.

HTTP-responses

HTTP response statuscode	Interpretatie
200 OK	Vragenlijst succesvol opgehaald
400 Bad Request	De vragenlijst kon niet worden opgehaald vanwege ongeldige tenantgegevens
404 Not Found	Kon geen vragenlijst vinden met het opgegeven Id

Curl-voorbeeld:

curl --location 'https://publicapi.eu.bluedolphin.app/v1/questionnaires/{questionnaireId}' \
--header 'x-api-key: {apiKey}' \
--header 'tenant: {tenant name}'

Response-eigenschappen

Hoofd

Parameter	Type	Beschrijving
id	string	ID van de vragenlijst
libraryTemplateId	string	ID van het bibliotheekitem waarop deze vragenlijst is gebaseerd
builtIn	bool	Of de vragenlijst ingebouwd is
name	string	Naam van de vragenlijst
templateType	string	Altijd BOEM_Form
fields	array van velden	zie hieronder

Velden

Parameter	Type	Beschrijving
id	string	ID van het veld
name	string	Naam van het veld
built_in	bool	Of het veld ingebouwd is
position	integer	Positie van het veld in de vragenlijst
field_type	string	Type van het veld. Mogelijke types: text dropdown multi select multiline number currency date checkbox rich text hyperlink relation
default_value	string	Standaardwaarde voor het veld, voor alle velden behalve het relatieveld
description	string	Beschrijving van het veld
is_required	bool	Indien waar, is dit veld verplicht.
share_with_library	bool	Indien waar, mag de inhoud van dit veld gedeeld worden met de bibliotheek
show_in_official_views	bool	Indien waar, mag dit veld getoond worden in het BPMN Procesportaal
completeness_item	bool	Indien waar, wordt dit veld meegenomen bij het berekenen van object compleetheid
contains_sensitive_information	bool	Indien waar, wordt de inhoud van dit veld niet getoond aan alleen-lezen gebruikers en verschijnt het niet in rapportages
read_only	bool	Indien waar, kan de inhoud van dit veld niet door een gebruiker worden gewijzigd
is_sensitive	bool	Indien waar, wordt de inhoud van dit veld niet getoond aan alleen-lezen gebruikers en verschijnt het niet in rapportages
conditional_color_true	string	Hex-code voor de kleur wanneer het object wordt gebruikt in de conditionele layout en de waarde waar is (voor checkbox-velden)
conditional_color_false	string	Hex-code voor de kleur wanneer het object wordt gebruikt in de conditionele layout en de waarde onwaar is (voor checkbox-velden)
conditional_color_not_set	bool	Indien waar, is er geen specifieke conditionele kleur ingesteld
currency_symbol	string	Type valuta gebruikt: Euro of dollar
number_of_decimals	integer	Aantal decimalen voor een valuta- of getalveld
open_in_new_window	bool	Voor een hyperlinkveld: indien waar, opent de link in een nieuw venster of tabblad
number_of_lines	integer	Voor meerregelige tekstvelden geeft dit aan hoeveel regels worden weergegeven in de BlueDolphin UI. Dit heeft geen betrekking op de maximale lengte van het veld
is_lookup	bool	Voor multi-dropdowns en gewone dropdowns: indien waar, komen de waarden in de dropdown uit een bron
lookup_collection	string	Voor multi-dropdowns en gewone dropdowns: als de mogelijke waarden uit een bron komen, geeft dit de naam van de broncollectie aan
lookup_display_field	string	Voor multi-dropdowns en gewone dropdowns: als de mogelijke waarden uit een bron komen, geeft dit de veldnaam uit de bron aan die wordt gebruikt om de waarden weer te geven. Dit is een data source-expressie.
specified_values	array	Voor multi-dropdowns en gewone dropdowns: als de lijst met mogelijke waarden handmatig is, is dit de lijst van die waarden. Bevat de volgende velden: id - interne id van de waarde value - de waarde conditional color - de conditionele kleur voor de waarde
object_definition_name	string	Bij relatievelden geeft dit de doel Objectdefinitie aan voor de relaties
selected_relationship	document	Bij relatievelden geeft dit het type Relatie aan dat met dit veld wordt aangemaakt. Bevat de volgende waarden: relationshipTemplateId - ID van het relatietemplate-type uniqueId - ID van het relatietype type - het type van de Relatie weight - het gewicht van de Relatie name - naam van de Relatie configurationName - leeg laten configurationName_Internal - leeg laten relationshipCombinationId - GUID met nullen isRelationDirectAlternative - bool om de richting van de Relatie aan te geven (indien van toepassing) status - status van de Relatie. Bevat alleen 0
relationship_remark	string	Bij relatievelden geeft dit het label aan waarop het relatieveld de Relaties moet filteren. Dit wordt ook gebruikt bij het aanmaken van nieuwe Relaties in dit veld.
max_length	integer	Voor tekstvelden: geeft de maximale lengte van de inhoud aan.
multiple_values_allowed	bool	Niet gebruikt
create_new_object_allowed	bool	Niet gebruikt
object_definition_category_internal	string	Niet gebruikt
selected_mode	string	Niet gebruikt
selection_filter	string	Niet gebruikt

Een succesvolle call geeft een response met een 200 OK HTTP-statuscode en de volgende body terug:

{
  "id": "Unieke identificatie",
  "library_template_id": "000000000000000000000000",
  "builtin": false,
  "version": 0,
  "name": "Vragenlijst naam",
  "template_type": "templateType",
  "target": 0,
  "fields": [
       {
         "id": "ce54f0eb-38eb-476e-9557-2e2062db515b",
         "name": "Relatie veld",
         "built_in": false,
         "position": 0,
         "field_type": "relation",
         "default_value": "",
         "description": "Test 12345",
         "is_required": false,
         "share_with_library": false,
         "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": "Bedrijfsactor",
         "selected_relationship": "used by",
         "relationship_remark": "Dit is een relatie",
         "max_length": 0,
         "multiple_values_allowed": false,
         "create_new_object_allowed": false,
         "object_definition_category_internal": "",
         "selected_mode": "",
         "selection_filter": ""
       },
       {
        "id": "54689454-9afc-43d4-a71c-415fd633221c",
        "name": "tekstveld",
        "built_in": false,
        "position": 1,
        "field_type": "text",
        "default_value": "d",
        "description": "Dit is een veld",
        "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": 100,
        "multiple_values_allowed": false,
        "create_new_object_allowed": false,
        "object_definition_category_internal": "",
        "selected_mode": "",
        "selection_filter": ""
       }
    ]
}

Een vragenlijst ophalen

HTTP-responses

Curl-voorbeeld:

Response-eigenschappen

Hoofd

Velden