Versions Compared

Old Version 3

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version Current

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

/api/dataSets/:id/attributes/:code/customMembers

Lists custom members for the given data set ID and attribute code.

Resource Information

Resource URL

https://service.belladati.com/api/dataSets/:id/attributes/:code/customMembers

HTTP Method

GET

Request Parameters

idData Set identifier. You can find the ID in the response to  /api/dataSets .123
codeAttribute code. You can find the code in the response to  /api/dataSets/:id .L_STATE

Response Structure

JSON response contains an array " customMembers" that contains multiple member objects with following definition:


namename of the custom member
aliasalias of the custom member (optional)
formulaformula of the custom member (optional)
idid of the custom member


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/dataSets/ 123 /attributes/L_STATE/customMembers

The JSON format response:

{
     "customMembers" : [
        {
             "name" :  "CM1" ,
             "alias" :  "custom_member_RAPI13" ,
             "formula" :  "return firstValue('L_ABC')" ,
             "id" :  "AEB04El654"
        },
        {
             "name" :  "3004" ,
             "alias" :  "3004" ,
             "id" :  "i2Iu5iWv0k"
        }
    ]
}


Sv translation
languageja

/api/dataSets/:id/attributes/:code/customMembers

指定されたデータセットIDと属性コードのカスタムメンバーを一覧表示します。

リソース情報

リソースURL

https://service.belladati.com/api/dataSets/:id/attributes/:code/customMembers

HTTPメソッド

GET

リクエストパラメーター

パラメーター詳細例
idデータセット識別子。 IDは、/api/dataSetsへのレスポンスで確認できます。123
code

属性コード。このコードは、/api/dataSets/:idへのレスポンスで確認できます。

L_STATE

レスポンス構造

JSONレスポンスには、次の定義を持つ複数のメンバーオブジェクトを含む配列 "customMembers" が含まれています:


名説明
nameカスタムメンバーの名前
aliasカスタムメンバーのエイリアス (オプション)
formulaカスタムメンバーの式 (オプション)
idカスタムメンバーのid


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

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/dataSets/ 123 /attributes/L_STATE/customMembers

JSON形式のレスポンス:

{
     "customMembers" : [
        {
             "name" :  "CM1" ,
             "alias" :  "custom_member_RAPI13" ,
             "formula" :  "return firstValue('L_ABC')" ,
             "id" :  "AEB04El654"
        },
        {
             "name" :  "3004" ,
             "alias" :  "3004" ,
             "id" :  "i2Iu5iWv0k"
        }
    ]
}