Oracle Fusion Cloud ProcurementのREST API

1つのサプライヤの取得

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}

リクエスト

パス・パラメータ

SupplierInvitationId(required): integer(int64)

ネゴシエーションに招待されたサプライヤを一意に識別する値です。
supplierNegotiationsUniqID(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のデフォルト・バージョンを選択します。

ルート・スキーマ : supplierNegotiations-suppliers-item-response

タイプ: object

ソースを表示

AdditionalContactEmail: string

タイトル: Additional Email

最大長: 240

各参加依頼サプライヤの追加担当者のEメール・アドレス。
AuctionHeaderId: integer (int64)

読取り専用: true

ネゴシエーションを一意に識別する値です。
ConversionRate: number

タイトル: Conversion Rate

読取り専用: true

ネゴシエーション通貨が1つのレスポンス通貨と等しいレートです。
CreatedBy: string

読取り専用: true

最大長: 64

サプライヤを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーがサプライヤを作成した日時。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーが最後にサプライヤを更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

最後にサプライヤを更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Notify All Contacts

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤのすべての担当に通知が送信されます。 falseの場合、招待された担当者またはサプライヤの追加Eメールにのみ通知が送信されます。デフォルト値はfalseです。
PricePrecision: number

タイトル: Price Precision

読取り専用: true

レスポンスの価格属性に対してアプリケーションで表示される小数点以下の桁数。
RequestedSupplier: string

最大長: 240

ネゴシエーションに応答するためにアプリケーションが参加を依頼するサプライヤの名前。承認保留中に適用されます。
RequestedSupplierContact: string

ネゴシエーションへの応答をアプリケーションが依頼するサプライヤの担当者の名前。承認保留中に適用されます。
RequestedSupplierContactId: integer (int64)

アプリケーションがネゴシエーションへの応答を依頼するサプライヤの担当を識別する値です。承認保留中に適用されます。
RequestedSupplierId: integer (int64)

アプリケーションがネゴシエーションへの応答を依頼するサプライヤを識別する値です。承認保留中に適用されます。
ResponseCurrency: string

タイトル: Response Currency

読取り専用: true

最大長: 80

サプライヤがネゴシエーション・レスポンスで使用する通貨の名前。
ResponseCurrencyCode: string

タイトル: Response Currency Code

読取り専用: true

最大長: 15

サプライヤがネゴシエーション・レスポンスで使用する通貨を識別する略称です。
Supplier: string

タイトル: Supplier

最大長: 360

アプリケーションがネゴシエーションへのレスポンスを依頼したサプライヤ会社の名前。
SupplierContact: string

購買組織との通信中にサプライヤを表すサプライヤ従業員の名前。
SupplierContactId: integer (int64)

購買組織との通信中にサプライヤを表すサプライヤ従業員を識別する値です。
SupplierId: integer (int64)

アプリケーションがネゴシエーションへの応答を依頼したサプライヤ会社を識別する値です。
SupplierInvitationId: integer (int64)

読取り専用: true

ネゴシエーションに招待されたサプライヤを一意に識別する値です。
supplierLineAccessRestrictions: array Access Restrictions

タイトル: Access Restrictions

アクセス制限リソースは、サプライヤ・アクセスが制限されているネゴシエーション明細に関する詳細を管理します。
SupplierNumber: integer (int64)

読取り専用: true

アプリケーションがネゴシエーションに応答するよう招待したサプライヤを識別する番号。
SupplierSite: string

タイトル: Supplier Site

最大長: 240

サプライヤ・サイトの名前。
SupplierSiteId: integer (int64)

サプライヤ・サイトを識別する値です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the supplier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierContact":{
            "type":"string",
            "description":"Name of the supplier employee who represents the supplier during communication with the buying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PersonTitle",
                    "PersonFirstName",
                    "PersonLastName",
                    "PersonMiddleName"
                ]
            },
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the supplier employee who represents the supplier during communication with the buying organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestedSupplier":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricePrecision":{
            "title":"Price Precision",
            "type":"number",
            "description":"Number of decimal places that the application displays for price attributes in the response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedSupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotifyAllSupplierContactsFlag":{
            "title":"Notify All Contacts",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then notifications are sent to all contacts of the supplier. If false, notifications are sent only to the invited contact or additional email of the supplier. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier company that the application invited to response to the negotiation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "supplierLineAccessRestrictions":{
            "title":"Access Restrictions",
            "type":"array",
            "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response"
            }
        },
        "RequestedSupplierContact":{
            "type":"string",
            "description":"Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierNumber":{
            "type":"integer",
            "description":"Number that identifies the supplier that the application invited to respond to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the supplier uses in the negotiation response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedSupplierId":{
            "type":"integer",
            "description":"Value that identifies the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that identifies the supplier company that the application invited to respond to the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdditionalContactEmail":{
            "title":"Additional Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the additional contact for each invited supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Rate at which the negotiation currency equals one response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseCurrency":{
            "title":"Response Currency",
            "maxLength":80,
            "type":"string",
            "description":"Name of currency that the supplier uses in the negotiation response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier.",
            "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"
    }
}

ネストされたスキーマ : アクセス制限

タイプ: array

タイトル: Access Restrictions

アクセス制限リソースは、サプライヤ・アクセスが制限されているネゴシエーション明細に関する詳細を管理します。

ソースを表示

Array of: object supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response

{
    "title":"Access Restrictions",
    "type":"array",
    "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response"
    }
}

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

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

ネストされたスキーマ : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response

タイプ: object

ソースを表示

AuctionHeaderId: integer (int64)

読取り専用: true

ネゴシエーションを一意に識別する値です。
CreatedBy: string

読取り専用: true

最大長: 64

制限を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーが制限を作成した日時。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーが最近制限を更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

制限を最後に更新したユーザー。
Line: string

タイトル: Line

最大長: 25

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

タイトル: Line Description

読取り専用: true

最大長: 2500

ネゴシエーション明細の摘要。
LineId: number

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

タイトル: Links

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

読取り専用: true

ネゴシエーションに招待されたサプライヤを一意に識別する値です。

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the restriction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Line Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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 restriction.",
            "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"
    }
}

リンク

supplierLineAccessRestrictions

操作: /fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}/child/supplierLineAccessRestrictions

パラメータ:

SupplierInvitationId: $request.path.SupplierInvitationId
supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID

アクセス制限リソースは、サプライヤ・アクセスが制限されているネゴシエーション明細に関する詳細を管理します。

トップに戻る

例

この例では、1つのサプライヤを取得する方法について説明します。

cURLコマンドの例

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers/SupplierInvitationId"

レスポンス本文の例

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

{
    "AuctionHeaderId": 300100152357495,
    "SupplierInvitationId": 30,
    "SupplierNumber": 12,
    "Supplier": "CV_SuppA01",
    "SupplierId": 12496,
    "SupplierSite": "CVSuppA01Site01",
    "SupplierSiteId": 2444,
    "SupplierContact": "Brown, Rob",
    "SupplierContactId": 299647,
    "AdditionalContactEmail": null,
    "NotifyAllSupplierContactsFlag": true,
    "RequestedSupplier": null,
    "RequestedSupplierId": null,
    "RequestedSupplierContact": null,
    "RequestedSupplierContactId": null,
    "ResponseCurrency": "US Dollar",
    "ResponseCurrencyCode": "USD",
    "ConversionRate": 1,
    "PricePrecision": 2,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2018-06-28T11:33:14.566+00:00",
    "LastUpdateDate": "2018-06-28T11:34:48.919+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "links": [<Do not change anything here>]
}

「トップに戻る」