Versions Compared

Key

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


Excerpt

Retrieve a list of all currently active forms available to an account



Endpoint ID:

8005

Method:

Status
colourGreen
titleGET

URL:

GET

/

data

forms/

forms

entity/

dp-key

id/{

dp

entity-

key

id}/form

GET

/

data

forms/

formsdp

entity/ext-key/{ext-key}/{ext-type}/form

 


entity-

keydialogportal™ master key that

id

Rubiq entity ID that uniquely identifies the account to retrieve forms

 

for


ext-key

External key that uniquely identifies the account to

form

retrieve forms for

 

ext-typeType of external key

Request body:

None

Response body:

JSON array containing the
form-id
formID and name of each form.
 


Code Block
titleExample
{
[
   {
      "formID": 100,
      "name": "
Test
Form 
Name1
1"
   },
   {
      "formID": 101,
      "name": "
Test
Form 
Name2
2"
   }
]
}


Status codes:

200

Forms successfully retrieved


404

Account not found, or no forms found for account.

The following sub codes may be returned:

404.1User not found
404.
 400No Forms found.
2External user could not be found
404.4No forms found