Page History
Anchor | ||||
---|---|---|---|---|
|
ユーザーグループとロールは、こちらの項目で紹介するwebサービスの呼び出しを使用して、作成、または変更をすることができます。
注意:「システム構成」ページで「クライアント組織」機能が有効になっている場合で、特定のタイプの呼び出しが適用可能な場合は、クライアント組織を指定することもできます。
注意:「システム構成」ページで「クライアント組織」機能を有効にすることで、特定タイプの呼び出しでは適用可能な場合に、クライアント組織を指定することができます。
ユーザーロール関数
これらの webサービスは、Yellowfinのユーザーロールに特化しています。
Note |
---|
LDAP認証を使用する場合、ロールを返すすべてのwebサービスは、LDAPユーザーが最後に正常にログインした時のロールを返します(これは、LDAPユーザーがログインをする度に更新されます)。 |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、Yellowfinで利用可能なすべてのユーザーロールを返します。応答は、利用可能なロールを表示するAdministrationRoleオブジェクトの配列が含まれます。こちらの関数は、Yellowfinで利用可能なすべてのユーザーロールを返します。応答は、利用可能なロールを表示する、AdministrationRoleオブジェクトの配列を含みます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAP XMLの例は、この呼び出しに渡すことのできるパラメーターを表示しています。以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、LISTROLES関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロール詳細を指定するためのAdministrationRoleオブジェクトと、ロールのためのAdministrationFunctionの配列を含まなくてはいけません。こちらの関数が、ロールの更新、または新規ロール作成に使用されるか同課に関わらず、すべてのYellowfinロールは、必須関数であるレポートアクセス(関数コード:MIREPORT)を要求することに注意してください。MIREPORTには、アクセスレベルコードとして、最低でもR(読み取り)を設定 しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ関数は上書きされます。こちらの関数は、新規ロールを作成し、ロール機能を更新します。リクエストは、ロールの詳細を指定するAdministrationRoleオブジェクトと、ロールのAdministrationFunctionの配列を含まなくてはいけません。こちらの関数を、ロールの更新、または新規ロール作成のいずれに使用するかに関わらず、すべてのYellowfinロールは、必須関数であるレポートアクセス(コード:MIREPORT)を要求することに注意してください。MIREPORTには、アクセスレベルコードとして、最低でもR(読み取り)を設定しなくてはいけません。こちらの関数が呼び出される度に、セキュリティ機能は上書きされます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAP XMLの例は、この呼び出しに渡すことのできるパラメーターを表示しています。以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、SAVEROLE関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したユーザーロールを削除します。AdministrationRoleオブジェクトのロールコードを提供することで、対象のロールを指定することができます。 こちらの関数は、指定したユーザーロールを削除します。AdministrationRoleオブジェクトのロールコードを提供することで、対象のロールを識別することができます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、この呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、DELETEROLE関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
ユーザーグループ関数
ユーザーグループに関連するwebサービスは、以下のように定義されます。
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。特定のクライアントに所属するグループの一覧を取得する場合は、呼び出しにクライアント組織参照IDを渡します。LISTGROUPS関数は、Yellowfin内の利用可能なすべてのグループを返します。応答には、利用可能なグループを示すAdministrationGroupオブジェクトの配列が含まれます。指定したクライアントに所属するグループの一覧を取得する場合は、呼び出し内でクライアント組織参照IDを渡します。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、LISTGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
特定のユーザーグループを、そのメンバーとともに取得する場合は、こちらの関数を使用します。リクエストには、必ずグループ名を提供しなくてはいけません。 指定したユーザーグループを、そのメンバーとともに取得する場合は、こちらの関数を使用します。リクエストには、必ずグループ名を提供しなくてはいけません。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答の要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、GETGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、特定のクライアント組織(参照IDが提供される場合)、またはデフォルト(プライマリー)組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。(追加するメンバーは、既存のYellowfinユーザーでなくてはいけません)ユーザーが所属するすべてのユーザーグループを取得するには、こちらの関数を使用します。これは、AdministrationPersonをパラメーターとして受け付け、ユーザーを特定します。応答には、AdministrationGroupオブジェクトの配列が含まれます。
リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
AdministrationPersonオブジェクトに、以下のいずれかのパラメーターを設定します。
両方が設定された場合、IpIdがデフォルトで使用されます。 Stringリクエストの例 | 既存のYellowfinユーザーのユーザーIDです。グループに追加するために必要です。 |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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>CREATEGROUP<<function>GETUSERGROUPS</function> <group><person> <groupName>Supervisors</groupName> <groupMembers> <!-- Set one of userId and ipId. If both are set, ipId will be used by default. --> <loginId>admin@yellowfin<userId>admin@yellowfin.com.au</loginId>userId> <loginId>binish.sheikh@yellowfin.com.au</loginId><ipId>5</ipId> </groupMembers>person> </group> <!-- orgRef is optional --> <orgRef>org1</orgRef> <parameters> <!-- TRUE or FALSE. Case insensitive. --> <string>true</string> </parameters> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> |
応答要素
返される応答には、これらのパラメーターが含まれます。
応答要素 | データ型 | 説明 |
StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。
|
Groups | AdministrationGroup[] | グループの一覧です。 |
応答の例
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:remoteAdministrationCallResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://webservices.web.mi.hof.com/">
<remoteAdministrationCallReturn href="#id0"/>
</ns1:remoteAdministrationCallResponse>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AdministrationServiceResponse" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="http://service.web.mi.hof.com">
<binaryAttachments xsi:type="ns2:ArrayOfReportBinaryObject" xsi:nil="true"/>
<binaryData xsi:type="xsd:string" xsi:nil="true"/>
<client xsi:type="ns2:AdministrationClientOrg" xsi:nil="true"/>
<clients xsi:type="ns2:ArrayOfAdministrationClientOrg" xsi:nil="true"/>
<contentResources xsi:type="ns2:ArrayOfContentResource" xsi:nil="true"/>
<contentType xsi:type="xsd:string" xsi:nil="true"/>
<datasources xsi:type="ns2:ArrayOfAdministrationDataSource" xsi:nil="true"/>
<entityId xsi:type="xsd:int" xsi:nil="true"/>
<errorCode xsi:type="xsd:int">0</errorCode>
<fileName xsi:type="xsd:string" xsi:nil="true"/>
<group xsi:type="ns2:AdministrationGroup" xsi:nil="true"/>
<groups soapenc:arrayType="ns2:AdministrationGroup[1]" xsi:type="soapenc:Array">
<groups href="#id1"/></groups>
<importIssues xsi:type="ns2:ArrayOfImportIssue" xsi:nil="true"/>
<loadedDataSource xsi:type="ns2:AdministrationDataSource" xsi:nil="true"/>
<loginSessionId xsi:type="xsd:string" xsi:nil="true"/>
<messages soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array">
<messages xsi:type="soapenc:string">Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages xsi:type="soapenc:string">Web Service Request Complete</messages>
</messages>
<parentDashboard xsi:type="ns2:ParentDashboard" xsi:nil="true"/>
<parentDashboards xsi:type="ns2:ArrayOfParentDashboard" xsi:nil="true"/>
<parentReportGroups xsi:type="soapenc:Array" xsi:nil="true"/>
<people xsi:type="ns2:ArrayOfAdministrationPerson" xsi:nil="true"/>
<person xsi:type="ns2:AdministrationPerson" xsi:nil="true"/>
<personfavourites xsi:type="ns2:ArrayOfPersonFavourite" xsi:nil="true"/>
<queryResults xsi:type="ns2:ArrayOfReportRow" xsi:nil="true"/>
<report xsi:type="ns2:AdministrationReport" xsi:nil="true"/>
<reportGroups xsi:type="ns2:ArrayOfAdministrationReportGroup" xsi:nil="true"/>
<reportId xsi:type="xsd:int" xsi:nil="true"/>
<reports xsi:type="ns2:ArrayOfAdministrationReport" xsi:nil="true"/>
<roles xsi:type="ns2:ArrayOfAdministrationRole" xsi:nil="true"/>
<schedule xsi:nil="true"/>
<schedules xsi:type="ns3:ArrayOfAdministrationSchedule" xsi:nil="true" xmlns:ns3="http://schedule.service.web.mi.hof.com"/>
<sessionId xsi:type="xsd:string">974c65a870699f6f4059ba54c15ddc6c</sessionId>
<statusCode xsi:type="xsd:string">SUCCESS</statusCode>
</multiRef>
<multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:AdministrationGroup" xmlns:ns4="http://service.web.mi.hof.com" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<groupDescription xsi:type="xsd:string">This group contains all users with the Admin role.</groupDescription>
<groupId xsi:type="xsd:int">11950</groupId>
<groupInternalReference xsi:type="xsd:string" xsi:nil="true"/>
<groupMembers soapenc:arrayType="ns4:AdministrationGroupMember[1]" xsi:type="soapenc:Array">
<groupMembers href="#id2"/></groupMembers>
<groupName xsi:type="xsd:string">Administrators</groupName>
<groupStatus xsi:type="xsd:string" xsi:nil="true"/>
</multiRef>
<multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:AdministrationGroupMember" xmlns:ns5="http://service.web.mi.hof.com" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<internalId xsi:type="xsd:int">5</internalId>
<loginId xsi:type="xsd:string">admin@yellowfin.com.au</loginId>
</multiRef>
</soapenv:Body>
</soapenv:Envelope> |
手順
Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
|
完成例
以下は、GETUSERGROUPS関数の完成例です。こちらを使用するには、以下の手順に従います。
- コードをコピーして、「ws_getusergroups.jsp」として保存します。
- root(Yellowfin/appserver/webapps/ROOT)フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_getusergroups.jsp」を実行します。
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_getusergroups.jsp */
%>
<%@ page contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.mi.web.service.AdministrationGroup" %>
<%@ page import="com.hof.mi.web.service.AdministrationGroupMember" %>
<%@ page import="com.hof.mi.web.service.AdministrationPerson" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceRequest" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceResponse" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceService" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceServiceLocator" %>
<%@ page import="com.hof.mi.web.service.AdministrationServiceSoapBindingStub" %>
<%
// Adjust host and port number
AdministrationServiceService adminServiceService = new AdministrationServiceServiceLocator(
"localhost", 8080,
"/services/AdministrationService",
false
);
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) adminServiceService.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
// Provide your Yellowfin web services admin account
rsr.setLoginId("admin@yellowfin.com.au");
// Change to the password of the above account
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERGROUPS");
// Provide org reference if required. Default org groups will be retrieved otherwise
// rsr.setOrgRef("org1");
// Provide userId or ipId of the user
AdministrationPerson ap = new AdministrationPerson();
// Set one of userId and ipId. If both are set, ipId will be used by default.
// ap.setUserId("admin@yellowfin.com.au");
ap.setIpId(1);
rsr.setPerson(ap);
// Set the first item in the parameters array as "true" or "false" (String, case insensitive) to indicate
// whether to include AdministrationGroupMember objects in the returned AdministrationGroup objects.
// If true, the returned groups will contain the information of all their members.
rsr.setParameters(new String[]{"TRUE"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success.<br><br>Groups which the user belongs to:");
AdministrationGroup[] groups = rs.getGroups();
for (AdministrationGroup group : groups) {
out.write("<br>");
out.write("<br>Group Name: " + group.getGroupName());
out.write("<br>Group Id: " + group.getGroupId());
out.write("<br>Group Description: " + group.getGroupDescription());
out.write("<br>Group Status: " + group.getGroupStatus());
out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());
// Uncomment to display the members:
out.write("<br><br>Members:<br>Login Id | Internal Id ");
for (AdministrationGroupMember member : group.getGroupMembers()) {
out.write("<br>" + member.getLoginId() + " | " + member.getInternalId());
}
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
out.write("<br><br>Messages:");
for (String msg : rs.getMessages()) {
out.write("<br>");
out.write(msg);
}
}
%> |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したクライアント組織(参照IDが提供される場合)、またはデフォルト(プライマリー)組織のいずれかに新規ユーザーグループを作成します。新規グループの詳細は、AdministrationGroupオブジェクトを使用して渡されます。新規グループにメンバーを追加する場合は、AdministrationGroupMemberを介して、グループメンバーの詳細を提供します。(追加するメンバーは、既存のYellowfinユーザーでなくてはいけません) リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答の要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、CREATEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、グループのメンバーを更新するために使用されます。このリクエストともにメンバーの一覧が提供される場合、既存のメンバー一覧は上書きされます。そのため、サービスは既存のメンバーをすべて削除し、新しいメンバーを追加します。メンバー一覧が提供されない場合は、グループ内の既存のユーザーすべてが削除されます。 こちらの関数は、グループのメンバーを更新するために使用します。このリクエストともにメンバーの一覧が提供される場合、既存のメンバー一覧は上書きされます。そのため、サービスは既存のメンバーをすべて削除し、新しいメンバーを追加します。メンバー一覧が提供されない場合は、グループ内の既存のユーザーすべてが削除されます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答の要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、MODIFYGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、グループの名前を変更するために使用されます。AdministrationGroupオブジェクトと、グループのIDを使用して対象のグループを指定します。グループIDは、Yellowfinのデータベース(AccessGroupテーブルのAccessGroupIdフィールド)、またはグループ名とresponseこちらの関数は、グループの名前を変更するために使用します。AdministrationGroupオブジェクトと、グループのIDを使用して対象のグループを指定します。グループIDは、Yellowfinのデータベース(AccessGroupテーブルのAccessGroupIdフィールド)、またはグループ名とresponse.getGroup().getGroupId()を取得してGETGROUPを呼び出すことで取得することができます。 リクエスト要素以下の要素は、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答の要素返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、RENAMEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
グループ名を提供することで、Yellowfinから既存のユーザーグループを削除する場合は、こちらのwebサービスを呼び出します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、DELETEGROUP関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、特定のYellowfinユーザーを、特定のユーザーグループに追加する場合に使用します。こちらの関数は、指定したYellowfinのユーザーを、指定したユーザーグループに追加する場合に使用します。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、複数の特定のYellowfinユーザーを、特定のユーザーグループに追加する場合に使用します。こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加する場合に使用します。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクトの配列、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、特定のYellowfinユーザーを、特定のユーザーグループに追加しますが、「含めない」タグが追加されます。ユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。ユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、複数の特定のYellowfinユーザーを、特定のユーザーグループに追加しますが、「こちらの関数は、複数の指定したYellowfinユーザーを、指定したユーザーグループに追加しますが、「含めない」タグが追加されます。これらのユーザーはグループから削除されるのではなく、除外されたメンバーとして存在することになります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクトの配列、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、指定したYellowfinユーザーを、指定したユーザーグループから削除します。こちらを実行することで、対象のユーザーはグループメンバーの一覧に表示されなくなります。 こちらのリクエストは、ユーザーを指定するAdministrationPersonオブジェクト、ユーザーグループを定義するAdministrationGroupオブジェクトを要求します。
リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
こちらの関数は、特定のダッシュボードを指定したユーザーグループのデフォルトダッシュボードとして設定するために使用します。ダッシュボードを指定するためにContentResourceオブジェクト、ユーザーグループを識別するためにAdministrationGroupオブジェクトを使用します。 リクエストパラメーター以下のパラメーターは、こちらのリクエストとともに渡されます。
リクエストの例以下のSOAPの例は、こちらの呼び出しに渡すことのできるパラメーターを表示しています。
応答のパラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらの関数の完成例です。こちらを使用するには、以下の手順に従います。
|
...
|
horizontalrule |
---|
Styleclass | ||
---|---|---|
| ||
...