Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

1つのヘッダーの更新

patch

/fscmRestApi/resources/11.13.18.05/publicShoppingLists/{publicShoppingListsUniqID}

リクエスト

パス・パラメータ

publicShoppingListsUniqID(required): string

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

ヘッダー・パラメータ

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

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

ImageURL: string

最大長: 1000

公開ショッピング・リストを表すイメージを特定するURL。
ProcurementBU: string

タイトル: Procurement BU

公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。
ProcurementBUId: integer (int64)

公開ショッピング・リストが作成される調達ビジネス・ユニットを一意に識別する値。
PublicShoppingList: string

最大長: 100

公開ショッピング・リストの名前。
PublicShoppingListDescription: string

最大長: 250

公開ショッピング・リストの説明。
PublicShoppingListEndDate: string (date)

公開ショッピング・リストが非アクティブ化される日時。
PublicShoppingListStartDate: string (date)

公開ショッピング・リストがアクティブ化される日時。

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit in which the public shopping list is created.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "type":"string",
            "description":"Name of the procurement business unit in which the public shopping list is created.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PublicShoppingListDescription":{
            "maxLength":250,
            "type":"string",
            "description":"Description of the public shopping list.",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingListEndDate":{
            "type":"string",
            "description":"Date and time when the public shopping list is inactivated.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingListStartDate":{
            "type":"string",
            "description":"Date and time when the public shopping list is activated.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"URL that locates the image representing the public shopping list.",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingList":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the public shopping list.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

公開ショッピング・リストを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーが公開ショッピング・リストを作成した日時。
ImageURL: string

最大長: 1000

公開ショッピング・リストを表すイメージを特定するURL。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーが公開ショッピング・リストを最後に更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

公開ショッピング・リストを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Procurement BU

公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。
ProcurementBUId: integer (int64)

公開ショッピング・リストが作成される調達ビジネス・ユニットを一意に識別する値。
PublicShoppingList: string

最大長: 100

公開ショッピング・リストの名前。
PublicShoppingListDescription: string

最大長: 250

公開ショッピング・リストの説明。
PublicShoppingListEndDate: string (date)

公開ショッピング・リストが非アクティブ化される日時。
PublicShoppingListHeaderId: integer (int64)

読取り専用: true

公開ショッピング・リストを一意に識別する値。
PublicShoppingListStartDate: string (date)

公開ショッピング・リストがアクティブ化される日時。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the public shopping list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit in which the public shopping list is created.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "type":"string",
            "description":"Name of the procurement business unit in which the public shopping list is created.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PublicShoppingListDescription":{
            "maxLength":250,
            "type":"string",
            "description":"Description of the public shopping list.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the public shopping list.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the public shopping list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"URL that locates the image representing the public shopping list.",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingList":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the public shopping list.",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingListHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the public shopping list.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PublicShoppingListEndDate":{
            "type":"string",
            "description":"Date and time when the public shopping list is inactivated.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PublicShoppingListStartDate":{
            "type":"string",
            "description":"Date and time when the public shopping list is activated.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the public shopping list.",
            "format":"date-time",
            "nullable":false,
            "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 -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/publicShoppingLists/publicShoppingListsUniqID"

たとえば:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/publicShoppingLists/300100559283171"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。

{
    "PublicShoppingListStartDate": "2022-08-07",
    "PublicShoppingList": "New Hire Kit",
    "PublicShoppingListDescription": "Office supplies for new employees."
}

レスポンス本文の例

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

{
    "PublicShoppingListHeaderId": 300100559283171,
    "PublicShoppingList": "New Hire Kit",
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Operations",
    "PublicShoppingListDescription": "Office supplies for new employees.",
    "PublicShoppingListEndDate": null,
    "PublicShoppingListStartDate": "2022-08-07",
    "CreatedBy": "CVRQST17",
    "CreationDate": "2022-07-21T00:27:34+00:00",
    "LastUpdateDate": "2022-07-21T00:37:07+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559283171",
            "name": "publicShoppingLists",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559283171",
            "name": "publicShoppingLists",
            "kind": "item"
        }
    ]
}

「トップに戻る」