Get one section
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/sections/{SectionId}
Request
Path Parameters
-
SectionId(required): integer(int64)
Value that uniquely identifies the section.
-
supplierNegotiationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : supplierNegotiations-sections-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the section. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the section. -
EvaluationStage: string
Title:
Evaluation Stage
Maximum Length:80
Name of the evaluation stage in a two stage RFQ (request for quotation). Values include Technical or Commercial. A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE. -
EvaluationStageCode: string
Title:
Evaluation Stage Code
Maximum Length:30
Abbreviation that uniquely identifies the name of the evaluation stage in a two stage RFQ (request for quotation). A list of accepted values is defined in the lookup type PON_TWO_PART_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the section. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingSectionFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the pricing section is added. If false, then the pricing section is not added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false. -
requirements: array
Requirements
Title:
Requirements
The Requirements resource manages details about the requirements of a supplier negotiation. -
ScoringTeam: string
Title:
Scoring Team
Maximum Length:80
Name of the scoring team. -
ScoringTeamId: integer
(int64)
Title:
Scoring Team ID
Value that uniquely identifies a scoring team. -
Section: string
Title:
Section
Maximum Length:240
Name of the requirement section. -
SectionDisplayNumber: string
Read Only:
true
Maximum Length:80
Display number of the section. If the negotiation contains more than one section, then the application uses a display sequence to identify each section, such as 10, 20, 30, and so on. -
SectionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the section. -
SectionWeight: number
Importance of the section when compared to other sections. The application uses this weight when it calculates the over all score of requirement score.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Requirements
Type:
array
Title:
Requirements
The Requirements resource manages details about the requirements of a supplier negotiation.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : supplierNegotiations-sections-requirements-item-response
Type:
Show Source
object
-
acceptableResponseScoreValues: array
Acceptable Response Values
Title:
Acceptable Response Values
The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement. -
AllowCommentsFromSuppliersFlag: boolean
Title:
Allow comments from suppliers
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the supplier to provide comments to each requirement. If false, then do not allow. The default value is false. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages details about attachments for a requirement. -
AttachmentsFromSuppliers: string
Title:
Attachments from Suppliers
Maximum Length:80
Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
AttachmentsFromSuppliersCode: string
Title:
Attachments from Suppliers Code
Maximum Length:30
Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the requirement. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the requirement. -
DisplayTargetFlag: boolean
Title:
Display target
Maximum Length:1
Contains one of the following values: true or false. If true, then display the target value to the supplier. If false, then do not display. The default value is false. -
Hint: string
Title:
Hint
Maximum Length:1000
Text that the application displays to the supplier to help respond to the requirements. -
KnockoutScore: number
Title:
Knockout Score
Lowest requirement score that the response can receive and remain part of the shortlist. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the requirement. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the requirement. -
Level: string
Title:
Level
Maximum Length:80
Supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL. -
LevelCode: string
Title:
Level Code
Maximum Length:30
Abbreviation that uniquely identifies the supplier level for the requirement. Values include Supplier or Supplier site. A list of accepted values is defined in the lookup type PON_SUPPLIER_LEVEL. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumScore: number
Title:
Maximum Score
Highest possible score for the requirement response. -
ParentType: string
Read Only:
true
Maximum Length:10
Type of requirement. If the requirement is the parent of any other requirement, then ParentType contains SECTION. If not, then ParentType contains SCORE. -
PricingRequirementFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the response amount requirement is added to the pricing section. If false, then no requirement is added. This is applicable only when if the Overall Ranking Method is Composite Scoring. The default value is false. -
QuestionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requirement for a question. -
QuestionRevisionNumber: integer
(int32)
Title:
Revision
Read Only:true
Revision number of a predefined question that the application adds to the supplier qualification. -
Requirement: string
Title:
Requirement
Maximum Length:80
Name of the requirement. -
RequirementId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requirement. -
RequirementLevel: number
Read Only:
true
Level of the requirement. For example, 1, 2, 3, and so on. -
RequirementNumber: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the sequence for the requirement. -
RequirementText: string
(byte)
Title:
Requirement Text
Text that describes the requirement. -
RequirementType: string
Title:
Requirement Type
Maximum Length:80
Type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE. -
RequirementTypeCode: string
Title:
Requirement Type Code
Maximum Length:30
Abbreviation that uniquely identifies the type of response that the negotiation requires. Values include Text Entry Box, Multiple Choice with Multiple Selections, or Multiple Choice with Single Selection. A list of accepted values is defined in the lookup type PON_REQUIREMENT_TYPE. -
ResponseType: string
Title:
Response Type
Maximum Length:80
Specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE. -
ResponseTypeCode: string
Title:
Response Type Code
Maximum Length:30
Abbreviation that specifies whether the response for the requirement is required. Values include Required, Optional, Display Only, or Internal. A list of accepted values is defined in the lookup type PON_HDR_ATTR_RESPONSE_TYPE. -
ScoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the score. -
ScoringMethod: string
Title:
Scoring
Maximum Length:80
Method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE. -
ScoringMethodCode: string
Title:
Scoring Method Code
Maximum Length:30
Abbreviation that uniquely identifies the method that the application uses to score each requirement response. Values include Automatic, Manual, or None. A list of accepted values is defined in the lookup type PON_SCORING_TYPE. -
Section: string
Title:
Section
Read Only:true
Name of the requirement section. -
SectionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the section. -
TargetDateTimeValue: string
(date-time)
Title:
Target Date Time Value
Value that the user entered. This value is applicable for date and time. -
TargetDateValue: string
(date)
Title:
Target Date Value
Value that the user entered in the attribute. This value is applicable for dates. -
TargetNumberValue: number
Title:
Target Number Value
Value that the user entered in the attribute. This value is applicable for numbers. -
TargetTextValue: string
Title:
Target Text Value
Maximum Length:4000
Target text or URL (Uniform Resource Locator) values of the requirement. -
ValueType: string
Title:
Value Type
Maximum Length:80
Type of value for the requirement. Values include Single Line Text, Multiple Line Text, Number, Date, Date and Time, or URL (Uniform Resource Locator). A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE. -
ValueTypeCode: string
Title:
Value Type Code
Maximum Length:30
Abbreviation that identifies the type of value for the requirement. A list of accepted values is defined in the lookup type PON_REQ_RESPONSE_TYPE. -
Weight: number
Title:
Weight
Importance of the requirement when compared to other requirements. The application uses this weight when it calculates the requirement score.
Nested Schema : Acceptable Response Values
Type:
array
Title:
Acceptable Response Values
The Acceptable Response Values resource manages details about the scoring criteria of each negotiation requirement.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages details about attachments for a requirement.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response
Type:
Show Source
object
-
AttachmentsFromSuppliers: string
Title:
Attachments from Suppliers
Maximum Length:80
Requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
AttachmentsFromSuppliersCode: string
Title:
Attachments from Suppliers Code
Maximum Length:30
Abbreviation that uniquely identifies the requirement for each supplier attachment. Values include Not Allowed, Optional, or Required. A list of accepted values is defined in the lookup type PON_REQ_ALLOW_ATTACHMENT. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the acceptable response score value. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the acceptable response score value. -
DateFromRange: string
(date)
Title:
Date from Range
Start date in the range of values. Applies for date attributes. -
DateTimeFromRange: string
(date-time)
Title:
Date Time from Range
Start date and time in the range of values. Applies for date and time attributes. -
DateTimeToRange: string
(date-time)
Title:
Date Time to Range
End date and time in the range of values. Applies for date and time attributes. -
DateToRange: string
(date)
Title:
Date to Range
End Date in the range of values. Applies for date attributes. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the acceptable response score value. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the acceptable response score value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoResponseFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the application to assign a score to each supplier who does not respond to an optional requirement. If false, then do not allow. The default value is false. -
NumberFromRange: number
Title:
Number from Range
Lowest number in a range of values. Applies for number attributes. -
NumberToRange: number
Title:
Number to Range
Highest number in a range of values. Applies for number attributes. -
RequirementId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requirement. -
Score: number
Title:
Score
Score that the application assigns to each attribute response. -
ScoreDisplayNumber: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the score display. The application sets this value for each requirement that uses Multiple Choice With Single Selection or Multiple Choice With Multiple Selections. It also sets this value for each response that replies to a number, date, or date time requirement. -
ScoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the score. -
Section: string
Title:
Section
Read Only:true
Name of the requirement section. -
SectionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the section. -
TargetFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then set the value that the application is willing to accept as the target response value for the requirement. If false, then do not set. The default value is false. -
TextValue: string
Title:
Text Response Value
Maximum Length:1000
Value that the user entered. This value is applicable for text values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierNegotiations-sections-requirements-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment. It is a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating 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
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- requirements
-
Parameters:
- SectionId:
$request.path.SectionId
- supplierNegotiationsUniqID:
$request.path.supplierNegotiationsUniqID
The Requirements resource manages details about the requirements of a supplier negotiation. - SectionId:
Examples
This example describes how to get one section.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/sections/SectionId"
For example, the following command gets one section where the section identifier is 112751:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/112751"
Example Response Body
The following shows an example of the response body in JSON format.
{ "SectionId": 11275, "SectionDisplayNumber": "1.", "Section": "Technical capabilities", "EvaluationStage": null, "EvaluationStageCode": null, "ScoringTeam": "Technical Team", "ScoringTeamId": 300100152357501, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T10:46:24+00:00", "LastUpdateDate": "2018-06-28T11:26:16.127+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275", "name": "sections", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275", "name": "sections", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495", "name": "supplierNegotiations", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements", "name": "requirements", "kind": "collection" } ] }