Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

コンプライアンス・チェックリスト・レコードを1つ取得

get

/fscmRestApi/resources/11.13.18.05/complianceChecklists/{complianceChecklistsUniqID}

リクエスト

パス・パラメータ

complianceChecklistsUniqID(required): string

これは、コンプライアンス・チェックリスト・リソースのコンポジット・キーを構成し、コンプライアンス・チェックリストのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、コンプライアンス・チェックリストの特定のインスタンスに移動してハッシュ・キーを取得するために、コンプライアンス・チェックリストの収集リソースを問い合せる必要があります。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。

ヘッダー・パラメータ

Effective-Of:

このヘッダーは文字列値を受け入れます。この文字列は、セミコロンで区切られた=のリストです。有効日範囲操作の実行に使用されます。受け入れられるパラメータは、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の値は、解析時に正の整数が生成されるように文字列である必要があります。
Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : complianceChecklists-item-response

タイプ: object

ソースを表示

CanceledBy: string

タイトル: Canceled By

読取り専用: true

最大長: 240

コンプライアンス・チェックリストを取り消したユーザーの名前。
CanceledById: integer (int64)

読取り専用: true

コンプライアンス・チェックリストを取り消したユーザーの識別子。
CanceledReason: string

タイトル: Canceled Reason

最大長: 1000

コンプライアンス・チェックリスト取消の事由。
CancellationDate: string (date-time)

タイトル: Canceled On

読取り専用: true

コンプライアンス・チェックリスト取消の日付。
Checklist: string

最大長: 30

コンプライアンス・チェックリストを一意に識別する値。
ChecklistInitiativeId: integer (int64)

コンプライアンス・チェックリストのシステム識別子。識別子はイニシアチブIDとして格納されます。
ChecklistOwner: string

タイトル: Checklist Owner

最大長: 240

コンプライアンス・チェックリストの所有者。
ChecklistOwnerId: integer (int64)

コンプライアンス・チェックリスト所有者の識別子。
ChecklistTemplate: string

最大長: 80

コンプライアンス・チェックリストの作成に使用するチェックリスト・テンプレート。
ChecklistTemplateId: integer (int64)

コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのシステム識別子。
ChecklistTemplateRevision: integer (int32)

読取り専用: true

コンプライアンス・チェックリストの作成に使用されるチェックリスト・テンプレートのリビジョン。
CompletedBy: string

タイトル: Completed By

読取り専用: true

最大長: 240

コンプライアンス・チェックリストを完了したユーザーの名前。
CompletedById: integer (int64)

読取り専用: true

コンプライアンス・チェックリストを完了したユーザーの識別子。
CompletionDate: string (date-time)

タイトル: Completed On

読取り専用: true

コンプライアンス・チェックリスト完了の日付。
CreationDate: string (date-time)

タイトル: Created On

読取り専用: true

チェックリストが作成された日時。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
POHeaderId: integer

読取り専用: true

コンプライアンス・チェックリストに関連付けられた購買文書のシステム識別子。
PONumber: string

読取り専用: true

最大長: 80

コンプライアンス・チェックリストに関連付けられた購買文書を一意に識別する値。
POStatus: string

読取り専用: true

最大長: 80

コンプライアンス・チェックリストに関連付けられた購買文書のステータスです。
ProcurementBU: string

タイトル: Procurement BU

最大長: 240

コンプライアンス・チェックリストが作成された調達ビジネス・ユニット。
ProcurementBUId: integer (int64)

コンプライアンス・チェックリストが作成された調達ビジネス・ユニットのビジネス・ユニット識別子。
PurchasingDocumentType: string

読取り専用: true

最大長: 80

コンプライアンス・チェックリストに関連付けられた購買文書のタイプです。
ReopenDate: string (date-time)

タイトル: Reopened On

読取り専用: true

コンプライアンス・チェックリストが再オープンされた日付。
ReopenedBy: string

タイトル: Reopened By

読取り専用: true

最大長: 240

コンプライアンス・チェックリストを再オープンしたユーザーの名前。
ReopenedById: integer (int64)

読取り専用: true

コンプライアンス・チェックリストを再オープンしたユーザーの識別子。
ReopenReason: string

タイトル: Reopening Reason

最大長: 1000

コンプライアンス・チェックリストを再オープンする事由。
Status: string

タイトル: Status

最大長: 80

コンプライアンス・チェックリストのステータス。
StatusCode: string

最大長: 30

コンプライアンス・チェックリスト・ステータスのコード。
Title: string

最大長: 80

コンプライアンス・チェックリストのタイトル。

{
    "type":"object",
    "properties":{
        "PONumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the purchasing document associated with the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReopenDate":{
            "title":"Reopened On",
            "type":"string",
            "description":"Date the compliance checklist was reopened.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"Date and time when the checklist was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedBy":{
            "title":"Completed By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the user who completed the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistTemplate":{
            "maxLength":80,
            "type":"string",
            "description":"Checklist template used to create the compliance checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBUId"
                ]
            },
            "x-queryable":true
        },
        "ReopenedById":{
            "type":"integer",
            "description":"Identifier of the user who reopened the compliance checklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletedById":{
            "type":"integer",
            "description":"Identifier of the user who completed the compliance checklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReopenedBy":{
            "title":"Reopened By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the user who reopened the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the purchasing document associated with the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the compliance checklist status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"System identifier of the purchasing document associated with the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReopenReason":{
            "title":"Reopening Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Reason for reopening the compliance checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CanceledBy":{
            "title":"Canceled By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the user who canceled the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistTemplateRevision":{
            "type":"integer",
            "description":"Revision of the checklist template used to create the compliance checklist.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completed On",
            "type":"string",
            "description":"Date of the compliance checklist completion.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistTemplateId":{
            "type":"integer",
            "description":"System identifier of the checklist template used to create the compliance checklist.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledReason":{
            "title":"Canceled Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Reason for the compliance checklist cancellation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Business unit identifier of the procurement business unit where the compliance checklist was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit where the compliance checklist was created.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the compliance checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CancellationDate":{
            "title":"Canceled On",
            "type":"string",
            "description":"Date of the compliance checklist cancellation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistInitiativeId":{
            "type":"integer",
            "description":"System identifier of the compliance checklist. The identifier is stored as an initiative ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChecklistOwner":{
            "title":"Checklist Owner",
            "maxLength":240,
            "type":"string",
            "description":"Owner of the compliance checklist.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBUId"
                ]
            },
            "x-queryable":true
        },
        "Title":{
            "maxLength":80,
            "type":"string",
            "description":"Title of the compliance checklist.",
            "nullable":false,
            "x-queryable":true
        },
        "ChecklistOwnerId":{
            "type":"integer",
            "description":"Identifier of the compliance checklist owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CanceledById":{
            "type":"integer",
            "description":"Identifier of the user who canceled the compliance checklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Checklist":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the compliance checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchasingDocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the purchasing document associated with the compliance checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例

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

cURLコマンドの例

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

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

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "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"
        }
    ]
}

「トップに戻る」