1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiations
  4. Sections

Get all sections

get

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

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 unique section for the supplier negotiation according to the primary key. The primary key is SectionId.
      Finder Variables:
      • SectionId; integer; Value that uniquely identifies the section.
  • 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:
    • PreviousSectionId; integer; Indicates previous negotiation section's section ID during copy negotiation or create new round or create amendment.
    • PricingSectionFlag; boolean; Contains one of the following values: true or false. If true, then the pricing section is added. If false, then the pricing section is not added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
    • Section; string; Name of the requirement section.
    • SectionDisplayNumber; string; Display number of the section. If the negotiation contains more than one section, then the application uses a display sequence to identify each section, such as 10, 20, 30, and so on.
    • SectionId; integer; Value that uniquely identifies the section.
    • SectionWeight; number; Importance of the section when compared to other sections. The application uses this weight when it calculates the over all score of requirement score.
  • 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-sections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiations-sections-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the section.
  • Read Only: true
    Date and time when the user created the section.
  • Title: Evaluation Stage
    Maximum Length: 80
    Name of the evaluation stage in a two stage RFQ (request for quotation). Values include Technical or Commercial. A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE.
  • Title: Evaluation Stage Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the name of the evaluation stage in a two stage RFQ (request for quotation). A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE.
  • Read Only: true
    Date and time when the user most recently updated the section.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the section.
  • Links
  • Read Only: true
    Indicates previous negotiation section's section ID during copy negotiation or create new round or create amendment.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the pricing section is added. If false, then the pricing section is not added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
  • Requirements
    Title: Requirements
    The Requirements resource manages details about the requirements of a supplier negotiation.
  • Title: Scoring Team
    Maximum Length: 80
    Name of the scoring team.
  • Title: Scoring Team ID
    Value that uniquely identifies a scoring team.
  • Title: Section
    Maximum Length: 240
    Name of the requirement section.
  • Read Only: true
    Maximum Length: 80
    Display number of the section. If the negotiation contains more than one section, then the application uses a display sequence to identify each section, such as 10, 20, 30, and so on.
  • Read Only: true
    Value that uniquely identifies the section.
  • Read Only: true
    Value that indicates the number of required requirements in the section.
  • Read Only: true
    Value that indicates the number of requirements in a section.
  • Importance of the section when compared to other sections. The application uses this weight when it calculates the over all score of requirement score.
Nested Schema : Requirements
Type: array
Title: Requirements
The Requirements resource manages details about the requirements of a supplier negotiation.
Show Source
Nested Schema : supplierNegotiations-sections-requirements-item-response
Type: object
Show Source
  • Acceptable Response Values
    Title: Acceptable Response Values
    The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.
  • Title: Allow comments from suppliers
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then allow the supplier to provide comments to each requirement. If false, then do not allow. The default value is false.
  • Attachments
    Title: Attachments
    The Attachments resource manages details about attachments for a requirement.
  • Title: Attachments from Suppliers
    Maximum Length: 80
    Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
  • Title: Attachments from Suppliers Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
  • Read Only: true
    Maximum Length: 30
    Value that identifies the category code of the buyer organization. The values are PRODUCTS_AND_SERVICES and BUSINESS_CLASSIFICATION.
  • Read Only: true
    Maximum Length: 64
    User who created the requirement.
  • Read Only: true
    Date and time when the user created the requirement.
  • Title: Display target
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then display the target value to the supplier. If false, then do not display. The default value is false.
  • Title: Hint
    Maximum Length: 1000
    Text that the application displays to the supplier to help respond to the requirements.
  • Read Only: true
    Maximum Length: 1
    Indicates if scoring is defined on the predefined question.
  • Title: Knockout Score
    Lowest requirement score that the response can receive and remain part of the shortlist.
  • Read Only: true
    Date and time when the user most recently updated the requirement.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the requirement.
  • Title: Level
    Maximum Length: 80
    Supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
  • Title: Level Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
  • Links
  • Title: Maximum Score
    Highest possible score for the requirement response.
  • Read Only: true
    Maximum Length: 10
    Type of requirement. If the requirement is the parent of any other requirement, then ParentType contains SECTION. If not, then ParentType contains SCORE.
  • Read Only: true
    Indicates previous negotiation requirement's requirement id during copy negotiaiton or create new round or create amendment.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the response amount requirement is added to the pricing section. If false, then no requirement is added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
  • Read Only: true
    Value that uniquely identifies the requirement for a question.
  • Title: Revision
    Read Only: true
    Revision number of a predefined question that the application adds to the supplier qualification.
  • Title: Requirement
    Maximum Length: 80
    Name of the requirement.
  • Read Only: true
    Value that uniquely identifies the requirement.
  • Read Only: true
    Level of the requirement. For example, 1, 2, 3, and so on.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the sequence for the requirement.
  • Title: Requirement Text
    Text that describes the requirement.
  • Title: Requirement Type
    Maximum Length: 80
    Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
  • Title: Requirement Type Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
  • Title: Response Type
    Maximum Length: 80
    Specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
  • Title: Response Type Code
    Maximum Length: 30
    Abbreviation that specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
  • Read Only: true
    Value that uniquely identifies the score.
  • Title: Scoring
    Maximum Length: 80
    Method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.
  • Title: Scoring Method Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE.
  • Title: Section
    Read Only: true
    Name of the requirement section.
  • Read Only: true
    Value that uniquely identifies the section.
  • Title: Target Date Time Value
    Value that the user entered. This value is applicable for date and time.
  • Title: Target Date Value
    Value that the user entered in the attribute. This value is applicable for dates.
  • Title: Target Number Value
    Value that the user entered in the attribute. This value is applicable for numbers.
  • Title: Target Text Value
    Maximum Length: 4000
    Target text or URL (Uniform Resource Locator) values of the requirement.
  • Title: Value Type
    Maximum Length: 80
    Type of value for the requirement. Values include Single Line Text, Multiple Line Text, Number, Date, Date and Time, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.
  • Title: Value Type Code
    Maximum Length: 30
    Abbreviation that identifies the type of value for the requirement. A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.
  • Title: Weight
    Importance of the requirement when compared to other requirements. The application uses this weight when it calculates the requirement score.
Nested Schema : Acceptable Response Values
Type: array
Title: Acceptable Response Values
The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages details about attachments for a requirement.
Show Source
Nested Schema : supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response
Type: object
Show Source
  • Title: Attachments from Suppliers
    Maximum Length: 80
    Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
  • Title: Attachments from Suppliers Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT.
  • Read Only: true
    Maximum Length: 64
    User who created the acceptable response score value.
  • Read Only: true
    Date and time when the user created the acceptable response score value.
  • Title: Date from Range
    Start date in the range of values. Applies for date attributes.
  • Title: Date Time from Range
    Start date and time in the range of values. Applies for date and time attributes.
  • Title: Date Time to Range
    End date and time in the range of values. Applies for date and time attributes.
  • Title: Date to Range
    End Date in the range of values. Applies for date attributes.
  • Read Only: true
    Date and time when the user most recently updated the acceptable response score value.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the acceptable response score value.
  • Links
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then allow the application to assign a score to each supplier who does not respond to an optional requirement. If false, then do not allow. The default value is false.
  • Title: Number from Range
    Lowest number in a range of values. Applies for number attributes.
  • Title: Number to Range
    Highest number in a range of values. Applies for number attributes.
  • Read Only: true
    Value that uniquely identifies the requirement.
  • Title: Score
    Score that the application assigns to each attribute response.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the score display. The application sets this value for each requirement that uses Multiple Choice With Single Selection or Multiple Choice With Multiple Selections. It also sets this value for each response that replies to a number, date, or date time requirement.
  • Read Only: true
    Value that uniquely identifies the score.
  • Title: Section
    Read Only: true
    Name of the requirement section.
  • Read Only: true
    Value that uniquely identifies the section.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then set the value that the application is willing to accept as the target response value for the requirement. If false, then do not set. The default value is false.
  • Title: Text Response Value
    Maximum Length: 1000
    Value that the user entered. This value is applicable for text values.
Nested Schema : supplierNegotiations-sections-requirements-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all sections.

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/sections"

Example Response Body

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

{
    "items": [
        {
            "SectionId": 11275,
            "SectionDisplayNumber": "1.",
            "Section": "Technical capabilities",
            "EvaluationStage": null,
            "EvaluationStageCode": null,
            "ScoringTeam": "Technical Team",
            "ScoringTeamId": 300100152357501,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:46:24+00:00",
            "LastUpdateDate": "2018-06-28T11:26:16.127+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275",
                    "name": "sections",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495",
                    "name": "supplierNegotiations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements",
                    "name": "requirements",
                    "kind": "collection"
                }
            ]
        },
        {
            "SectionId": 300100152360588,
            "SectionDisplayNumber": "2.",
            "Section": "Financial information",
            "EvaluationStage": null,
            "EvaluationStageCode": null,
            "ScoringTeam": null,
            "ScoringTeamId": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T11:27:54.604+00:00",
            "LastUpdateDate": "2018-06-28T11:28:06.210+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/300100152360588",
                    "name": "sections",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/300100152360588",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495",
                    "name": "supplierNegotiations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/300100152360588/child/requirements",
                    "name": "requirements",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 10,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections",
            "name": "sections",
            "kind": "collection"
        }
    ]
}
Back to Top