Jump to

• Request
• Response
• Examples

Create one value

post

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

Request

Path Parameters

• RequirementId(required): integer(int64)
  Value that uniquely identifies the requirement.
• SectionId(required): integer(int64)
  Value that uniquely identifies the section.
• supplierNegotiationsUniqID(required): string
  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

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.
• Upsert-Mode: string
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttachmentsFromSuppliers: string
  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.
• AttachmentsFromSuppliersCode: string
  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.
• DateFromRange: string (date)
  Title: Date from Range

  Start date in the range of values. Applies for date attributes.
• DateTimeFromRange: string (date-time)
  Title: Date Time from Range

  Start date and time in the range of values. Applies for date and time attributes.
• DateTimeToRange: string (date-time)
  Title: Date Time to Range

  End date and time in the range of values. Applies for date and time attributes.
• DateToRange: string (date)
  Title: Date to Range

  End Date in the range of values. Applies for date attributes.
• NumberFromRange: number
  Title: Number from Range

  Lowest number in a range of values. Applies for number attributes.
• NumberToRange: number
  Title: Number to Range

  Highest number in a range of values. Applies for number attributes.
• Score: number
  Title: Score

  Score that the application assigns to each attribute response.
• TargetFlag: boolean
  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.
• TextValue: string
  Title: Text Response Value

  Maximum Length: 1000

  Value that the user entered. This value is applicable for text values.

{
    "type":"object",
    "properties":{
        "AttachmentsFromSuppliers":{
            "title":"Attachments from Suppliers",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttachmentsFromSuppliersCode":{
            "title":"Attachments from Suppliers Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "DateFromRange":{
            "title":"Date from Range",
            "type":"string",
            "description":"Start date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeFromRange":{
            "title":"Date Time from Range",
            "type":"string",
            "description":"Start date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeToRange":{
            "title":"Date Time to Range",
            "type":"string",
            "description":"End date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DateToRange":{
            "title":"Date to Range",
            "type":"string",
            "description":"End Date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "NumberFromRange":{
            "title":"Number from Range",
            "type":"number",
            "description":"Lowest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "NumberToRange":{
            "title":"Number to Range",
            "type":"number",
            "description":"Highest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score that the application assigns to each attribute response.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "TextValue":{
            "title":"Text Response Value",
            "maxLength":1000,
            "type":"string",
            "description":"Value that the user entered. This value is applicable for text values.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-acceptableResponseScoreValues-item-response

Type: object

Show Source

• AttachmentsFromSuppliers: string
  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.
• AttachmentsFromSuppliersCode: string
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the acceptable response score value.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the acceptable response score value.
• DateFromRange: string (date)
  Title: Date from Range

  Start date in the range of values. Applies for date attributes.
• DateTimeFromRange: string (date-time)
  Title: Date Time from Range

  Start date and time in the range of values. Applies for date and time attributes.
• DateTimeToRange: string (date-time)
  Title: Date Time to Range

  End date and time in the range of values. Applies for date and time attributes.
• DateToRange: string (date)
  Title: Date to Range

  End Date in the range of values. Applies for date attributes.
• ExcludeQuestionScoreFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, it excludes the question from scoring. If false, it includes the question in scoring.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the acceptable response score value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the acceptable response score value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoResponseFlag: boolean
  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.
• NumberFromRange: number
  Title: Number from Range

  Lowest number in a range of values. Applies for number attributes.
• NumberToRange: number
  Title: Number to Range

  Highest number in a range of values. Applies for number attributes.
• RequirementId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requirement.
• Score: number
  Title: Score

  Score that the application assigns to each attribute response.
• ScoreDisplayNumber: string
  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.
• ScoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the score.
• Section: string
  Title: Section

  Read Only: true

  Name of the requirement section.
• SectionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the section.
• TargetFlag: boolean
  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.
• TextValue: string
  Title: Text Response Value

  Maximum Length: 1000

  Value that the user entered. This value is applicable for text values.

{
    "type":"object",
    "properties":{
        "AttachmentsFromSuppliers":{
            "title":"Attachments from Suppliers",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttachmentsFromSuppliersCode":{
            "title":"Attachments from Suppliers Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the acceptable response score value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the acceptable response score value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DateFromRange":{
            "title":"Date from Range",
            "type":"string",
            "description":"Start date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeFromRange":{
            "title":"Date Time from Range",
            "type":"string",
            "description":"Start date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DateTimeToRange":{
            "title":"Date Time to Range",
            "type":"string",
            "description":"End date and time in the range of values. Applies for date and time attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DateToRange":{
            "title":"Date to Range",
            "type":"string",
            "description":"End Date in the range of values. Applies for date attributes.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExcludeQuestionScoreFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, it excludes the question from scoring. If false, it includes the question in scoring.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the acceptable response score value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the acceptable response score value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NoResponseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberFromRange":{
            "title":"Number from Range",
            "type":"number",
            "description":"Lowest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "NumberToRange":{
            "title":"Number to Range",
            "type":"number",
            "description":"Highest number in a range of values. Applies for number attributes.",
            "nullable":true,
            "x-queryable":false
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score that the application assigns to each attribute response.",
            "nullable":true,
            "x-queryable":false
        },
        "ScoreDisplayNumber":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the score.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Section":{
            "title":"Section",
            "type":"string",
            "description":"Name of the requirement section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TargetFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "TextValue":{
            "title":"Text Response Value",
            "maxLength":1000,
            "type":"string",
            "description":"Value that the user entered. This value is applicable for text values.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to create a value.

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/RequirementId/child/acceptableResponseScoreValues"

For example:

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

Example Request Body

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

{
    "TextValue": "0 to 5 years",
    "AttachmentsFromSuppliers": "Optional"
}

Example Response Body

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

{
    "RequirementId": 300100543793301,
    "ScoreId": 300100543793303,
    "TargetFlag": false,
    "NoResponseFlag": false,
    "ScoreDisplayNumber": "a.",
    "TextValue": "0 to 5 years",
    "NumberFromRange": null,
    "NumberToRange": null,
    "DateFromRange": null,
    "DateToRange": null,
    "DateTimeFromRange": null,
    "DateTimeToRange": null,
    "AttachmentsFromSuppliersCode": "OPTIONAL",
    "AttachmentsFromSuppliers": "Optional",
    "Score": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2021-06-09T00:53:54+00:00",
    "LastUpdateDate": "2021-06-09T00:53:54.075+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301/child/acceptableResponseScoreValues/300100543793303",
            "name": "acceptableResponseScoreValues",
            "kind": "item",
            ...
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301/child/acceptableResponseScoreValues/300100543793303",
            "name": "acceptableResponseScoreValues",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100543794976/child/sections/300100543793265/child/requirements/300100543793301",
            "name": "requirements",
            "kind": "item"
        }
    ]
}

Back to Top