Versions Compared

Old Version 8

changes.mady.by.user Nick Jensen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user

...

 

Endpoint ID:

8006

Method:

Status
colourGreen
titleGET

URL:

GET /dataforms/formsentity/dp-keyid/{dpentity-keyid}/form/{form-id}/fields
GET /dataforms/formsentity/ext-key/{ext-key}/{ext-type}/form/{form-id}/fields


 

dpentity-keydialogportal™ master key id

Rubiq entity ID that uniquely identifies the account to retrieve fields for

 


ext-key

External key that uniquely identifies the account to retrieve fields for


ext-typeType of external key

 form-idNumeric value that identifies the form

Request body:

None

Response body:

Returns a JSON array of fields, containing fieldID, description, type, and if the field is a multichoice type, the field will contain an options array of options containing optionID and description.

 

Code Block
titleExample
[
   {
      "fieldID": 87,
      "type": "Text",
      "description": "Description of this text field"
   },
   {
      "fieldID": 88,
      "type": "Singlechoice",
      "description": "Description of this single choice field",
      "options": [
         {
            "optionID": 134,
            "description": "Yes"
         },
         {
            "optionID": 135,
            "description": "No"
         }
      ]
   },
   {
      "fieldID": 89,
      "type": "Multichoice",
      "description": "Description of this multi-choice field",
      "options": [
         {
            "optionID": 136,
            "description": "red"
         },
         {
            "optionID": 137,
            "description": "blue"
         },
         {
            "optionID": 138,
            "description": "green"
         }
      ]
   }
]


Possible field "type" values
Text
Singlechoice
Multichoice


Status codes:

200

Form fields successfully retrieved


 404

Form or account not found.

The following sub codes may be returned:

404.1User not found
404.2External user could not be found
404.4Form not found

 

...