Create a question
post
/fscmRestApi/resources/11.13.18.05/supplierQualificationQuestions
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
acceptableResponses: array
Acceptable Responses
Title:
Acceptable Responses
The Acceptable Responses resource gets the acceptable response for a particular question. -
AllowResponderCommentsFlag: boolean
Title:
Allow comments from responder
Maximum Length:1
Contains one of the following values: true or false. If true, then the responder can enter free text comments when submitting a response to the question on a questionnaire. If false, then the responder cannot enter free text comments. The default value is false. -
AttachmentAllowed: string
Title:
Response Attachments
Maximum Length:80
Value that identifies whether the responder is allowed to attach any documents to their responses. -
AttachmentAllowedCode: string
Title:
Response Attachments Code
Maximum Length:30
Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. A list of accepted values is defined in the lookup type POQ_QUESTION_RESPONSE_ATTACH. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the attachment for a particular question. -
CriticalQuestionFlag: boolean
Title:
Critical Question
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is critical for evaluation. If false, then the question is not critical. The default value is false. -
DisplayPreferredResponseFlag: boolean
Title:
Display preferred response
Maximum Length:1
Contains one of the following values: true or false. If true, then display the preferred response, if it exists, to the supplier. If false, then do not display the preferred response. The default value is false. -
LatestRevisionFlag: boolean
Title:
Latest Revision
Maximum Length:1
Contains one of the following values: true or false. If true, then the revision is the latest revision for this question. If false, then the revision is not the latest. The default value is false. -
MaximumScore: integer
(int32)
Title:
Maximum Score
Maximum score for the question. For an automatically-scored question this value will be calculated. For a manually-scored question this value will be manually assigned to this question. -
Owner: string
Title:
Owner
Maximum Length:240
Name of the owner of the question. -
OwnerId: integer
(int64)
Value that uniquely identifies the owner of the question.
-
PreferredResponseDate: string
(date)
Title:
Preferred Response Date
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is date. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred Response Date and Time
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is date and time. -
PreferredResponseNumber: number
Title:
Preferred Response Number
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is a number. This attribute stores the preferred response value for this question. -
PreferredResponseText: string
Title:
Preferred Response Text
Maximum Length:4000
Value that identifies the preferred response value for this question where the question is without predefined acceptable responses and a response type is either single-line text, multi-line text, or URL. -
Question(required): string
Title:
Question
Maximum Length:80
Name of the question or identifier entered by the user. -
QuestionHint: string
Title:
Hint
Maximum Length:1000
Additional instructions or information to be presented to responders with the question text. -
QuestionId: integer
(int64)
Value that uniquely identifies the question.
-
QuestionLevel(required): string
Title:
Question Level
Maximum Length:80
Value that identifies whether the question is relevant to a supplier or to a supplier site. -
QuestionLevelCode(required): string
Title:
Question Level Code
Maximum Length:30
Abbreviation that identifies whether the question is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUESTION_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
QuestionPlainText: string
Title:
Question Text
Plain text of the question to be displayed to responders on a questionnaire. -
QuestionStatus(required): string
Title:
Status
Maximum Length:80
Value that identifies the status of the question. -
QuestionStatusCode(required): string
Title:
Status Code
Maximum Length:30
Abbreviation that identifies the status of the question. A list of accepted values is defined in the lookup type POQ_QUESTION_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
QuestionSurveyFlag: boolean
Title:
Internal survey
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the question can have multiple internal responses. If false, then the question can only have a single internal response. The default value is false. -
QuestionText(required): string
(byte)
Title:
Question Text
Text of the question to be displayed to responders on a questionnaire. For the POST operation, use the question text in the base64 encoded format. -
QuestionType(required): string
Title:
Question Type
Maximum Length:80
Value that identifies the following types of question: multiple choice question with single selection, a multiple choice question with multiple selections, a question without predefined acceptable responses. -
QuestionTypeCode(required): string
Title:
Question Type Code
Maximum Length:30
Abbreviation that identifies the type of question. Valid values include MCSS, MCMS, or INPUT_BOX. A list of accepted values is defined in the lookup type POQ_QUESTION_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ResponderType(required): string
Title:
Responder Type
Maximum Length:80
Value that identifies the type of responder for the question. Valid values are SUPPLIER, INTERNAL, or AUTOMATIC. -
ResponderTypeCode(required): string
Title:
Responder Type Code
Maximum Length:30
Abbreviation that identifies the type of responder for the question. Valid values are SUPPLIER, INTERNAL, or AUTOMATIC. A list of accepted values is defined in the lookup type POQ_RESPONDER_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ResponseRequiredFlag: boolean
Title:
Response Required
Maximum Length:1
Contains one of the following values: true or false. If true, then the response is required when a responder submits the question on a questionnaire. If false, then the response is not required. The default value is true. -
ResponseType: string
Title:
Response Type
Maximum Length:80
Value that identifies the type of response that specifies the data type of the response. Domain values include single line text, multiple line text, number, date, date and time, and URL. -
ResponseTypeCode: string
Title:
Response Type Code
Maximum Length:30
Abbreviation that identifies the type of response that specifies the data type of the response. A list of accepted values is defined in the lookup type POQ_RESPONSE_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
Revision(required): integer
(int32)
Title:
Revision
Number that identifies the revision of this question. Revision 0 is the base revision. -
ScoreForNoResponse: integer
(int32)
Title:
Score for No Response
Score that is automatically assigned to an optional question if no response is provided for the question. -
scores: array
Scores
Title:
Scores
The Scores resource gets the scores for number type questions. -
ScoringApproach: string
Title:
Score Calculation
Maximum Length:80
Value that identifies the automatic scoring approach for multiple-choice multiple-select questions. -
ScoringApproachCode: string
Title:
Score Calculation Code
Maximum Length:30
Abbreviation that identifies the type of scoring approach for this question. A list of accepted values is defined in the lookup type ORA_POQ_QUES_SCORING_APPROACH. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ScoringMethod: string
Title:
Scoring
Maximum Length:80
Value that identifies the scoring method to be used for this question. The default value is NONE. -
ScoringMethodCode(required): string
Title:
Scoring Code
Maximum Length:30
Abbreviation that identifies the scoring method to be used for this question. The default value is NONE. A list of accepted values is defined in the lookup type ORA_POQ_QUES_SCORING_METHOD. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
StandardsOrganization: string
Title:
Standards Organization
Maximum Length:80
Value that identifies the standards organization designated as the source of this requirement. -
StandardsOrganizationCode: string
Title:
Standards Organization Code
Maximum Length:30
Abbreviation that identifies the standards organization designated as the source of this requirement. A list of accepted values is defined in the lookup type POQ_STDS_ORG. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
Subject: string
Title:
Subject
Maximum Length:80
Value that identifies the subject to be associated with the question that is used to conduct a search. -
SubjectCode: string
Title:
Subject Code
Maximum Length:30
Abbreviation that identifies the subject to be associated with the question for search purposes. A list of accepted values is defined in the lookup type POQ_SUBJECT. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
SupplierAttributeCode: string
Title:
Supplier Attribute
Maximum Length:35
Abbreviation that identifies the supplier attribute that this question is mapped to. Valid values include ADDITIONAL_INFORMATION, BUSINESS_CLASSIFICATION, CORPORATE_PROFILE, INCOME_TAX, PRODUCTS_AND_SERVICES, SUPPLIER_SITE, or TRANSACTION_TAX. -
SupplierAttributeFlag(required): boolean
Title:
Mapped to Supplier Attribute
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is mapped to an attribute from the supplier profile. If false, then the question is not mapped. The default value is false.
Nested Schema : Acceptable Responses
Type:
array
Title:
Acceptable Responses
The Acceptable Responses resource gets the acceptable response for a particular question.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the attachment for a particular question.
Show Source
Nested Schema : Scores
Type:
array
Title:
Scores
The Scores resource gets the scores for number type questions.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-item-post-request
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
AttachmentAllowed: string
Title:
Response Attachments
Maximum Length:80
Value that identifies whether the responder is allowed to attach any documents to their responses. -
AttachmentAllowedCode(required): string
Title:
Response Attachments Code
Maximum Length:30
Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. -
branches: array
Branches
Title:
Branches
The Branches resource gets the branching questions for the acceptable response for a particular question. -
CriticalResponseFlag: boolean
Title:
Critical Response
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the response is critical for evaluation. If false, then the response is not critical. The default value is false. -
DisplaySequence(required): integer
(int32)
Title:
Display Sequence
Specifies the order in which the acceptable responses should be displayed to the responder on a questionnaire for this specific question. -
ExcludeScoringFlag: boolean
Title:
Exclude from Scoring
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is excluded from scoring. If false, then the question is included in scoring. The default value is false. -
OriginalAcceptableResponseId: integer
(int64)
Value that uniquely identifies the original account response for propagate responses for a new revision of a question.
-
PreferredResponseFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the response value is the preferred response value for this question when evaluating responses. If false, then the response value is not the preferred response value. The default value is false. -
QuestionId(required): integer
(int64)
Value that uniquely identifies the question an acceptable response applies to.
-
ResponseText: string
Title:
Response Text
Maximum Length:1000
Text of a manually entered acceptable response value. -
Score: integer
(int32)
Title:
Score
Score that is automatically assigned to the question response if the user selects the corresponding acceptable value as the question response.
Nested Schema : Branches
Type:
array
Title:
Branches
The Branches resource gets the branching questions for the acceptable response for a particular question.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
BranchToQuestionId: integer
(int64)
Value that uniquely identifies the question to branch to after the user selects the acceptable response value.
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
Number that specifies the order in which the branch question should be displayed under the acceptable response. -
Question: string
Title:
Question
Maximum Length:80
Name of the branching question or identifier entered by the user. -
QuestionBranchesId: integer
(int64)
Value that uniquely identifies the question branch.
Nested Schema : schema
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 of a question. It is a primary key that the application generates when a document is attached to the question. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
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 code, 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 content 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
URL (Uniform Resource Locator) that locates the attachment.
Nested Schema : supplierQualificationQuestions-scores-item-post-request
Type:
Show Source
object
-
CriticalResponseFlag: boolean
Title:
Critical Response
Maximum Length:1
Contains one of the following values: true or false. If true, then the score range is critical for evaluation. If false, then the score range is not critical. The default value is false. -
FromResponseValue: number
Title:
From Response Value
Lowest response value to which this scoring row applies. If the value is NULL then there is no lower limit for this scoring row. -
QuestionId: integer
(int64)
Value that uniquely identifies the question which is related to this scoring record.
-
QuestionScoreId: integer
(int64)
Value that uniquely identifies the question score.
-
Score: integer
(int32)
Title:
Score
Score to be assigned to response values that occur between the from-response value and the to-response value. -
ToResponseValue: number
Title:
To Response Value
Highest response value to which this scoring row applies. If the value is NULL then there is no upper limit for this scoring row.
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.
Root Schema : supplierQualificationQuestions-item-response
Type:
Show Source
object
-
acceptableResponses: array
Acceptable Responses
Title:
Acceptable Responses
The Acceptable Responses resource gets the acceptable response for a particular question. -
AllowResponderCommentsFlag: boolean
Title:
Allow comments from responder
Maximum Length:1
Contains one of the following values: true or false. If true, then the responder can enter free text comments when submitting a response to the question on a questionnaire. If false, then the responder cannot enter free text comments. The default value is false. -
AttachmentAllowed: string
Title:
Response Attachments
Maximum Length:80
Value that identifies whether the responder is allowed to attach any documents to their responses. -
AttachmentAllowedCode: string
Title:
Response Attachments Code
Maximum Length:30
Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. A list of accepted values is defined in the lookup type POQ_QUESTION_RESPONSE_ATTACH. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the attachment for a particular question. -
CriticalQuestionFlag: boolean
Title:
Critical Question
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is critical for evaluation. If false, then the question is not critical. The default value is false. -
DisplayPreferredResponseFlag: boolean
Title:
Display preferred response
Maximum Length:1
Contains one of the following values: true or false. If true, then display the preferred response, if it exists, to the supplier. If false, then do not display the preferred response. The default value is false. -
LatestRevisionFlag: boolean
Title:
Latest Revision
Maximum Length:1
Contains one of the following values: true or false. If true, then the revision is the latest revision for this question. If false, then the revision is not the latest. The default value is false. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumScore: integer
(int32)
Title:
Maximum Score
Maximum score for the question. For an automatically-scored question this value will be calculated. For a manually-scored question this value will be manually assigned to this question. -
Owner: string
Title:
Owner
Maximum Length:240
Name of the owner of the question. -
OwnerId: integer
(int64)
Value that uniquely identifies the owner of the question.
-
PreferredResponseDate: string
(date)
Title:
Preferred Response Date
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is date. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred Response Date and Time
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is date and time. -
PreferredResponseNumber: number
Title:
Preferred Response Number
Value that identifies the preferred response value for a question where the question is without predefined acceptable responses and response type is a number. This attribute stores the preferred response value for this question. -
PreferredResponseText: string
Title:
Preferred Response Text
Maximum Length:4000
Value that identifies the preferred response value for this question where the question is without predefined acceptable responses and a response type is either single-line text, multi-line text, or URL. -
Question: string
Title:
Question
Maximum Length:80
Name of the question or identifier entered by the user. -
QuestionHint: string
Title:
Hint
Maximum Length:1000
Additional instructions or information to be presented to responders with the question text. -
QuestionId: integer
(int64)
Value that uniquely identifies the question.
-
QuestionLevel: string
Title:
Question Level
Maximum Length:80
Value that identifies whether the question is relevant to a supplier or to a supplier site. -
QuestionLevelCode: string
Title:
Question Level Code
Maximum Length:30
Abbreviation that identifies whether the question is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUESTION_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
QuestionPlainText: string
Title:
Question Text
Plain text of the question to be displayed to responders on a questionnaire. -
QuestionStatus: string
Title:
Status
Maximum Length:80
Value that identifies the status of the question. -
QuestionStatusCode: string
Title:
Status Code
Maximum Length:30
Abbreviation that identifies the status of the question. A list of accepted values is defined in the lookup type POQ_QUESTION_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
QuestionSurveyFlag: boolean
Title:
Internal survey
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the question can have multiple internal responses. If false, then the question can only have a single internal response. The default value is false. -
QuestionText: string
(byte)
Title:
Question Text
Text of the question to be displayed to responders on a questionnaire. For the POST operation, use the question text in the base64 encoded format. -
QuestionType: string
Title:
Question Type
Maximum Length:80
Value that identifies the following types of question: multiple choice question with single selection, a multiple choice question with multiple selections, a question without predefined acceptable responses. -
QuestionTypeCode: string
Title:
Question Type Code
Maximum Length:30
Abbreviation that identifies the type of question. Valid values include MCSS, MCMS, or INPUT_BOX. A list of accepted values is defined in the lookup type POQ_QUESTION_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ResponderType: string
Title:
Responder Type
Maximum Length:80
Value that identifies the type of responder for the question. Valid values are SUPPLIER, INTERNAL, or AUTOMATIC. -
ResponderTypeCode: string
Title:
Responder Type Code
Maximum Length:30
Abbreviation that identifies the type of responder for the question. Valid values are SUPPLIER, INTERNAL, or AUTOMATIC. A list of accepted values is defined in the lookup type POQ_RESPONDER_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ResponseRequiredFlag: boolean
Title:
Response Required
Maximum Length:1
Contains one of the following values: true or false. If true, then the response is required when a responder submits the question on a questionnaire. If false, then the response is not required. The default value is true. -
ResponseType: string
Title:
Response Type
Maximum Length:80
Value that identifies the type of response that specifies the data type of the response. Domain values include single line text, multiple line text, number, date, date and time, and URL. -
ResponseTypeCode: string
Title:
Response Type Code
Maximum Length:30
Abbreviation that identifies the type of response that specifies the data type of the response. A list of accepted values is defined in the lookup type POQ_RESPONSE_TYPE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
Revision: integer
(int32)
Title:
Revision
Number that identifies the revision of this question. Revision 0 is the base revision. -
ScoreForNoResponse: integer
(int32)
Title:
Score for No Response
Score that is automatically assigned to an optional question if no response is provided for the question. -
scores: array
Scores
Title:
Scores
The Scores resource gets the scores for number type questions. -
ScoringApproach: string
Title:
Score Calculation
Maximum Length:80
Value that identifies the automatic scoring approach for multiple-choice multiple-select questions. -
ScoringApproachCode: string
Title:
Score Calculation Code
Maximum Length:30
Abbreviation that identifies the type of scoring approach for this question. A list of accepted values is defined in the lookup type ORA_POQ_QUES_SCORING_APPROACH. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
ScoringMethod: string
Title:
Scoring
Maximum Length:80
Value that identifies the scoring method to be used for this question. The default value is NONE. -
ScoringMethodCode: string
Title:
Scoring Code
Maximum Length:30
Abbreviation that identifies the scoring method to be used for this question. The default value is NONE. A list of accepted values is defined in the lookup type ORA_POQ_QUES_SCORING_METHOD. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
StandardsOrganization: string
Title:
Standards Organization
Maximum Length:80
Value that identifies the standards organization designated as the source of this requirement. -
StandardsOrganizationCode: string
Title:
Standards Organization Code
Maximum Length:30
Abbreviation that identifies the standards organization designated as the source of this requirement. A list of accepted values is defined in the lookup type POQ_STDS_ORG. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
Subject: string
Title:
Subject
Maximum Length:80
Value that identifies the subject to be associated with the question that is used to conduct a search. -
SubjectCode: string
Title:
Subject Code
Maximum Length:30
Abbreviation that identifies the subject to be associated with the question for search purposes. A list of accepted values is defined in the lookup type POQ_SUBJECT. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. -
SupplierAttribute: string
Title:
Supplier Attribute
Read Only:true
Maximum Length:200
Value that identifies the supplier attribute that this question is mapped to. -
SupplierAttributeCode: string
Title:
Supplier Attribute
Maximum Length:35
Abbreviation that identifies the supplier attribute that this question is mapped to. Valid values include ADDITIONAL_INFORMATION, BUSINESS_CLASSIFICATION, CORPORATE_PROFILE, INCOME_TAX, PRODUCTS_AND_SERVICES, SUPPLIER_SITE, or TRANSACTION_TAX. -
SupplierAttributeFlag: boolean
Title:
Mapped to Supplier Attribute
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is mapped to an attribute from the supplier profile. If false, then the question is not mapped. The default value is false.
Nested Schema : Acceptable Responses
Type:
array
Title:
Acceptable Responses
The Acceptable Responses resource gets the acceptable response for a particular question.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the attachment for a particular question.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scores
Type:
array
Title:
Scores
The Scores resource gets the scores for number type questions.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-item-response
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
AttachmentAllowed: string
Title:
Response Attachments
Maximum Length:80
Value that identifies whether the responder is allowed to attach any documents to their responses. -
AttachmentAllowedCode: string
Title:
Response Attachments Code
Maximum Length:30
Abbreviation that identifies whether the responder is allowed to attach any documents to their responses. -
AttributeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the supplier attribute. -
AttributeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier attribute. -
AttributeValueCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the supplier attribute value. -
branches: array
Branches
Title:
Branches
The Branches resource gets the branching questions for the acceptable response for a particular question. -
Category: string
Read Only:
true
Maximum Length:250
Value that indicates the category name of browse category or item category if a question is mapped to products and services. The category name is always stored in session language of the buyer the first time a question is created. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies whether the question is mapped to browse category or item category when it is mapped to the supplier attribute products and services. -
CriticalResponseFlag: boolean
Title:
Critical Response
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the response is critical for evaluation. If false, then the response is not critical. The default value is false. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Specifies the order in which the acceptable responses should be displayed to the responder on a questionnaire for this specific question. -
ExcludeScoringFlag: boolean
Title:
Exclude from Scoring
Maximum Length:1
Contains one of the following values: true or false. If true, then the question is excluded from scoring. If false, then the question is included in scoring. The default value is false. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalAcceptableResponseId: integer
(int64)
Value that uniquely identifies the original account response for propagate responses for a new revision of a question.
-
ParentCategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the immediate parent browse category of a given node, if there is a parent category, when the question is mapped to the supplier attribute products and services. -
PreferredResponseFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the response value is the preferred response value for this question when evaluating responses. If false, then the response value is not the preferred response value. The default value is false. -
PurchasingCategoryFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the question belongs to item category. If false, then the question belongs to browse category. The default value is null. -
QuestionId: integer
(int64)
Value that uniquely identifies the question an acceptable response applies to.
-
ResponseText: string
Title:
Response Text
Maximum Length:1000
Text of a manually entered acceptable response value. -
Score: integer
(int32)
Title:
Score
Score that is automatically assigned to the question response if the user selects the corresponding acceptable value as the question response.
Nested Schema : Branches
Type:
array
Title:
Branches
The Branches resource gets the branching questions for the acceptable response for a particular question.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualificationQuestions-acceptableResponses-branches-item-response
Type:
Show Source
object
-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the acceptable response.
-
BranchToQuestionId: integer
(int64)
Value that uniquely identifies the question to branch to after the user selects the acceptable response value.
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
Number that specifies the order in which the branch question should be displayed under the acceptable response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Question: string
Title:
Question
Maximum Length:80
Name of the branching question or identifier entered by the user. -
QuestionBranchesId: integer
(int64)
Value that uniquely identifies the question branch.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : supplierQualificationQuestions-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 of a question. It is a primary key that the application generates when a document is attached to the question. -
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. -
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. -
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 code, 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 content 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 document that is attached to the question. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the document that is attached to the question. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment. -
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
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login 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
Nested Schema : supplierQualificationQuestions-scores-item-response
Type:
Show Source
object
-
CriticalResponseFlag: boolean
Title:
Critical Response
Maximum Length:1
Contains one of the following values: true or false. If true, then the score range is critical for evaluation. If false, then the score range is not critical. The default value is false. -
FromResponseValue: number
Title:
From Response Value
Lowest response value to which this scoring row applies. If the value is NULL then there is no lower limit for this scoring row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionId: integer
(int64)
Value that uniquely identifies the question which is related to this scoring record.
-
QuestionScoreId: integer
(int64)
Value that uniquely identifies the question score.
-
Score: integer
(int32)
Title:
Score
Score to be assigned to response values that occur between the from-response value and the to-response value. -
ToResponseValue: number
Title:
To Response Value
Highest response value to which this scoring row applies. If the value is NULL then there is no upper limit for this scoring row.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- acceptableResponses
-
Parameters:
- QuestionId:
$request.path.QuestionId
The Acceptable Responses resource gets the acceptable response for a particular question. - QuestionId:
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationQuestions/{QuestionId}/child/attachmentsParameters:
- QuestionId:
$request.path.QuestionId
The Attachments resource gets the attachment for a particular question. - QuestionId:
- scores
-
Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationQuestions/{QuestionId}/child/scoresParameters:
- QuestionId:
$request.path.QuestionId
The Scores resource gets the scores for number type questions. - QuestionId:
Examples
This example describes how to create a question.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions"
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 creates.
{ "Question": "Fiscal Year Revenue", "QuestionLevel": "Supplier", "ResponderType": "Supplier", "SupplierAttributeFlag": false, "QuestionType": "Text entry box", "ResponseType": "Number", "QuestionStatus": "Active", "ScoringMethod": "Automatic", "PreferredResponseNumber": "123", "ScoreForNoResponse": "0", "AttachmentAllowed": "Not allowed", "QuestionText":"RXN0aW1hdGUgeW91ciBleHBlY3RlZCByZXZlbnVlIGZvciB5b3VyIGN1cnJlbnQgZmlzY2FsIHllYXI=", "scores": [ { "FromResponseValue": 0, "ToResponseValue": 500, "Score": 5 }, { "FromResponseValue": 501, "ToResponseValue": 5000, "Score": 10 } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "QuestionId": 300100184967550, "Revision": 0, "Question": "Fiscal Year Revenue", "QuestionLevelCode": "SUPPLIER", "QuestionLevel": "Supplier", "ResponderTypeCode": "SUPPLIER", "ResponderType": "Supplier", "SupplierAttributeFlag": false, "SupplierAttributeCode": null, "SupplierAttribute": null, "QuestionTypeCode": "INPUT_BOX", "QuestionType": "Text entry box", "QuestionStatusCode": "ACTIVE", "QuestionStatus": "Active", "OwnerId": null, "Owner": null, "DisplayPreferredResponseFlag": null, "CriticalQuestionFlag": false, "ResponseRequiredFlag": false, "AllowResponderCommentsFlag": false, "QuestionHint": null, "SubjectCode": null, "Subject": null, "StandardsOrganizationCode": null, "StandardsOrganization": null, "ResponseTypeCode": "NUMBER", "ResponseType": "Number", "PreferredResponseDate": null, "PreferredResponseDatetime": null, "PreferredResponseNumber": 123, "PreferredResponseText": null, "ScoringMethodCode": "AUTOMATIC", "ScoringMethod": "Automatic", "MaximumScore": 10, "ScoreForNoResponse": 0, "ScoringApproachCode": null, "ScoringApproach": null, "AttachmentAllowedCode": "NOT_ALLOWED", "AttachmentAllowed": "Not allowed", "LatestRevisionFlag": true, "QuestionPlainText": "Fiscal Year Revenue", "scores": [ { "QuestionScoreId": 300100184967551, "QuestionId": 300100184967550, "Score": 5, "FromResponseValue": 0, "ToResponseValue": 500, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/scores/300100184967551", "name": "scores", "kind": "item", "properties": { "changeIndicator": ... } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/scores/300100184967551", "name": "scores", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550", "name": "supplierQualificationQuestions", "kind": "item" } ] }, { "QuestionScoreId": 300100184967552, "QuestionId": 300100184967550, "Score": 10, "FromResponseValue": 501, "ToResponseValue": 5000, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/scores/300100184967552", "name": "scores", "kind": "item", "properties": { "changeIndicator": ... } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/scores/300100184967552", "name": "scores", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550", "name": "supplierQualificationQuestions", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550", "name": "supplierQualificationQuestions", "kind": "item", "properties": { "changeIndicator": ... } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550", "name": "supplierQualificationQuestions", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/acceptableResponses", "name": "acceptableResponses", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/child/scores", "name": "scores", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestions/300100184967550/enclosure/QuestionText", "name": "QuestionText", "kind": "other" } ] }