機械翻訳について
  1. Oracle Fusion Cloud Applications共通機能のためのREST API
  2. タスク
  3. ATKポップアップ・アイテム

すべてのポップアップ・アイテムを取得

get

/fscmRestApi/resources/11.13.18.05/atkPopupItems

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 セパレータとしてカンマを使用して複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、書式" Child.NestedChild " (例)に従って指定することもできます: ?expand= Employees.Managers ). ネストされた子が指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees, Employees.Managers" (従業員とマネージャを展開する)と同じです。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。 たとえば、"?fields= Employees.Managers:Empname"は、"?fields=;Employees:; Employees.Managers:Empname" (マネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers ) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder= <finderName> ; <variableName> = <variableValue>, <variableName2> = <variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定されたポップアップ・アイテムIDを持つポップアップ・アイテムを検索します。
      ファインダ変数:
      • MessageId; integer;ポップアップ・アイテムの一意の識別子。
  • このパラメータは、リソース・コレクションの内部で返されるリソース数を制限します。 制限がリソース数を超える場合、フレームワークは使用可能なリソースのみ返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • データのみを含めるために(リンク・セクションなしなど)、リソース・アイテム・ペイロードがフィルタ処理されます。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順には「asc」、降順には「desc」を指定します。 デフォルト値は「asc」です。 例:?orderBy=field1:asc,field2:desc
  • この問合せパラメータは、where句を定義します。 指定された式を使用してリソース・コレクションを問い合せます。 この問合せパラメータの値は1つ以上の式です。 例: ?q=Deptno>=10 and <= 30;Loc!=NY

    書式: ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AdditionalAttributes; string;ポップアップ・アイテムに関する追加情報。
    • DisplayMenu; string;表示メニューの名前。
    • MessageCreationDate; integer; 通知が作成された日時。
    • MessageCreationTranslatedDate; string;メッセージの翻訳版が作成された日付。
    • MessageExpiryDate; integer;お知らせ通知が失効する日付。
    • MessageId; integer。メッセージの一意の識別子。
    • MessageSummary; string; タスクの詳細を含む通知のタイトル。
    • MsgCreationDbDate; string;メッセージが作成された日付。
    • NavigationURLKey; string;ナビゲーションに使用されるURL。
    • NotificationType; string;通知のタイプ。
    • ObjectVersionNumber; integer;メッセージのバージョン。
    • PageParamListString; string; ページに関連付けられたパラメータ。
    • SOAOutcomes; string; SOA結果。
    • SOAOutcomesArray; object; SOA結果の配列。
    • SOAOutcomesDisplay; string; SOA結果の表示配列。
    • SOAServer; string; SOAサーバーの名前。
    • Source; string;メッセージのソース。
    • Status; string;通知のステータス。
    • TaskCreator; string;タスクの作成者を識別します。
    • TaskDetailsAvailableFlag; boolean;タスクの詳細が使用可能かどうかを識別します。
    • TaskDisplayURL; string;タスク詳細ダイアログ・ボックスの表示に使用するURL。
    • TaskId; string;タスクの一意の識別子。
    • TaskState; string;ワークフロー内のタスクの現在の状態。
    • TaskTabLabel; string;タスクのラベル。
    • TaskflowId; string;タスク・フローの一意の識別子。
    • TfKeyListString; string;タスク・フロー・パラメータ。
    • TfParameterString; string;タスク・フローのパラメータ文字列。
    • ThingsToFinishState; string; 完了する状態を示します。
    • UmsMessageId; string; メッセージの一意の識別子。
    • UserGUID; string;割り当てられたユーザーの一意の識別子。
    • ViewId; string; メッセージのビュー識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には推定行数が含まれます。それ以外の場合、行数は含まれません。 デフォルト値は"false"です。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。
Headers
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : atkPopupItems
タイプ: object
Show Source
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
Show Source
ネストされたスキーマ : atkPopupItems-item-response
タイプ: object
Show Source
ネストされたスキーマ : SOAOutcomesArray
タイプ: object
読取り専用: true
SOA結果の配列。
「トップに戻る」