Oracle Fusion Cloud ProcurementのREST API

1人のチーム・メンバーを更新

patch

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/collaborationTeamMembers/{TeamMemberId}

リクエスト

パス・パラメータ

TeamMemberId(required): integer(int64)

各チーム・メンバーを一意に識別する値。
supplierNegotiationsUniqID(required): string

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

タイプ: object

ソースを表示

Access: string

タイトル: Access

最大長: 80

各コラボレーション・チーム・メンバーに対するアクセス権。値には、完全または表示のみがあります。受け入れられる値のリストは、参照タイプPON_NEG_COLLAB_TEAM_ACCESSで定義されます。
AccessCode: string

タイトル: Access Code

最大長: 30

各コラボレーション・チーム・メンバーのアクセスを識別する略称です。値には、FULLまたはVIEW_ONLYがあります。受け入れられる値のリストは、参照タイプPON_NEG_COLLAB_TEAM_ACCESSで定義されます。
PersonId: integer (int64)

アプリケーションがネゴシエーションに追加したコラボレーション・チームを一意に識別する値です。
PriceVisibilityFlag: boolean

タイトル: Price Visibility

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、チーム・メンバーは各レスポンスの評価時にレスポンス文書の価格詳細を表示できます。 falseの場合、表示できません。デフォルト値はtrueです。
SupplierMessages: string

タイトル: Supplier Messages

最大長: 80

各コラボレーション・チーム・メンバーのメッセージ・サプライヤへのアクセス。値には、アクセスなし、受信のみまたは送信して受信があります。受け入れられる値のリストは、参照タイプORA_PON_COLLAB_TEAM_SUPP_MSGで定義されます。
SupplierMessagesCode: string

タイトル: Supplier Messages Code

最大長: 30

各コラボレーション・チーム・メンバーのメッセージ・サプライヤへのアクセスを識別する略称です。値は、ORA_NO_ACCESS、ORA_RECEIVE_ONLYまたはORA_SEND_AND_RECEIVEです。受け入れられる値のリストは、参照タイプORA_PON_COLLAB_TEAM_SUPP_MSGで定義されます。
TaskName: string

タイトル: Task

最大長: 4000

アプリケーションがコラボレーション・チーム・メンバーに割り当てたタスクの名前。
TaskTargetDate: string (date)

タイトル: Target Date

アプリケーションで、コラボレーション・チーム・メンバーが割当済タスクを完了すると予想される日付。
TeamMember: string

タイトル: Team Member

最大長: 240

アプリケーションがネゴシエーションに追加したコラボレーション・チーム・メンバーの名前。

{
    "type":"object",
    "properties":{
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration team that the application added to the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TaskName":{
            "title":"Task",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the task that the application assigned to the collaboration team member.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierMessagesCode":{
            "title":"Supplier Messages Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the access to message suppliers for each collaboration team member. Values include ORA_NO_ACCESS, ORA_RECEIVE_ONLY, or ORA_SEND_AND_RECEIVE. A list of accepted values is defined in the lookup type ORA_PON_COLLAB_TEAM_SUPP_MSG.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierMessages":{
            "title":"Supplier Messages",
            "maxLength":80,
            "type":"string",
            "description":"Access to message suppliers for each collaboration team member. Values include No access, Receive only, or Send and receive. A list of accepted values is defined in the lookup type ORA_PON_COLLAB_TEAM_SUPP_MSG.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Access":{
            "title":"Access",
            "maxLength":80,
            "type":"string",
            "description":"Access for each collaboration team member. Values include Full or View Only. A list of accepted values is defined in the lookup type PON_NEG_COLLAB_TEAM_ACCESS.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessCode":{
            "title":"Access Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the access for each collaboration team member. Values include FULL or VIEW_ONLY. A list of accepted values is defined in the lookup type PON_NEG_COLLAB_TEAM_ACCESS.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceVisibilityFlag":{
            "title":"Price Visibility",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the team member can view price details on the response document when evaluating each response. If false, then cannot view. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "TeamMember":{
            "title":"Team Member",
            "maxLength":240,
            "type":"string",
            "description":"Name of the collaboration team member that the application added to the negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaskTargetDate":{
            "title":"Target Date",
            "type":"string",
            "description":"Date when the application expects the collaboration team member to finishes the assigned task.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

Access: string

タイトル: Access

最大長: 80

各コラボレーション・チーム・メンバーに対するアクセス権。値には、完全または表示のみがあります。受け入れられる値のリストは、参照タイプPON_NEG_COLLAB_TEAM_ACCESSで定義されます。
AccessCode: string

タイトル: Access Code

最大長: 30

各コラボレーション・チーム・メンバーのアクセスを識別する略称です。値には、FULLまたはVIEW_ONLYがあります。受け入れられる値のリストは、参照タイプPON_NEG_COLLAB_TEAM_ACCESSで定義されます。
CreatedBy: string

読取り専用: true

最大長: 64

チーム・メンバーを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーがチーム・メンバーを作成した日時。
LastNotifiedDate: string (date-time)

タイトル: Last Notified Date

読取り専用: true

コラボレーション・チーム・タスクについて、アプリケーションが最近コラボレーション・チーム・メンバーに通知した日時。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーが最後にチーム・メンバーを更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

チーム・メンバーを最後に更新したユーザー。
links: array Links

タイトル: Links

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

アプリケーションがネゴシエーションに追加したコラボレーション・チームを一意に識別する値です。
PriceVisibilityFlag: boolean

タイトル: Price Visibility

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、チーム・メンバーは各レスポンスの評価時にレスポンス文書の価格詳細を表示できます。 falseの場合、表示できません。デフォルト値はtrueです。
SupplierMessages: string

タイトル: Supplier Messages

最大長: 80

各コラボレーション・チーム・メンバーのメッセージ・サプライヤへのアクセス。値には、アクセスなし、受信のみまたは送信して受信があります。受け入れられる値のリストは、参照タイプORA_PON_COLLAB_TEAM_SUPP_MSGで定義されます。
SupplierMessagesCode: string

タイトル: Supplier Messages Code

最大長: 30

各コラボレーション・チーム・メンバーのメッセージ・サプライヤへのアクセスを識別する略称です。値は、ORA_NO_ACCESS、ORA_RECEIVE_ONLYまたはORA_SEND_AND_RECEIVEです。受け入れられる値のリストは、参照タイプORA_PON_COLLAB_TEAM_SUPP_MSGで定義されます。
TaskCompletionDate: string (date-time)

読取り専用: true

コラボレーション・チーム・メンバーが割当済タスクを終了する日付。
TaskName: string

タイトル: Task

最大長: 4000

アプリケーションがコラボレーション・チーム・メンバーに割り当てたタスクの名前。
TaskTargetDate: string (date)

タイトル: Target Date

アプリケーションで、コラボレーション・チーム・メンバーが割当済タスクを完了すると予想される日付。
TeamMember: string

タイトル: Team Member

最大長: 240

アプリケーションがネゴシエーションに追加したコラボレーション・チーム・メンバーの名前。
TeamMemberId: number

読取り専用: true

各チーム・メンバーを一意に識別する値。

{
    "type":"object",
    "properties":{
        "TaskCompletionDate":{
            "type":"string",
            "description":"Date when the collaboration team member finishes the assigned task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the team member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierMessagesCode":{
            "title":"Supplier Messages Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the access to message suppliers for each collaboration team member. Values include ORA_NO_ACCESS, ORA_RECEIVE_ONLY, or ORA_SEND_AND_RECEIVE. A list of accepted values is defined in the lookup type ORA_PON_COLLAB_TEAM_SUPP_MSG.",
            "nullable":true,
            "x-queryable":false
        },
        "Access":{
            "title":"Access",
            "maxLength":80,
            "type":"string",
            "description":"Access for each collaboration team member. Values include Full or View Only. A list of accepted values is defined in the lookup type PON_NEG_COLLAB_TEAM_ACCESS.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastNotifiedDate":{
            "title":"Last Notified Date",
            "type":"string",
            "description":"Date and time when the application most recently notified the collaboration team member about the collaboration team task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessCode":{
            "title":"Access Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the access for each collaboration team member. Values include FULL or VIEW_ONLY. A list of accepted values is defined in the lookup type PON_NEG_COLLAB_TEAM_ACCESS.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceVisibilityFlag":{
            "title":"Price Visibility",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the team member can view price details on the response document when evaluating each response. If false, then cannot view. The default value is true.",
            "nullable":true,
            "x-queryable":false
        },
        "TeamMember":{
            "title":"Team Member",
            "maxLength":240,
            "type":"string",
            "description":"Name of the collaboration team member that the application added to the negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TeamMemberId":{
            "type":"number",
            "description":"Value that uniquely identifies each team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration team that the application added to the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TaskName":{
            "title":"Task",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the task that the application assigned to the collaboration team member.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierMessages":{
            "title":"Supplier Messages",
            "maxLength":80,
            "type":"string",
            "description":"Access to message suppliers for each collaboration team member. Values include No access, Receive only, or Send and receive. A list of accepted values is defined in the lookup type ORA_PON_COLLAB_TEAM_SUPP_MSG.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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 team member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaskTargetDate":{
            "title":"Target Date",
            "type":"string",
            "description":"Date when the application expects the collaboration team member to finishes the assigned task.",
            "format":"date",
            "nullable":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/supplierNegotiations/supplierNegotiationsUniqID/child/collaborationTeamMembers/TeamMemberId"

リクエスト本文の例

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

{
	"PriceVisibilityFlag": false,
	"TaskName": "Review technical specification documents",
	"TaskTargetDate": "2020-11-12"
}

レスポンス本文の例

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

{
	"TeamMemberId": 300100195048535,
	"AccessCode": "FULL",
	"PriceVisibilityFlag": false,
       "SupplierMessagesCode": "ORA_SEND_AND_RECEIVE",
       "SupplierMessages": "Send and receive",
	"TaskTargetDate": "2020-11-12",
	"TaskName": "Review technical specification documents",
	"LastNotifiedDate": null,
	"Access": "Full",
	"TeamMember": "Smith,Cody",
	"PersonId": 100010026863791,
	"TaskCompletionDate": null,
	"CreatedBy": "CLARE.JONES",
	"CreationDate": "2020-05-28T16:28:52+00:00",
	"LastUpdateDate": "2020-05-28T16:31:20.008+00:00",
	"LastUpdatedBy": "CLARE.JONES",
	"links": [. . .]
}

「トップに戻る」