機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

すべてのチーム・メンバーの取得

get

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

リクエスト

パス・パラメータ

• 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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • PrimaryKey: 主キーに従って、サプライヤ・ネゴシエーションの単一コラボレーション・チーム・メンバーを検索します。 主キーは、AuctionHeaderIdとTeamMemberIdの組合せです。
    ファインダ変数:
    • TeamMemberId; number; チーム・メンバーを一意に識別する値。
  • PrimaryKeyFinder : チーム・メンバー識別子に従ってコラボレーション・チーム・メンバーを検索します。
    ファインダ変数:
    • TeamMemberId; number; チーム・メンバーを一意に識別する値。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • PersonId; integer; アプリケーションがネゴシエーションに追加したコラボレーション・チームを一意に識別する値。
  • ScoringTeamNames; string; コラボレーション・チーム・メンバーが割り当てられるスコアリング・チームの名前。
  • TeamMemberId; number; 各チーム・メンバーを一意に識別する値。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• 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-collaborationTeamMembers

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲内で返されるリソース・インスタンス数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内の品目。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合、推定行数は含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-collaborationTeamMembers-item-response"
            }
        }
    }
}

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

• Array of: object supplierNegotiations-collaborationTeamMembers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-collaborationTeamMembers-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 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です。
• ScoringTeamNames: string
  読取り専用: 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
        },
        "ScoringTeamNames":{
            "type":"string",
            "description":"Name of the scoring team that a collaboration team member is assigned to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

トップに戻る

例

この例では、すべてのチーム・メンバーを取得する方法について説明します。

cURLコマンドの例

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

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

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
    "items": [
        {
            "TeamMemberId": 300100152358177,
            "AccessCode": "FULL",
            "PriceVisibilityFlag": true,
            "SupplierMessagesCode": "ORA_SEND_AND_RECEIVE",
            "SupplierMessages": "Send and receive",
            "TaskTargetDate": null,
            "TaskName": null,
            "LastNotifiedDate": null,
            "Access": "Full",
            "TeamMember": "Smith,Eric",
            "PersonId": 100010026863855,
            "TaskCompletionDate": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:46:24+00:00",
            "LastUpdateDate": "2018-06-28T11:24:53.432+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [<Do not change anything here>]
        },
        {
            "TeamMemberId": 300100152357497,
            "AccessCode": "FULL",
            "PriceVisibilityFlag": true,
            "SupplierMessagesCode": "ORA_SEND_AND_RECEIVE",
            "SupplierMessages": "Send and receive",
            "TaskTargetDate": "2018-08-15",
            "TaskName": "Responsible for checking the technical aspects",
            "LastNotifiedDate": null,
            "Access": "Full",
            "TeamMember": "Jones,Cody",
            "PersonId": 100010026863791,
            "TaskCompletionDate": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:46:23.462+00:00",
            "LastUpdateDate": "2018-06-28T11:25:56.003+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [<Do not change anything here>]
        },
        {
            "TeamMemberId": 300100152357496,
            "AccessCode": "FULL",
            "PriceVisibilityFlag": true,
            "SupplierMessagesCode": "ORA_SEND_AND_RECEIVE",
            "SupplierMessages": "Send and receive",
            "TaskTargetDate": "2018-08-17",
            "TaskName": "Responsible for the entire contract",
            "LastNotifiedDate": null,
            "Access": "Full",
            "TeamMember": "Smith,Clare",
            "PersonId": 100010026863783,
            "TaskCompletionDate": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:46:23.457+00:00",
            "LastUpdateDate": "2018-06-28T11:25:56.015+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [<Do not change anything here>]
                
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 10,
    "offset": 0,
    "links": [<Do not change anything here>]
        
}

「トップに戻る」