1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiations
  4. Collaboration Team Members

Get all team members

get

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

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the single collaboration team member for the supplier negotiation according to the primary key. The primary key is combination of AuctionHeaderId and TeamMemberId.
      Finder Variables:
      • TeamMemberId; number; Value that uniquely identifies the team member.
    • PrimaryKeyFinder: Finds the collaboration team member according to the team member identifier.
      Finder Variables:
      • TeamMemberId; number; Value that uniquely identifies the team member.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • PersonId; integer; Value that uniquely identifies the collaboration team that the application added to the negotiation.
    • ScoringTeamNames; string; Name of the scoring team that a collaboration team member is assigned to.
    • TeamMemberId; number; Value that uniquely identifies each team member.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : supplierNegotiations-collaborationTeamMembers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiations-collaborationTeamMembers-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 80
    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.
  • Title: Access Code
    Maximum Length: 30
    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.
  • Read Only: true
    Maximum Length: 64
    User who created the team member.
  • Read Only: true
    Date and time when the user created the team member.
  • Title: Last Notified Date
    Read Only: true
    Date and time when the application most recently notified the collaboration team member about the collaboration team task.
  • Read Only: true
    Date and time when the user most recently updated the team member.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the team member.
  • Links
  • Value that uniquely identifies the collaboration team that the application added to the negotiation.
  • Title: Price Visibility
    Maximum Length: 1
    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.
  • Read Only: true
    Name of the scoring team that a collaboration team member is assigned to.
  • Title: Supplier Messages
    Maximum Length: 80
    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.
  • Title: Supplier Messages Code
    Maximum Length: 30
    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.
  • Read Only: true
    Date when the collaboration team member finishes the assigned task.
  • Title: Task
    Maximum Length: 4000
    Name of the task that the application assigned to the collaboration team member.
  • Title: Target Date
    Date when the application expects the collaboration team member to finishes the assigned task.
  • Title: Team Member
    Maximum Length: 240
    Name of the collaboration team member that the application added to the negotiation.
  • Read Only: true
    Value that uniquely identifies each team member.
Back to Top

Examples

This example describes how to get all team members.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

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

Example Response Body

The following shows an example of the response body in JSON format.

{
    "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>]
        
}
Back to Top