Update a requirement response value
/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/sections/{SectionId}/child/requirements/{RequirementId}/child/responseValues/{RequirementValueId}
Request
-
RequirementId(required): integer(int64)
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=
-
RequirementValueId(required): integer(int64)
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=
-
SectionId(required): integer(int64)
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=
-
draftSupplierNegotiationResponsesUniqID(required): string
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.
-
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.
- application/json
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages response attachments in the supplier negotiation response. -
IsSelectedFlag: boolean
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. -
ResponseValueDate: string
(date)
Title:
Response Value Date
Response value for a requirement where response type is date. -
ResponseValueDateTime: string
(date-time)
Title:
Response Value Date Time
Response value for a requirement where response type is date and time. -
ResponseValueNumber: number
Title:
Response Value Number
Response value for a requirement where response type is number. -
ResponseValueText: string
Title:
Response Value Text
Maximum Length:4000
Response value for a requirement where response type is text.
array
Attachments
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. Valid values include From Supplier, for two-stage sealed RFQs, From Supplier: Technical, when technical evaluation is in progress, and From Supplier: Commercial, when commercial evaluation is in progress. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment.
Response
- application/json
Default Response
-
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.
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages response attachments in the supplier negotiation response. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Identifies the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Timestamp of the creation of the row. -
IsSelectedFlag: boolean
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. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the response value. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the response value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionId: integer
(int64)
Title:
Question ID
Read Only:true
Value that uniquely identifies the requirement for a question. -
Requirement: string
Title:
Requirement
Read Only:true
Maximum Length:80
Name of the requirement. -
RequirementId: integer
(int64)
Title:
Requirement ID
Read Only:true
Value that uniquely identifies the requirement. -
RequirementLevel: number
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. -
RequirementNumber: string
Title:
Requirement Number
Read Only:true
Maximum Length:80
Value that uniquely identifies the sequence for the requirement. -
RequirementValueId: integer
(int64)
Title:
Requirement Value ID
Read Only:true
Value that uniquely identifies the response value. -
ResponseNumber: integer
(int64)
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. -
ResponseValueDate: string
(date)
Title:
Response Value Date
Response value for a requirement where response type is date. -
ResponseValueDateTime: string
(date-time)
Title:
Response Value Date Time
Response value for a requirement where response type is date and time. -
ResponseValueNumber: number
Title:
Response Value Number
Response value for a requirement where response type is number. -
ResponseValueText: string
Title:
Response Value Text
Maximum Length:4000
Response value for a requirement where response type is text. -
ScoreDisplayNumber: string
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. -
ScoreId: integer
(int64)
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. -
Section: string
Title:
Section
Read Only:true
Maximum Length:240
Name of the requirement section. -
SectionId: integer
(int64)
Title:
Section ID
Read Only:true
Value that uniquely identifies the section. -
TargetDatetimeValue: string
(date-time)
Title:
Target Date Time Value
Read Only:true
Target value set by the category manager. This value is applicable for date and time. -
TargetDateValue: string
(date)
Title:
Target Date Value
Read Only:true
Target value set by the category manager. This value is applicable for dates. -
TargetNumberValue: number
Title:
Target Number Value
Read Only:true
Target value set by the category manager. This value is applicable for numbers. -
TargetTextValue: string
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).
array
Attachments
array
Links
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. Valid values include From Supplier, for two-stage sealed RFQs, From Supplier: Technical, when technical evaluation is in progress, and From Supplier: Commercial, when commercial evaluation is in progress. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User who created the attachment for the negotiation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The Base64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the negotiation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Sign in details that the user used when adding or modifying the attachment.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- attachments
-
Parameters:
- RequirementId:
$request.path.RequirementId
- RequirementValueId:
$request.path.RequirementValueId
- SectionId:
$request.path.SectionId
- draftSupplierNegotiationResponsesUniqID:
$request.path.draftSupplierNegotiationResponsesUniqID
The Attachments resource manages response attachments in the supplier negotiation response. - RequirementId:
Examples
This example describes how to update a response value in a requirement using a response ID, section ID, requirement ID, and response value ID.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/draftSupplierNegotiationResponsesUniqID/child/sections/SectionId/child/requirements/RequirementId/child/responseValues/RequirementValueId"
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188755/child/sections/38273/child/requirements/51774/child/responseValues/70232"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "IsSelectedFlag": True }
Example Response Body
{ "ResponseNumber": 188755, "SectionId": 38273, "Section": "Business", "RequirementId": 51774, "RequirementNumber": "1.", "Requirement": "Certifications", "RequirementLevel": 1, "Requirement": "Certifications", "RequirementLevel": 1, "RequirementValueId": 70232, "ScoreId": 28150, "QuestionId": null, "ScoreDisplayNumber": "a.", "ResponseValueText": "ISO 9002", "ResponseValueNumber": null, "ResponseValueDate": null, "ResponseValueDateTime": null, "IsSelectedFlag": true, "TargetTextValue": null, "TargetNumberValue": null, "TargetDateValue": null, "TargetDatetimeValue": null, "CreatedBy": "CVSUPPB01", "CreationDate": "2022-10-05T03:26:47+00:00", "LastUpdateDate": "2022-10-05T04:06:27.004+00:00", "LastUpdatedBy": "CVSUPPB01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188755/child/sections/38273/child/requirements/47701/child/responseValues/46267", "name": "responseValues", "kind": "item", "properties": { "changeIndicator": ". . ." } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188755/child/sections/38273/child/requirements/47701/child/responseValues/46267", "name": "responseValues", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188755/child/sections/38273/child/requirements/47701", "name": "requirements", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/draftSupplierNegotiationResponses/188755/child/sections/38273/child/requirements/47701/child/responseValues/46267/child/attachments", "name": "attachments", "kind": "collection" } ] }