こちらのwebサービスコールは、AdministrationViewFieldオブジェクトに提供された命名規則とカテゴリーを使用して、指定したビューに新規データベースカラム(列)を追加します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト(プライマリー)組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト(プライマリー)組織IDです。常に、「1」に設定します。 | OrgRef | String | オプション設定。ビューが所属するクライアント組織です。 | Function | String | Webサービス関数です。こちらは、「ADDCOLUMNTOVIEW」に設定します。 | ViewId | Integer | 編集するビューの内部IDです。 | Parameters | String[] | 追加されるデータベーステーブルとカラム(列)名を含む文字列の配列です。例えば、「person」テーブル内の「first_name」カラム(列)の場合は、{“person”,”first_name”}となります。 | Field | AdministrationViewField | 新規カラム(列)の定義を含むオブジェクトです。詳細は、以下の表を参照してください。 |
以下は、AdministrationViewFieldオブジェクトに要求されるパラメーターです。 オブジェクト要素 | データ型 | 説明 | ShortDescription | String | ビュービルダーでの表示名として追加されるカラム(列)の名前です。 | LongDescription | String | 追加されるカラム(列)の説明です。 | FieldCategory | String | 新規作成したフィールドを配下に配置するカテゴリーです。例:「DIMENSION」、または「METRIC」 |
リクエストの例以下は、こちらのリクエストのSOAP JAXの例です。 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>ADDCOLUMNTOVIEW</function>
<viewId>60543</viewId>
<parameters>person</parameters>
<parameters>first_name</parameters>
<field>
<shortDescription>Person Name</shortDescription>
<longDescription>This is the name this person wants to be called</longDescription>
<fieldCategory>People</fieldCategory>
</field>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>50b03dd1649bbb123605aa801829095b</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
|