Versions Compared

Old Version 19

changes.mady.by.user Martin Trgiňa

Saved on

compared with

New Version Current

changes.mady.by.user Ayumi Yasuda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

/api/import/forms

Lists all data import forms available to the user.

Resource Information

Resource URL

https://service.belladati.com/api/import/forms

HTTP Method

GET

Request Parameters

None.

Response Structure

Code Block
javascript
javascript
{
  "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.

recordTimestampBoolean flag indicating if timestamp should be recorded.
tagsArray of string tags.
elements

Array of form elements - fields.

NameDescription
idElement identifier.
nameElement name - title displayed next to field.
type

Element type - please see list of supported values.

mapToDateColumnOnly if "type" has value "datefield". Flag if value should be mapped to date column.
items

Only if "type" has value "select". Array of options in select box.

NameDescription
nameOption value displayed in select box


Sample Request / Response

Using curl:

Code Block
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:

Code Block
javascript
javascript
{
  "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"
        }
      ]
    }
  ]
}
Sv translation
languageja

/api/import/forms

ユーザに利用可能なすべてのデータのインポートフォームを一覧表示します。

リソース情報

リソースURL

https://service.belladati.com/api/import/forms

HTTP方法

GET

リクエストパラメータ

無し。

レスポンスの構造

Code Block
javascript
javascript
{
  "importForms": [ ]
}

「importForms」要素は、以下の定義のように複数のフォームオブジェクトを含む配列です。 

名

説明

id

インポートフォーム識別子

name

インポートフォーム名

recordTimestampBooleanフラグはタイムスタンプが記録されるかどうかを示します
elements

フォーム要素　- 　フィールドの配列

名説明
id要素識別子
name要素名 - タイトルはフィールドの横に表示されます。
type

エレメント・タイプ- サポートされている値のリストをご参照してください。

mapToDateColumn"type"が"datefield"値を持っている場合のみ。フラグは値が日付列にマッピングする必要があります。
items

"type"が" select "値を持っている場合のみ。　選択ボックスにオプションの配列です。

名説明
nameオプション値は、選択ボックスに表示されます



サンプルリクエスト/レスポンス

curl使用

Code Block
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

JSON形式のレスポンス：

Code Block
javascript
javascript
{
  "importForms": [
    {
      "id": 123,
      "name": "My Data Collecting Form",
      "recordTimestamp": false,
      "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"
        }
      ]
    }
  ]
}