機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. 遵守チェックリスト

すべてのコンプライアンス・チェックリスト・レコードの取得

get

/fscmRestApi/resources/11.13.18.05/complianceChecklists

リクエスト

問合せパラメータ
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、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指定した主キーに従ってコンプライアンス・チェックリスト・レコードを検索します。
      ファインダ変数
      • ChecklistInitiativeId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CanceledBy; string; コンプライアンス・チェックリストを取り消したユーザーの名前。
    • CanceledById; integer; コンプライアンス・チェックリストを取り消したユーザーの識別子。
    • CanceledReason; string; コンプライアンス・チェックリストの取消の理由。
    • CancellationDate; string; コンプライアンス・チェックリストの取消の日付。
    • Checklist; string; コンプライアンス・チェックリストを一意に識別する値。
    • ChecklistInitiativeId; integer; コンプライアンス・チェックリストのシステム識別子。 識別子はイニシアチブIDとして格納されます。
    • ChecklistOwner; string; コンプライアンス・チェックリストの所有者。
    • ChecklistOwnerId; integer; コンプライアンス・チェックリスト所有者の識別子。
    • ChecklistTemplate; string; コンプライアンス・チェックリストの作成に使用するチェックリスト・テンプレート。
    • ChecklistTemplateId; integer; コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのシステム識別子。
    • ChecklistTemplateRevision; integer; コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのリビジョン。
    • CompletedBy; string; コンプライアンス・チェックリストを完了したユーザーの名前。
    • CompletedById; integer; コンプライアンス・チェックリストを完了したユーザーの識別子。
    • CompletionDate; string; コンプライアンス・チェックリストの完了日。
    • CreationDate; string; チェックリストが作成された日時。
    • ProcurementBU; string; コンプライアンス・チェックリストが作成された調達ビジネス・ユニット。
    • ProcurementBUId; integer; コンプライアンス・チェックリストが作成された調達ビジネス・ユニットのビジネス・ユニット識別子。
    • ReopenDate; string; コンプライアンス・チェックリストが再オープンされた日付。
    • ReopenReason; string; コンプライアンス・チェックリストを再オープンする理由。
    • ReopenedBy; string; コンプライアンス・チェックリストを再オープンしたユーザーの名前。
    • ReopenedById; integer; コンプライアンス・チェックリストを再オープンしたユーザーの識別子。
    • Status; string; コンプライアンス・チェックリストのステータス。
    • StatusCode; string; コンプライアンス・チェックリスト・ステータスのコード。
    • Title; string; コンプライアンス・チェックリストのタイトル。
  • "?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のデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : complianceChecklists
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : complianceChecklists-item-response
タイプ: object
ソースを表示
  • タイトル: Canceled By
    読取り専用: true
    最大長: 240
    コンプライアンス・チェックリストを取り消したユーザーの名前。
  • 読取り専用: true
    コンプライアンス・チェックリストを取り消したユーザーの識別子。
  • タイトル: Canceled Reason
    最大長: 1000
    コンプライアンス・チェックリスト取消の事由。
  • タイトル: Canceled On
    読取り専用: true
    コンプライアンス・チェックリスト取消の日付。
  • 最大長: 30
    コンプライアンス・チェックリストを一意に識別する値。
  • コンプライアンス・チェックリストのシステム識別子。 識別子はイニシアチブIDとして格納されます。
  • タイトル: Checklist Owner
    最大長: 240
    コンプライアンス・チェックリストの所有者。
  • コンプライアンス・チェックリスト所有者の識別子。
  • 最大長: 80
    コンプライアンス・チェックリストの作成に使用するチェックリスト・テンプレート。
  • コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのシステム識別子。
  • 読取り専用: true
    コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのリビジョン。
  • タイトル: Completed By
    読取り専用: true
    最大長: 240
    コンプライアンス・チェックリストを完了したユーザーの名前。
  • 読取り専用: true
    コンプライアンス・チェックリストを完了したユーザーの識別子。
  • タイトル: Completed On
    読取り専用: true
    コンプライアンス・チェックリスト完了の日付。
  • タイトル: Created On
    読取り専用: true
    チェックリストが作成された日時。
  • Links
  • 読取り専用: true
    コンプライアンス・チェックリストに関連付けられた購買文書のシステム識別子。
  • 読取り専用: true
    最大長: 80
    コンプライアンス・チェックリストに関連付けられた購買文書を一意に識別する値。
  • 読取り専用: true
    最大長: 80
    コンプライアンス・チェックリストに関連付けられた購買文書のステータスです。
  • タイトル: Procurement BU
    最大長: 240
    コンプライアンス・チェックリストが作成された調達ビジネス・ユニット。
  • コンプライアンス・チェックリストが作成された調達ビジネス・ユニットのビジネス・ユニット識別子。
  • 読取り専用: true
    最大長: 80
    コンプライアンス・チェックリストに関連付けられた購買文書のタイプです。
  • タイトル: Reopened On
    読取り専用: true
    コンプライアンス・チェックリストが再オープンされた日付。
  • タイトル: Reopened By
    読取り専用: true
    最大長: 240
    コンプライアンス・チェックリストを再オープンしたユーザーの名前。
  • 読取り専用: true
    コンプライアンス・チェックリストを再オープンしたユーザーの識別子。
  • タイトル: Reopening Reason
    最大長: 1000
    コンプライアンス・チェックリストを再オープンする事由。
  • タイトル: Status
    最大長: 80
    コンプライアンス・チェックリストのステータス。
  • 最大長: 30
    コンプライアンス・チェックリスト・ステータスのコード。
  • 最大長: 80
    コンプライアンス・チェックリストのタイトル。
トップに戻る

例

この例では、すべてのコンプライアンス・チェックリストを取得する方法について説明します。

cURLコマンドの例

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

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

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます: 
{
    "items": [
        {
            "ChecklistInitiativeId": 300100583348975,
            "Checklist": "Checklist-99",
            "Title": "Direct Materials - Oct 2023",
            "StatusCode": "ORA_COMPLETED",
            "Status": "Completed",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "ChecklistOwnerId": 100010026863783,
            "ChecklistOwner": "Furey,Clare",
            "ChecklistTemplateId": 300100583350637,
            "ChecklistTemplate": "Direct Materials",
            "ChecklistTemplateRevision": 1,
            "ReopenDate": "2023-10-17T01:04:31.201+00:00",
            "ReopenedById": 100010026863783,
            "ReopenedBy": "Furey,Clare",
            "ReopenReason": "test",
            "CompletionDate": "2023-10-17T01:07:25.808+00:00",
            "CompletedById": 100010026863783,
            "CompletedBy": "Furey,Clare",
            "CancellationDate": null,
            "CanceledById": null,
            "CanceledBy": null,
            "CanceledReason": null,
            "CreationDate": "2023-10-16T22:44:58+00:00",
            "POHeaderId": null,
            "PONumber": null,
            "POStatus": null,
            "PurchasingDocumentType": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/complianceChecklists/300100583348975",
                    "name": "complianceChecklists",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/complianceChecklists/300100583348975",
                    "name": "complianceChecklists",
                    "kind": "item"
                }
            ]
        },{
. . .
  } ],
. . .
}
],
 "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/complianceChecklists",
            "name": "complianceChecklists",
            "kind": "collection"
        }
    ]
}
「トップに戻る」