Jump to

• Request
• Response
• Examples

Get all requirement response values

get

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

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the requirement response values associated with the negotiation response according to the primary key.
    Finder Variables
    • RequirementValueId; integer; Uniquely identifies the requirement response value in a response according to the requirement value ID.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowAttachmentCode; string; Value that determines whether the supplier can add attachments with the requirements. Valid values are OPTIONAL, REQUIRED, and NON_ALLOWED. The default value is NOT_ALLOWED.
  • CreatedBy; string; Identifies the user who created the row.
  • CreationDate; string; Timestamp of the creation of the row.
  • IsSelectedFlag; boolean; 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 and time when the user most recently updated the response value.
  • LastUpdatedBy; string; User who most recently updated the response value.
  • QuestionId; integer; Value that uniquely identifies the requirement for a question.
  • Requirement; string; Name of the requirement.
  • RequirementId; integer; Value that uniquely identifies the requirement.
  • RequirementLevel; number; 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; Value that uniquely identifies the sequence for the requirement.
  • RequirementValueId; integer; Value that uniquely identifies the response value.
  • ResponseNumber; integer; Value that uniquely identifies the requirement response value when there is no scoring applicable. This is applicable for text entry box responses.
  • ResponseValueDate; string; Response value for a requirement where response type is date.
  • ResponseValueDateTime; string; Response value for a requirement where response type is date and time.
  • ResponseValueNumber; number; Response value for a requirement where response type is number.
  • ResponseValueText; string; Response value for a requirement where response type is text.
  • ScoreDisplayNumber; string; 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; 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; Name of the requirement section.
  • SectionId; integer; Value that uniquely identifies the section.
  • TargetDateValue; string; Target value set by the category manager. This value is applicable for dates.
  • TargetDatetimeValue; string; Target value set by the category manager. This value is applicable for date and time.
  • TargetNumberValue; number; Target value set by the category manager. This value is applicable for numbers.
  • TargetTextValue; string; Target value set by the category manager. This value is applicable for text or URL (Uniform Resource Locator).
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/draftSupplierNegotiationResponses-sections-requirements-responseValues-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-item-response

Type: object

Show Source

• AllowAttachmentCode: string
  Read Only: true

  Maximum Length: 30

  Value that determines whether the supplier can add attachments with the requirements. Valid values are OPTIONAL, REQUIRED, and NON_ALLOWED. The default value is NOT_ALLOWED.
• 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":{
        "AllowAttachmentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that determines whether the supplier can add attachments with the requirements. Valid values are OPTIONAL, REQUIRED, and NON_ALLOWED. The default value is NOT_ALLOWED.",
            "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Timestamp of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Requirement":{
            "title":"Requirement",
            "maxLength":80,
            "type":"string",
            "description":"Name of 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ResponseValueNumber":{
            "title":"Response Value Number",
            "type":"number",
            "description":"Response value for a requirement where response type is number.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "Section":{
            "title":"Section",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requirement section.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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 get all requirements in a negotiation response using a response ID ,requirements ID, and response values.

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/supplierNegotiationResponses/supplierNegotiationResponsesUniqID/child/sections/SectionId/child/requirements/RequirementId/child/responseValues"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues"

Example Response Body

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

{
    "items": [
        {
            "ResponseNumber": 175326,
            "SectionId": 59274,
            "Section": "Business",
            "RequirementId": 78695,
            "RequirementNumber": "1.",
            "Requirement": "Company Ownership",
            "RequirementLevel": 1,
            "ScoreId": 47106,
            "QuestionId": null,
            "ScoreDisplayNumber": "a.",
            "RequirementValueId": 67188,
            "ResponseValueText": "Public",
            "ResponseValueNumber": null,
            "ResponseValueDate": null,
            "ResponseValueDateTime": null,
            "IsSelectedFlag": true,
            "TargetTextValue": null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "Score": 2,
            "CreatedBy": "Tech Corp",
            "CreationDate": "2023-04-16T17:43:21+00:00",
            "LastUpdateDate": "2023-04-16T17:45:34.548+00:00",
            "LastUpdatedBy": "Tech Corp",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67188",
                    "name": "responseValues",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": ". . ."
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67188",
                    "name": "responseValues",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695",
                    "name": "requirements",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67188/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                }
            ]
        },
        {
            "ResponseNumber": 175326,
            "SectionId": 59274,
            "Section": "Business",
            "RequirementId": 78695,
            "RequirementNumber": "1.",
            "Requirement": "Company Ownership",
            "RequirementLevel": 1,
            "ScoreId": 47107,
            "QuestionId": null,
            "ScoreDisplayNumber": "b.",
            "RequirementValueId": 67192,
            "ResponseValueText": "Private",
            "ResponseValueNumber": null,
            "ResponseValueDate": null,
            "ResponseValueDateTime": null,
            "IsSelectedFlag": false,
            "TargetTextValue": null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "Score": 3,
            "CreatedBy": "Tech Corp",
            "CreationDate": "2023-04-16T17:43:21+00:00",
            "LastUpdateDate": "2023-04-16T17:43:21+00:00",
            "LastUpdatedBy": "Tech Corp",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67192",
                    "name": "responseValues",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": ". . ."
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67192",
                    "name": "responseValues",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695",
                    "name": "requirements",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67192/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                }
            ]
        },
        {
            "ResponseNumber": 175326,
            "SectionId": 59274,
            "Section": "Business",
            "RequirementId": 78695,
            "RequirementNumber": "1.",
            "Requirement": "Company Ownership",
            "RequirementLevel": 1,
            "ScoreId": 47108,
            "QuestionId": null,
            "ScoreDisplayNumber": "c.",
            "RequirementValueId": 67189,
            "ResponseValueText": "Minority Owned",
            "ResponseValueNumber": null,
            "ResponseValueDate": null,
            "ResponseValueDateTime": null,
            "IsSelectedFlag": false,
            "TargetTextValue": null,
            "TargetNumberValue": null,
            "TargetDateValue": null,
            "TargetDateTimeValue": null,
            "Score": 5,
            "CreatedBy": "Tech Corp",
            "CreationDate": "2023-04-16T17:43:21+00:00",
            "LastUpdateDate": "2023-04-16T17:43:21+00:00",
            "LastUpdatedBy": "Tech Corp",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67189",
                    "name": "responseValues",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": ". . ."
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67189",
                    "name": "responseValues",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695",
                    "name": "requirements",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues/67189/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version  /supplierNegotiationResponses/175326/child/sections/59274/child/requirements/78695/child/responseValues",
            "name": "responseValues",
            "kind": "collection"
        }
    ]
}

Back to Top