/api/import/forms
Lists all data import forms available to the user.
Resource Information
Resource URL | |
HTTP Method |
|
Request Parameters
None.
Response Structure
{ "importForms": [ ] }
Element "importForms" is an array that contains multiple form objects with following definition:
Name | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Import form identifier. | ||||||||||||||||
name | Name of import form. | ||||||||||||||||
recordTimestamp | Boolean flag indicating if timestamp should be recorded. | ||||||||||||||||
tags | Array of string tags. | ||||||||||||||||
elements | Array of form elements - fields.
|
Sample Request / Response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/import/forms
The JSON format response:
{ "importForms": [ { "id": 123, "name": "My Data Collecting Form", "recordTimestamp": false, "tags": [ "my tag 123456", "my another tag" ], "elements": [ { "id": "mNdZBe1rMY", "name": "Username", "type": "username" }, { "id": "wo35CMzcGV", "name": "Country", "type": "textfield" }, { "id": "N9zpsXG4WI", "name": "Birth Date", "type": "datefield", "mapToDateColumn": true }, { "id": "ZdXAW61ko5", "name": "Gender", "type": "select", "items": [ {"name": "Male"}, {"name": "Female"}, {"name": "Other"} ] }, { "name": "Are you smiling right now?", "id": "WSyh9tSkut", "type": "checkbox" }, { "name": "Timestamp Value", "id": "mw0qjAfe66", "type": "timestamp" } ] } ] }
Overview
Content Tools