1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiations
  4. Negotiation Versions
  5. Section Changes
  6. Requirement Changes

Get all requirements change

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/negotiationVersions/{AuctionHeaderId}/child/sectionsChanges/{sectionsChangesUniqID}/child/requirementsChanges

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key--- AuctionHeaderId and SectionId ---for the Section Changes resource and used to uniquely identify an instance of Section Changes. The client should not generate the hash key value. Instead, the client should query on the Section Changes collection resource with a filter on the primary key values in order to navigate to a specific instance of Section Changes.

    For example: sectionsChanges?q=AuctionHeaderId=<value1>;SectionId=<value2>
  • 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 all the changes in the requirements of a negotiation.
      Finder Variables:
      • AuctionHeaderId; integer; Value that uniquely identifies the auction header.
      • RequirementId; integer; Value that uniquely identifies the requirement.
      • 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:
    • AttachmentsCount; integer; Value that uniquely identifies the number of attachments in a requirement.
    • AuctionHeaderId; integer; Unique ID assigned to the latest negotiation version.
    • ChangeTracking; string; Value that uniquely captures the changes made to requirements between the latest and previous versions of an amendment, highlighting additions, deletions, or updates.
    • DisplaySequenceNumber; number; Display the sequence of the requirements in a section in a negotiation.
    • LinkSectionId; number; Value that uniquely identifies the requirement associated to the section.
    • NodeType; string; Value that uniquely identifies the requirements entity.
    • RequirementDisplayNumber; string; Displays the requirement number within a section in a sequential order such as 1, 2, 3, and so on. If a requirement has branching, its child requirements are numbered hierarchically (e.g., 2.1, 2.2) based on the branching level.
    • RequirementId; integer; Value that uniquely identifies the requirement.
    • RequirementName; string; Requirement name entered by the buyer.
    • RequirementType; string; 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.
    • SectionId; integer; Value that uniquely identifies the 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 : supplierNegotiations-negotiationVersions-sectionsChanges-requirementsChanges
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiations-negotiationVersions-sectionsChanges-requirementsChanges-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the number of attachments in a requirement.
  • Read Only: true
    Unique ID assigned to the latest negotiation version.
  • Read Only: true
    Maximum Length: 8
    Value that uniquely captures the changes made to requirements between the latest and previous versions of an amendment, highlighting additions, deletions, or updates.
  • Read Only: true
    Display the sequence of the requirements in a section in a negotiation.
  • Links
  • Read Only: true
    Value that uniquely identifies the requirement associated to the section.
  • Read Only: true
    Maximum Length: 11
    Value that uniquely identifies the requirements entity.
  • Read Only: true
    Maximum Length: 80
    Displays the requirement number within a section in a sequential order such as 1, 2, 3, and so on. If a requirement has branching, its child requirements are numbered hierarchically (e.g., 2.1, 2.2) based on the branching level.
  • Read Only: true
    Value that uniquely identifies the requirement.
  • Read Only: true
    Maximum Length: 80
    Requirement name entered by the buyer.
  • Read Only: true
    Text that describes the requirement.
  • Read Only: true
    Maximum Length: 30
    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.
  • Read Only: true
    Value that uniquely identifies the section.
Back to Top