機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. コンテンツ・ゾーン

すべてのコンテンツ・ゾーンの取得

get

/fscmRestApi/resources/11.13.18.05/contentZones

リクエスト

問合せパラメータ
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

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

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

    フォーマット : ?q=expression1;expression2

    次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ContentZone; string; コンテンツ・ゾーンの名前。
    • ProcurementBU; string; コンテンツ・ゾーンが作成される調達ビジネス・ユニットの名前。
    • SecuredByCode; string; コンテンツ・ゾーンがすべての購買依頼発行BU、特定の購買依頼発行BU、特定の就業者またはすべての調達エージェントによって保護されているかどうかを識別する略称。 有効な値は、AVAIL_ALL_REQ_BUS、SECURED_BY_BU、SECURED_BY_WORKERまたはAVAIL_ALL_WORKERSです。
    • UsageCode; string; コンテンツ・ゾーンが購買依頼発行に使用されるか調達に使用されるかを識別する略称。 有効な値は、REQUISITIONINGまたはPROCUREMENTです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : contentZones
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : contentZones-item-response
タイプ: object
ソースを表示
  • Catalog Assignments
    タイトル: Catalog Assignments
    カタログ割当リソースは、コンテンツ・ゾーンのカタログ割当を管理します。 ローカル・カタログ・タイプとパンチ・アウト・カタログ・タイプ、情報カタログ・タイプをコンテンツ・ゾーンに割り当てることができます。
  • タイトル: Content Zone
    最大長: 30
    コンテンツ・ゾーンの名前。
  • 読取り専用: true
    コンテンツ・ゾーンを一意に識別する値。
  • 読取り専用: true
    最大長: 64
    コンテンツ・ゾーンを作成したユーザー。
  • 読取り専用: true
    ユーザーがコンテンツ・ゾーンを作成した日時。
  • タイトル: Description
    最大長: 240
    コンテンツ・ゾーンの摘要。
  • 読取り専用: true
    最大長: 64
    コンテンツ・ゾーンを最後に更新したユーザー。
  • 読取り専用: true
    ユーザーがコンテンツ・ゾーンを最後に更新した日時。
  • Links
  • タイトル: Procurement BU
    コンテンツ・ゾーンが作成される調達ビジネス・ユニットの名前。
  • コンテンツ・ゾーンが作成される調達ビジネス・ユニットを一意に識別する値。
  • Public Shopping List Assignments
    タイトル: Public Shopping List Assignments
    公開ショッピング・リスト割当リソースは、コンテンツ・ゾーンの公開ショッピング・リスト割当を管理します。
  • タイトル: Secured By
    コンテンツ・ゾーンの保護方法を決定するセキュリティ値。 有効な値は、「すべての購買依頼発行BU」、「購買依頼発行BU」、「就業者」または「すべての調達エージェント」です。
  • 最大長: 18
    コンテンツ・ゾーンがすべての購買依頼発行BU、特定の購買依頼発行BU、特定の就業者またはすべての調達エージェントによって保護されているかどうかを識別する略称です。 有効な値は、AVAIL_ALL_REQ_BUS、SECURED_BY_BU、SECURED_BY_WORKERまたはAVAIL_ALL_WORKERSです。
  • Security Assignments
    タイトル: Security Assignments
    セキュリティ割当リソースは、BUまたは就業者を購買依頼発行することによって、コンテンツ・ゾーンのセキュリティ・アクセス割当を管理します。
  • Smart Form Assignments
    タイトル: Smart Form Assignments
    スマート・フォーム割当リソースは、コンテンツ・ゾーンのスマート・フォーム割当を管理します。 スマート・フォームは、購買依頼発行の使用に対してのみコンテンツ・ゾーンに割り当てることができます。
  • タイトル: Usage
    コンテンツ・ゾーンが適用される場所を決定するために使用します。 有効な値は、「購買依頼発行」または「調達」です。
  • 最大長: 15
    コンテンツ・ゾーンが購買依頼発行または調達に使用されるかどうかを識別する略称です。 有効な値は、REQUISITIONINGまたはPROCUREMENTです。
ネストされたスキーマ : カタログ割当
タイプ: array
タイトル: Catalog Assignments
カタログ割当リソースは、コンテンツ・ゾーンのカタログ割当を管理します。 ローカル・カタログ・タイプとパンチ・アウト・カタログ・タイプ、情報カタログ・タイプをコンテンツ・ゾーンに割り当てることができます。
ソースを表示
ネストされたスキーマ : 公開ショッピング・リスト割当
タイプ: array
タイトル: Public Shopping List Assignments
公開ショッピング・リスト割当リソースは、コンテンツ・ゾーンの公開ショッピング・リスト割当を管理します。
ソースを表示
ネストされたスキーマ : セキュリティ割当
タイプ: array
タイトル: Security Assignments
セキュリティ割当リソースは、BUまたは就業者を購買依頼発行することによって、コンテンツ・ゾーンのセキュリティ・アクセス割当を管理します。
ソースを表示
ネストされたスキーマ : スマート・フォーム割当
タイプ: array
タイトル: Smart Form Assignments
スマート・フォーム割当リソースは、コンテンツ・ゾーンのスマート・フォーム割当を管理します。 スマート・フォームは、購買依頼発行の使用に対してのみコンテンツ・ゾーンに割り当てることができます。
ソースを表示
ネストされたスキーマ : contentZones-catalogAssignments-item-response
タイプ: object
ソースを表示
  • タイトル: Catalog
    コンテンツ・ゾーンに割り当てられているカタログの名前。
  • 読取り専用: true
    カタログ割当を一意に識別する値。
  • コンテンツ・ゾーンに割り当てられたカタログを一意に識別する値。
  • タイトル: Catalog Type
    読取り専用: true
    最大長: 80
    コンテンツ・ゾーンに割り当てられているカタログのタイプです。 有効な値は、「ローカル」、「パンチ・アウト」または「情報」です。
  • 読取り専用: true
    最大長: 15
    カタログのタイプを識別する略称。 有効な値は、LOCAL、PUNCHOUTまたはINFORMATIONALです。
  • 読取り専用: true
    コンテンツ・ゾーンを一意に識別する値。
  • 読取り専用: true
    最大長: 64
    カタログ割当を作成したユーザー。
  • 読取り専用: true
    ユーザーがカタログ割当を作成した日時。
  • 読取り専用: true
    最大長: 64
    カタログ割当を最後に更新したユーザー。
  • 読取り専用: true
    ユーザーがカタログ割当を最後に更新した日時。
  • Links
ネストされたスキーマ : contentZones-publicShoppingListAssignments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contentZones-securityAssignments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contentZones-smartFormAssignments-item-response
タイプ: object
ソースを表示
トップに戻る

例

この例では、すべてのコンテンツ・ゾーンを取得する方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/contentZones"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます: 
{
    "items": [
        {
            "ContentZoneId": 300100585271633,
            "ContentZone": "Content Zone for PRC Use",
            "ProcurementBUId": 1017,
            "ProcurementBU": "Vision Italy",
            "Description": "This content zone is for procurement",
            "UsageCode": "PROCUREMENT",
            "Usage": "Procurement",
            "SecuredByCode": "AVAIL_ALL_WORKERS",
            "SecuredBy": "All procurement agents",
            "CreationDate": "2023-11-01T16:20:59.154+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdatedDate": "2023-11-01T16:20:59.154+00:00"
        },
        {
            "ContentZoneId": 300100585274636,
            "ContentZone": "Office Supplies",
            "ProcurementBUId": 1017,
            "ProcurementBU": "Vision Italy",
            "Description": "This content zone is for requisitioning and secured by workers",
            "UsageCode": "REQUISITIONING",
            "Usage": "Requisitioning",
            "SecuredByCode": "SECURED_BY_WORKER",
            "SecuredBy": "Workers",
            "CreationDate": "2023-11-01T16:15:23.188+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdatedDate": "2023-11-01T16:15:23.188+00:00"
        }
    ],
    "totalResults": 2,
    "count": 2,
    "hasMore": false,
    "limit": 500,
    "offset": 0,
    "links": [
        . . .
    ]
}
「トップに戻る」