Oracle Fusion Cloud ProcurementのREST API

1つの制限の作成

post

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

リクエスト

パス・パラメータ

SupplierInvitationId(required): integer(int64)

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

これは、サプライヤ・ネゴシエーション・リソースの複合キーを構成し、サプライヤ・ネゴシエーションのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ハッシュ・キーを取得するためにサプライヤ・ネゴシエーションの特定のインスタンスにナビゲートするために、サプライヤ・ネゴシエーション収集リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

タイプ: object

ソースを表示

Line: string

タイトル: Line

最大長: 25

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

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

{
    "type":"object",
    "properties":{
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : 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"
    }
}

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

タイプ: 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 -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers/SupplierInvitationId/child/supplierLineAccessRestrictions"

例1 リクエスト本文

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

{
	"Line":2
}

例1 レスポンス本文

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

{
	"AuctionHeaderId": 300100195048752,
	"LineId": 3,
	"SupplierInvitationId": 10,
	"Line": "2",
	"LineDescription": "Laptop Battery",
	"CreatedBy": "CLARE.JONES",
	"CreationDate": "2020-05-28T19:03:16+00:00",
	"LastUpdatedBy": "CLARE.JONES",
	"LastUpdateDate": "2020-05-28T19:03:16.068+00:00",
	"links": [...]
}

例2 cURLコマンド

次のcURLコマンドを使用して、RESTリソースに対するリクエストを発行し、1つのサプライヤに対して複数の明細アクセス制限を作成します。

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

例2 リクエスト本文

Path: /supplierNegotiations/{AuctionHeaderId}/child/suppliers/{SupplierInvitationId}/child/supplierLineAccessRestrictions
{
	"parts": [
	{
		"id": "part1",
		"path": "/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"Line": "1"
		}
	},
	{
		"id": "part2",
		"path": "/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"Line": "3"
		}
	}
	]
}

例2 レスポンス本文

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

{
	"parts": [
	{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"AuctionHeaderId": 300100194925269,
			"LineId": 1,
			"SupplierInvitationId": 30,
			"Line": "1",
			"LineDescription": "UHD 4K Smart LED TV",
			"CreatedBy": "CLARE.JONES",
			"CreationDate": "2020-05-22T11:51:47+00:00",
			"LastUpdatedBy": "CLARE.JONES",
			"LastUpdateDate": "2020-05-22T11:51:47.188+00:00",
			"links": [...]
		}
	},
	{
		"id": "part2",
		"path": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"AuctionHeaderId": 300100194925269,
			"LineId": 2,
			"SupplierInvitationId": 30,
			"Line": "3",
			"LineDescription": "Plain Item",
			"CreatedBy": "CLARE.JONES",
			"CreationDate": "2020-05-22T11:51:47.172+00:00",
			"LastUpdatedBy": "CLARE.JONES",
			"LastUpdateDate": "2020-05-22T11:51:47.188+00:00",
			"links": [...]
		}
	}
	]
}

「トップに戻る」