Jump to

• Request
• Response
• Examples

Update a requirement response value

patch

/fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/sections/{SectionId}/child/requirements/{RequirementId}/child/responseValues/{RequirementValueId}

Request

Path Parameters

• 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.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ResponseValueText":{
            "title":"Response Value Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Response value for a requirement where response type is text.",
            "nullable":true
        },
        "ResponseValueDateTime":{
            "title":"Response Value Date Time",
            "type":"string",
            "description":"Response value for a requirement where response type is date and time.",
            "format":"date-time",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages response attachments in the supplier negotiation response.",
            "items":{
                "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-patch-request"
            }
        },
        "IsSelectedFlag":{
            "title":"Is Selected",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ResponseValueDate":{
            "title":"Response Value Date",
            "type":"string",
            "description":"Response value for a requirement where response type is date.",
            "format":"date",
            "nullable":true
        },
        "ResponseValueNumber":{
            "title":"Response Value Number",
            "type":"number",
            "description":"Response value for a requirement where response type is number.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages response attachments in the supplier negotiation response.

Show Source

• Array of: object draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages response attachments in the supplier negotiation response.",
    "items":{
        "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-patch-request"
    }
}

Nested Schema : draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-patch-request

Type: object

Show Source

• 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
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment isn't shared. The default value is false.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment isn't shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

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 : draftSupplierNegotiationResponses-sections-requirements-responseValues-item-response

Type: object

Show Source

• 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).

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Timestamp of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetDateValue":{
            "title":"Target Date Value",
            "type":"string",
            "description":"Target value set by the category manager. This value is applicable for dates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages response attachments in the supplier negotiation response.",
            "items":{
                "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-response"
            }
        },
        "ScoreId":{
            "title":"Score ID",
            "type":"integer",
            "description":"Value that uniquely identifies the response. This value is applicable for Multiple Choice With Single Selection or Multiple Choice With Multiple Selections response values.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequirementLevel":{
            "title":"Requirement Level",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseNumber":{
            "title":"Response Number",
            "type":"integer",
            "description":"Value that uniquely identifies the requirement response value when there is no scoring applicable. This is applicable for text entry box responses.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequirementNumber":{
            "title":"Requirement Number",
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the sequence for the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementId":{
            "title":"Requirement ID",
            "type":"integer",
            "description":"Value that uniquely identifies the requirement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IsSelectedFlag":{
            "title":"Is Selected",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseValueNumber":{
            "title":"Response Value Number",
            "type":"number",
            "description":"Response value for a requirement where response type is number.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the response value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScoreDisplayNumber":{
            "title":"Score Display Number",
            "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":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementValueId":{
            "title":"Requirement Value ID",
            "type":"integer",
            "description":"Value that uniquely identifies the response value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseValueText":{
            "title":"Response Value Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Response value for a requirement where response type is text.",
            "nullable":true,
            "x-queryable":true
        },
        "Section":{
            "title":"Section",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the requirement section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseValueDate":{
            "title":"Response Value Date",
            "type":"string",
            "description":"Response value for a requirement where response type is date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Requirement":{
            "title":"Requirement",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetDatetimeValue":{
            "title":"Target Date Time Value",
            "type":"string",
            "description":"Target value set by the category manager. This value is applicable for date and time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question ID",
            "type":"integer",
            "description":"Value that uniquely identifies the requirement for a question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetNumberValue":{
            "title":"Target Number Value",
            "type":"number",
            "description":"Target value set by the category manager. This value is applicable for numbers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseValueDateTime":{
            "title":"Response Value Date Time",
            "type":"string",
            "description":"Response value for a requirement where response type is date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetTextValue":{
            "title":"Target Text Value",
            "maxLength":"4000",
            "type":"string",
            "description":"Target value set by the category manager. This value is applicable for text or URL (Uniform Resource Locator).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionId":{
            "title":"Section ID",
            "type":"integer",
            "description":"Value that uniquely identifies the section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the response value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages response attachments in the supplier negotiation response.

Show Source

• Array of: object draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages response attachments in the supplier negotiation response.",
    "items":{
        "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-response"
    }
}

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 : draftSupplierNegotiationResponses-sections-requirements-responseValues-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment isn't shared. The default value is false.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The Base64-encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User who created the attachment for the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Sign in details that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment for the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment isn't shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/draftSupplierNegotiationResponses/{draftSupplierNegotiationResponsesUniqID}/child/sections/{SectionId}/child/requirements/{RequirementId}/child/responseValues/{RequirementValueId}/child/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.

Back to Top

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"

For example:

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

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

{
    "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"
        }
    ]
}

Back to Top