機械翻訳について
  1. Oracle Fusion Cloud Applications共通機能のためのREST API
  2. タスク
  3. お知らせ

すべてのお知らせを取得

get

/fscmRestApi/resources/11.13.18.05/announcements

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定されたお知らせ識別子を持つお知らせを検索します。
      ファインダ変数:
      • AnnouncementId; string;お知らせの一意の識別子。
  • このパラメータは、リソース・コレクションの内部で返されるリソース数を制限します。 制限がリソース数を超える場合、フレームワークは使用可能なリソースのみ返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AnnouncementId; string;お知らせの一意の識別子。
    • CategoryCode; string;お知らせのカテゴリ・コード。 有効な値はOCおよびOFです。
    • CategoryName; string;お知らせのカテゴリ名。 お知らせには、記事、イベント、インサイトまたはユーザー定義があります。
    • CreatedBy; string;お知らせを作成したユーザー。
    • CreationDate; string;お知らせが作成された日付。
    • Description; string;お知らせの短い説明。
    • ExpireDate; string;お知らせが期限切れになる日付。
    • ExpiryDaysFlag; boolean;お知らせが期限切れになるまでの日数。
    • ImageName; string;アップロードするイメージのファイル名。アナウンスメントのイメージを追加するファイル・オプションが選択されている場合。
    • ImageURL; string;お知らせのイメージを追加するためのURLオプションが選択されている場合、イメージURLリンク。
    • IsVisible; string;お知らせの表示。 可視性は、値'Y'、'N'または'EL式'を使用して決定できます。 デフォルト値は'Y'に設定されます。
    • LastUpdateDate; string;お知らせが最後に更新された日付。
    • LastUpdateLogin; string;この属性は現在使用されていません。
    • LastUpdatedBy; string;お知らせを最後に更新したユーザー。
    • ObjectVersionNumber; integer;この属性は現在使用されていません。
    • ShowAnnouncement; string;お知らせを表示するかどうかを決定します。 可視性は、IsVisible属性で指定されたEL式によって異なります。
    • StartDate; string;お知らせが作成された日付。
    • Subject; 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のデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : お知らせ
タイプ: object
Show Source
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
Show Source
ネストされたスキーマ : announcements-item-response
タイプ: object
Show Source
「トップに戻る」