Oracle Fusion Cloud ProcurementのREST API

1つの価格分岐を取得

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationResponses/{supplierNegotiationResponsesUniqID}/child/lines/{LineId}/child/priceBreaks/{PriceBreakId}

リクエスト

パス・パラメータ

LineId(required): number

このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。たとえば: products?q=InventoryItemId=
PriceBreakId(required): integer

このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。たとえば: products?q=InventoryItemId=
supplierNegotiationResponsesUniqID(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

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

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : supplierNegotiationResponses-lines-priceBreaks-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

行を作成したユーザーを識別します。
CreationDate: string (date-time)

読取り専用: true

行の作成のタイムスタンプ。
LastUpdateBy: string

読取り専用: true

最大長: 32

明細を最後に更新したユーザー。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーが最後に明細を更新した日時。
Line: string

最大長: 25

ネゴシエーション明細を識別する番号。
LineId: integer

タイトル: Line ID

ネゴシエーション明細を識別する値です。
links: array Links

タイトル: Links

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

タイトル: End Date

価格分岐が失効する日付。
PriceBreakId: integer

タイトル: Price Break ID

価格分岐ID
PriceBreakPrice: number

タイトル: Response Value

価格分岐の特定の数量または事業所についてサプライヤが提示した価格。
PriceBreakPriceDiscountPercent: number

タイトル: Price Discount Percentage

特定の数量または価格分岐内の事業所に応じて、サプライヤが提供できる明細価格またはレスポンス価格のパーセント削減。
PriceBreakResponsePrice: number

タイトル: Response Price

価格分岐事業所または数量に基づくレスポンス価格。明細に原価ファクタがある場合、レスポンス価格は原価ファクタを考慮して計算されます。
PriceBreakStartDate: string (date)

タイトル: Start Date

価格分岐が有効になる日付。
PricingBasis: string

タイトル: Pricing Basis

読取り専用: true

最大長: 80

アプリケーションが価格分岐の計算に使用する基準。使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。
PricingBasisCode: string

最大長: 25

アプリケーションがレスポンス明細価格分岐の計算に使用する基準を識別する略称です。使用可能な値のリストは、参照タイプPON_SHIPMENT_PRICING_BASISで定義されます。
Quantity: number

タイトル: Quantity

価格分岐の数量。
ResponseNumber: integer (int64)

タイトル: Response Number

サプライヤ・レスポンスを識別する値です。
ShipToLocation: string

タイトル: Display Name

読取り専用: true

最大長: 240

サプライヤが品目を出荷する事業所の名前。
ShipToLocationId: integer

タイトル: Ship-to Location ID

サプライヤが品目を出荷する事業所を一意に識別する値です。
ShipToOrganization: string

タイトル: Ship-to Organization

読取り専用: true

最大長: 240

サプライヤが品目を出荷する在庫組織の名前です。
ShipToOrganizationId: integer

タイトル: Ship-to Organization ID

サプライヤが品目を出荷する在庫組織を一意に識別する値です。
TargetPrice: number

タイトル: Target Price

読取り専用: true

価格分岐のターゲット価格。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Timestamp of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateBy":{
            "maxLength":32,
            "type":"string",
            "description":"User who most recently updated the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "title":"Ship-to Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location to which the supplier ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Line ID",
            "type":"integer",
            "description":"Value that identifies the negotiation line.",
            "nullable":false,
            "x-queryable":true
        },
        "PricingBasisCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the basis that the application uses to calculate the response line price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBreakStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the price break goes into effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for the price break.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBreakResponsePrice":{
            "title":"Response Price",
            "type":"number",
            "description":"Response price based on the price break location or quantity. If the line has cost factors, then the response price is calculated by taking into account any cost factors.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization to which the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetPrice":{
            "title":"Target Price",
            "type":"number",
            "description":"Target price for the price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipToLocation":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location to which the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":80,
            "type":"string",
            "description":"Basis that the application uses to calculate the price break. A list of accepted values is defined in the lookup type PON_SHIPMENT_PRICING_BASIS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBreakId":{
            "title":"Price Break ID",
            "type":"integer",
            "description":"Price Break ID",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "title":"Ship-to Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization to which the supplier ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseNumber":{
            "title":"Response Number",
            "type":"integer",
            "description":"Value that identifies the supplier response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceBreakPrice":{
            "title":"Response Value",
            "type":"number",
            "description":"Price offered by supplier for certain quantity or location in the price break.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBreakPriceDiscountPercent":{
            "title":"Price Discount Percentage",
            "type":"number",
            "description":"Percentage reduction in the line price or the response price that the supplier can offer depending upon certain quantities, or locations in a price break.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBreakEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the price break expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: 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."
        }
    }
}

トップに戻る

例

この例では、レスポンスID、明細IDおよび価格分岐IDを使用して、ネゴシエーション・レスポンス明細で1つの価格分岐を取得する方法について説明します。

cURLコマンドの例

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/supplierNegotiationResponsesUniqID/child/lines/LineId/child/priceBreaks/PriceBreakId"

たとえば:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/171781/child/lines/1/child/priceBreaks/1"

レスポンス本文の例

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

{
    "ResponseNumber": 171781,
    "LineId": 1,
    "Line": "1",
    "PriceBreakId": 1,
    "ShipToOrganizationId": 7295,
    "ShipToOrganization": "A1 Manufacturing",
    "ShipToLocationId": 16306,
    "ShipToLocation": "Addison TX",
    "Quantity": 10,
    "PriceBreakPrice": 100.00,
    "PriceBreakPriceDiscountPercent": 9.09,
    "PriceBreakResponsePrice": 100.00,
    "TargetPrice": 80.00,
    "PriceBreakStartDate": "2023-08-01",
    "PriceBreakEndDate": "2023-08-05",
    "PricingBasisCode": "PRICE",
    "PricingBasis": "Price",
    "CreatedBy": "CVBUYER02",
    "CreationDate": "2023-07-17T19:44:40+00:00",
    "LastUpdateBy": "0078D08CDA49A893E063036015ACDAEA",
    "LastUpdateDate": "2023-07-17T19:49:51.172+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/171781/child/lines/1/child/priceBreaks/1",
            "name": "priceBreaks",
            "kind": "item",
            "properties": {
                "changeIndicator": ". . ."
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/171781/child/lines/1/child/priceBreaks/1",
            "name": "priceBreaks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/171781/child/lines/1",
            "name": "lines",
            "kind": "item"
        }
    ]
}

「トップに戻る」