ヘルプ・トピック要約
業種、ローカライゼーション、リリースおよび言語について特定の属性が設定されたヘルプ文書の要約を操作するサービスです。
ライフ・サイクル・ステータス: Active
QName: {http://xmlns.oracle.com/apps/atk/helpPortal/helpPortalService/}AtkHelpPortalService
サービスWSDLのURL: https://servername/fscmService/AtkHelpPortalService?WSDL
関係
次の表では、このサービス・データ・オブジェクトが他のサービス・データ・オブジェクトまたはビジネス・オブジェクト・サービスとどのように関連しているかについて説明します。
| 関係タイプ | オブジェクトまたはサービス |
|---|---|
|
Handles |
|
|
Handles |
操作
findHelpTopicAbstract
ヘルプ・ウィンドウ識別子(UAPKey)およびオプションの追加基準に基づいて、ヘルプの要約を検索します。
ライフ・サイクル・ステータス: Active
要求ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
criteria |
ヘルプ・トピック基準 |
ヘルプ・ファイル要約の問合せの基準。 |
応答ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
result |
業種、ローカライゼーション、リリースおよび言語について特定の属性が設定されたヘルプ・ファイルの要約。 |
findHelpTopicContentOnLocalCall
FSMまたは製品チームのUAP取込みに必要なヘルプ・コンテンツblobを返します。
ライフ・サイクル・ステータス: Active
要求ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
pTopicId |
string |
渡されるtopicId。 |
|
urlContextRoot |
string |
WebアプリケーションのURLコンテキスト・ルート。 |
|
uapKey |
string |
WebAppを使用する製品チームのUAPキー。 |
|
language |
string |
渡される言語。 |
|
territory |
string |
渡されるテリトリ・コード。 |
|
release |
string |
渡されるリリース値。 |
|
industry |
string |
産業コード(nullの場合あり)。 |
|
taskFlowId |
string |
渡される製品チームのタスクフローId。 |
|
workAreaId |
string |
渡される作業領域id(nullの場合あり)。 |
応答ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
result |
string |
指定したtopic-idおよび渡されたUAPキーのヘルプ・トピックblobコンテンツを返します。 |
getDfltObjAttrHints
サービス・データ・オブジェクトのラベルやオブジェクト属性のラベルなど、指定されたサービス・データ・オブジェクトとロケールに対応するユーザー・インタフェース・ヒントを取得する操作です。 前提条件として、このサービスに対して定義されたgetEntityList操作を呼び出して、viewName要求ペイロード要素に使用可能な値のリストを取得します。
ライフ・サイクル・ステータス: Active
要求ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
viewName |
string |
サービス・データ・オブジェクトの内部名である、サービス・ビュー使用名。 getEntityList操作の応答ペイロード内の<name>要素の値を指定します。 |
|
localeName |
string |
ロケールベースのユーザー・インタフェース・ヒントを評価する際に使用するロケール。 localeNameはISO 639-1形式です。 |
応答ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
指定されたサービス・データ・オブジェクトおよびその属性の、ラベルとユーザー・インタフェース・ヒント(名前と値のペアの形式)。 |
getServiceLastUpdateTime
サービス定義で参照されるスキーマ・ファイルが最後に変更された日時を返す操作です。
ライフ・サイクル・ステータス: Active
要求ペイロード
応答ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
ISO 8601形式による、サービス定義が最後に変更された日時。 |
getEntityList
このサービスに対して定義されているサービス・データ・オブジェクトのリストを取得する操作です。
ライフ・サイクル・ステータス: Active
要求ペイロード
応答ペイロード
| 要素名 | タイプ | 摘要 |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
このサービスに対して定義されているサービス・データ・オブジェクトのリスト。 それぞれのサービス・データ・オブジェクトについて、QName、内部名、およびcreate、update、merge、deleteの各操作をそのオブジェクトに対して実行できるかどうかを示すブール値が結果に含まれます。 |