1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Draft Supplier Negotiation Responses
  4. Sections

Get all sections

get

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/sections

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Draft Supplier Negotiation Responses resource and used to uniquely identify an instance of Draft Supplier Negotiation Responses. The client should not generate the hash key value. Instead, the client should query on the Draft Supplier Negotiation Responses collection resource in order to navigate to a specific instance of Draft Supplier Negotiation Responses 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 section associated with the negotiation response line according to the primary key.
      Finder Variables
      • ResponseNumber; integer; Value that uniquely identifies the negotiation response in sections.
      • SectionId; integer; Uniquely identifies the section in response according to the section ID.
    • PrimaryKeyFinder Finds the sections associated with the negotiation response according to the bind variable that uniquely identifies the response sections.
      Finder Variables
      • SectionId; integer; Uniquely identifies the response 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:
    • CompletedSectionRequiredRequirementsCount; integer; Total number of mandatory requirements in a section for which the supplier has provided a valid response.
    • CompletedSectionRequirementsCount; integer; Total number of requirements completely answered.
    • CreatedBy; string; Identifies the user who created the row.
    • CreationDate; string; Timestamp of the creation of the row.
    • EvaluationStage; string; Name of the evaluation stage in a two stage RFQ. Values include Technical or Commercial. A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE.
    • EvaluationStageCode; string; Abbreviation that uniquely identifies the name of the evaluation stage in a two stage RFQ. A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE.
    • LastUpdateDate; string; Date and time when the user most recently updated the line.
    • LastUpdatedBy; string; User who most recently updated the line.
    • 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 isn't added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false.
    • ResponseNumber; integer; Value that uniquely identifies the response.
    • 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.
    • SectionRequiredRequirementsCount; integer; Total number of mandatory requirements in a section.
    • SectionRequirementsCount; integer; Value that uniquely identifies the total number of requirements in a section.
  • 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 : draftSupplierNegotiationResponses-sections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : draftSupplierNegotiationResponses-sections-item-response
Type: object
Show Source
Nested Schema : Requirements
Type: array
Title: Requirements
The Requirements resource contains details about the requirements of a supplier negotiation.
Show Source
Nested Schema : draftSupplierNegotiationResponses-sections-requirements-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Value that determines whether the supplier can add attachments with the requirements. Valid values are OPTIONAL, REQUIRED, and NON_ALLOWED. The default value is NOT_ALLOWED.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the supplier can add comments with the requirements. If false, then the supplier can't add comments. The default value is false.
  • Attachments
    Title: Attachments
    The Attachments resource manages response attachments in the supplier negotiation response.
  • Title: Comments
    Maximum Length: 1000
    Comments entered on a requirement response by the supplier.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Identifies the user who created the row.
  • Title: Creation Date
    Read Only: true
    Timestamp of the creation of the row.
  • Title: Hint
    Read Only: true
    Maximum Length: 1000
    Text that the application displays to the supplier to help respond to the requirements.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the requirement.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the requirement.
  • Title: Level
    Read Only: true
    Maximum Length: 80
    Supplier level for the requirement. Values include Supplier and Supplier Site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
  • Title: Level Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the supplier level for the requirement. Values include Supplier and Supplier Site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL.
  • Links
  • Read Only: true
    Value that uniquely identifies the immediate parent of the branching requirement.
  • Title: Parent Type
    Read Only: true
    Maximum Length: 10
    Type of requirement parent. If the section is the parent of any other requirement, then the ParentType is SECTION. If not, then the ParentType is SCORE.
  • Title: Question ID
    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
    Read Only: true
    Maximum Length: 80
    Name of the requirement.
  • Title: Requirement ID
    Read Only: true
    Value that uniquely identifies the requirement.
  • Title: Requirement Level
    Read Only: true
    The level at which the requirement is located in the requirement hierarchy. For example, 1, 2, 3, and so on. Level 1 requirement has a section as a parent. Level 2 onward represents the branching requirements with an acceptable response score as a parent.
  • Title: Requirement Number
    Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the sequence for the requirement.
  • Title: Requirement Text
    Read Only: true
    Text that describes the requirement.
  • Title: Requirement Type
    Read Only: true
    Maximum Length: 80
    Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, and Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
  • Title: Requirement Type Code
    Read Only: true
    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, and Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE.
  • Title: Response Number
    Read Only: true
    Value that uniquely identifies the response.
  • Title: Response Type
    Read Only: true
    Maximum Length: 80
    Specifies whether a response is required for the requirement. Values include Required, Optional, Display Only, and Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
  • Title: Response Type Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that specifies whether a response for the requirement is required. Values include Required, Optional, Display Only, and Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE.
  • Response Values
    Title: Response Values
    The Response Values resource manages details about the requirement responses of a supplier negotiation.
  • Read Only: true
    Value that uniquely identifies the root level parent of the branching requirement.
  • Title: Score ID
    Read Only: true
    Value that uniquely identifies the score.
  • Title: Section
    Read Only: true
    Maximum Length: 240
    Name of the requirement section.
  • Title: Section ID
    Read Only: true
    Value that uniquely identifies the section.
  • Title: Target Date Time Value
    Read Only: true
    Value that the user entered. This value is applicable for date and time.
  • Title: Target Date Value
    Read Only: true
    Value that the user entered in the attribute. This value is applicable for dates.
  • Title: Target Number Value
    Read Only: true
    Value that the user entered in the attribute. This value is applicable for numbers.
  • Title: Target Text Value
    Read Only: true
    Maximum Length: 4000
    Target text or URL (Uniform Resource Locator) values of the requirement.
  • Title: Value Type
    Read Only: true
    Maximum Length: 80
    Type of value for the requirement. Values include Single Line Text, Multiple Line Text, Number, Date, Date and Time, and URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE.
  • Title: Value Type Code
    Read Only: true
    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.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages response attachments in the supplier negotiation response.
Show Source
Nested Schema : Response Values
Type: array
Title: Response Values
The Response Values resource manages details about the requirement responses of a supplier negotiation.
Show Source
Nested Schema : draftSupplierNegotiationResponses-sections-requirements-attachments-item-response
Type: object
Show Source
Nested Schema : draftSupplierNegotiationResponses-sections-requirements-responseValues-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 30
    Value that determines whether the supplier can add attachments with the requirements. Valid values are OPTIONAL, REQUIRED, and NON_ALLOWED. The default value is NOT_ALLOWED.
  • Attachments
    Title: Attachments
    The Attachments resource manages response attachments in the supplier negotiation response.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Identifies the user who created the row.
  • Title: Creation Date
    Read Only: true
    Timestamp of the creation of the row.
  • Title: Is Selected
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the response value is selected in multiple choice single select or multiple choice multiple select requirements. If false, then the response isn't selected.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the response value.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the response value.
  • Links
  • Title: Question ID
    Read Only: true
    Value that uniquely identifies the requirement for a question.
  • Title: Requirement
    Read Only: true
    Maximum Length: 80
    Name of the requirement.
  • Title: Requirement ID
    Read Only: true
    Value that uniquely identifies the requirement.
  • Title: Requirement Level
    Read Only: true
    The level at which the requirement is located in the requirement hierarchy. For example, 1, 2, 3, and so on. Level 1 requirement has a section as a parent. Level 2 onward represents the branching requirements with an acceptable response score as a parent.
  • Title: Requirement Number
    Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the sequence for the requirement.
  • Title: Requirement Value ID
    Read Only: true
    Value that uniquely identifies the response value.
  • Title: Response Number
    Read Only: true
    Value that uniquely identifies the requirement response value when there is no scoring applicable. This is applicable for text entry box responses.
  • Title: Response Value Date
    Response value for a requirement where response type is date.
  • Title: Response Value Date Time
    Response value for a requirement where response type is date and time.
  • Title: Response Value Number
    Response value for a requirement where response type is number.
  • Title: Response Value Text
    Maximum Length: 4000
    Response value for a requirement where response type is text.
  • Title: Score Display Number
    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.
  • Title: Score ID
    Read Only: true
    Value that uniquely identifies the response. This value is applicable for Multiple Choice With Single Selection or Multiple Choice With Multiple Selections response values.
  • Title: Section
    Read Only: true
    Maximum Length: 240
    Name of the requirement section.
  • Title: Section ID
    Read Only: true
    Value that uniquely identifies the section.
  • Title: Target Date Time Value
    Read Only: true
    Target value set by the category manager. This value is applicable for date and time.
  • Title: Target Date Value
    Read Only: true
    Target value set by the category manager. This value is applicable for dates.
  • Title: Target Number Value
    Read Only: true
    Target value set by the category manager. This value is applicable for numbers.
  • Title: Target Text Value
    Read Only: true
    Maximum Length: 4000
    Target value set by the category manager. This value is applicable for text or URL (Uniform Resource Locator).
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages response attachments in the supplier negotiation response.
Show Source
Nested Schema : draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all sections in a negotiation response using a response ID and 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/draftSupplierNegotiationResponses/draftSupplierNegotiationResponsesUniqID/child/sections"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "ResponseNumber": 188787,
            "SectionId": 36280,
            "SectionDisplayNumber": "1.",
            "PricingSectionFlag": false,
            "Section": "HVAC System Details",
            "EvaluationStageCode": "TECHNICAL",
            "EvaluationStage": "Technical",
            "CreatedBy": "CVSUPPB01",
            "CreationDate": "2022-04-08T19:39:29+00:00",
            "LastUpdatedBy": "CVSUPPB01",
            "LastUpdateDate": "2022-04-08T19:39:31.717+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36280",
                    "name": "sections",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "..."
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36280",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787",
                    "name": "draftSupplierNegotiationResponses",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36280/child/requirements",
                    "name": "requirements",
                    "kind": "collection"
                }
            ]
        },
        {
            "ResponseNumber": 188787,
            "SectionId": 36281,
            "SectionDisplayNumber": "2.",
            "PricingSectionFlag": false,
            "Section": "Qualification",
            "EvaluationStageCode": "COMMERCIAL",
            "EvaluationStage": "Commercial",
            "CreatedBy": "CVSUPPB01",
            "CreationDate": "2022-04-08T19:39:29+00:00",
            "LastUpdatedBy": "CVSUPPB01",
            "LastUpdateDate": "2022-04-08T19:43:07.532+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36281",
                    "name": "sections",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "..."
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36281",
                    "name": "sections",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787",
                    "name": "draftSupplierNegotiationResponses",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections/36281/child/requirements",
                    "name": "requirements",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188787/child/sections",
            "name": "sections",
            "kind": "collection"
        }
    ]
}
Back to Top