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

Create one requirement

post

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

Request

Path Parameters
  • Value that uniquely identifies the section.
  • 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.
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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.
  • 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.
  • Title: Knockout Score
    Lowest requirement score that the response can receive and remain part of the shortlist.
  • 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.
  • Title: Maximum Score
    Highest possible score for the requirement response.
  • Title: Requirement
    Maximum Length: 80
    Name of 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.
  • 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: 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 : schema
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.
  • 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.
  • 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.
  • Title: Score
    Score that the application assigns to each attribute response.
  • 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-post-request
Type: object
Show Source
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-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: 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.
  • 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
    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
Links
acceptableResponseScoreValues
Parameters:
  • RequirementId: $request.path.RequirementId
  • SectionId: $request.path.SectionId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.
attachments
Parameters:
  • RequirementId: $request.path.RequirementId
  • SectionId: $request.path.SectionId
  • supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID
The Attachments resource manages details about attachments for a requirement.
Back to Top

Examples

This example describes how to create a requirement.

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/SectionId/child/requirements"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements"

Example Request Body

The following example includes the contents of the request body in JSON format.

{
            "Requirement": "Company Experience",
            "RequirementText":"How many years' experience does your company have in providing products and services equivalent or related to those called for in this RFP?" ,
            "Hint": "Include any supporting documents",
            "Level": "Supplier",
            "ResponseType": "Required",
            "RequirementTypeCode":"MCSS",
            "RequirementType": "Multiple choice with single selection",
            "ValueType": "Single line text",
            "TargetTextValue":null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "DisplayTargetFlag": false,
            "AttachmentsFromSuppliers": null,
            "AllowCommentsFromSuppliersFlag": false,
            "ScoringMethod": "Automatic",
            "MaximumScore": null,
            "Weight": 1,
            "KnockoutScore": null         
                       
 }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "RequirementId": 300100543793301,
    "ScoreId": -1,
    "ParentType": "SECTION",
    "RequirementLevel": 1,
    "RequirementNumber": "1.",
    "QuestionId": null,
    "QuestionRevisionNumber": null,
    "PricingRequirementFlag": false,
    "Requirement": "Company Experience",
    "Hint": "Include any supporting documents",
    "LevelCode": "SUPPLIER",
    "Level": "Supplier",
    "ResponseTypeCode": "REQUIRED",
    "ResponseType": "Required",
    "RequirementTypeCode": "MCSS",
    "RequirementType": "Multiple choice with single selection",
    "ValueTypeCode": "SINGLE_LINE_TEXT",
    "ValueType": "Single line text",
    "TargetTextValue": null,
    "TargetNumberValue": null,
    "TargetDateValue": null,
    "TargetDateTimeValue": null,
    "DisplayTargetFlag": false,
    "AttachmentsFromSuppliersCode": null,
    "AttachmentsFromSuppliers": null,
    "AllowCommentsFromSuppliersFlag": false,
    "ScoringMethodCode": "AUTOMATIC",
    "ScoringMethod": "Automatic",
    "Weight": 1,
    "MaximumScore": null,
    "KnockoutScore": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2021-06-09T00:11:43+00:00",
    "LastUpdateDate": "2021-06-09T00:11:43.238+00:00",
    "LastUpdatedBy": "CVBUYER01",
    ...
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301",
                "name": "requirements",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301",
                "name": "requirements",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265",
                "name": "sections",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301/child/acceptableResponseScoreValues",
                "name": "acceptableResponseScoreValues",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301/child/attachments",
                "name": "attachments",
                "kind": "collection"
            },
            {
                "rel": "enclosure",
                "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301/enclosure/RequirementText",
                "name": "RequirementText",
                "kind": "other"
            }
        ]
    }
}
Back to Top