1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Questionnaire Responses
  4. Questionnaire Response Sections

Get all questionnaire response section records

get

/fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}/child/questionnaireResponseSections

Request

Path Parameters
  • 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=
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 questionnaire response section records according to the specified primary key.
      Finder Variables
      • QuestionnaireRespSectionId; integer; Value that uniquely identifies the questionnaire response section.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • DisplaySequence; integer; Specifies the order in which the sections should be displayed to the responders on a questionnaire.
    • Instructions; string; Indicates the instructions provided to the person responding to questionnaire.
    • QuestionnaireRespHeaderId; integer; Indicates an Internal system identifier for a questionnaire response.
    • QuestionnaireRespSectionId; integer; Indicates value that uniquely identifies a questionnaire response section.
    • QuestionnaireSectionId; integer; Indicates an Internal system identifier for a questionnaire section.
    • QuestionnaireSectionName; string; Indicates the name of a section in questionnaire.
    • SectionCompletedFlag; string; Value indicates section response is completed.
    • SectionGeneratedFlag; boolean; Indicates if section was generated into the questionnaire response.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : questionnaireResponses-questionnaireResponseSections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-item-response
Type: object
Show Source
Nested Schema : Questionnaire Response Details
Type: array
Title: Questionnaire Response Details
The Questionnaire Response Details resource manages response details such as response comments and the acceptance note for each question on the questionnaire.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-item-response
Type: object
Show Source
Nested Schema : Business Classifications
Type: array
Title: Business Classifications
Changes to business classifications associated with a supplier, made by supplier users, are submitted for approval to the buying organization. Once approved, these changes are reflected in the supplier profile. This resource is linked to a feature that requires opt-in.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Questionnaire Response Values
Type: array
Title: Questionnaire Response Values
The Questionnaire Response Values resource stores the response value, which could be a date, text, or number value, to a given question on a questionnaire.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-businessClassifications-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the agency that certifies the business classification for the supplier.
  • Title: Classification
    Maximum Length: 30
    Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.
  • Value that uniquely identifies a business classification on a supplier change request.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Certificate Number
    Maximum Length: 80
    Certificate that the certifying agency issues for the business classification.
  • Value that uniquely identifies the agency responsible for certifying the business classification for the supplier.
  • Title: Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
  • Title: Confirmed On
    Date when the application confirmed the business classification for the supplier.
  • Title: Classification
    Read Only: true
    Maximum Length: 80
    Classification for the supplier business.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the business classification is enabled for suppliers. If false, then the business classification isn't enabled for suppliers.
  • Read Only: true
    Date when the business classification becomes inactive.
  • Read Only: true
    Maximum Length: 255
    Contains one of the following values: true or false. If true, then the business classification is an existing classification for the supplier. If false, then the business classification is a new classification for the supplier.
  • Title: Certificate End Date
    Date on which the certificate that the certifying agency issues for the business classification expires.
  • Links
  • Value that uniquely identifies the mapping between the supplier business classification and the question.
  • Title: Notes
    Maximum Length: 1000
    Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.
  • Title: Other Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
  • Value that uniquely identifies the person in the supplier organization who provides the business classification details.
  • Title: Provided By
    Maximum Length: 255
    Full name of the supplier contact who has provided the classification information.
  • Maximum Length: 15
    Status of the business classification for the supplier.
  • Title: Certificate Start Date
    Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.
  • Read Only: true
    Date when the business classification becomes active.
  • Maximum Length: 255
    Status of the business classification for the supplier.
  • Title: Status
    Maximum Length: 255
    Abbreviation that identifies the status of the supplier business classification.
  • Read Only: true
    Maximum Length: 80
    Describes the subclassification when a minority owns a business classification.
  • Title: Subclassification
    Maximum Length: 240
    Describes the subclassification when a minority owns the business classification.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-businessClassifications-businessClassificationAttachments-item-response
Type: object
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionAttachments-item-response
Type: object
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all questionnaire response sections.

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/questionnaireResponses/QuestionnaireRespHeaderId/child/questionnaireResponseSections"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "QuestionnaireRespSectionId": 300100584890778,
            "QuestionnaireRespHeaderId": 300100584908955,
            "QuestionnaireSectionId": 300100584908912,
            "QuestionnaireSectionName": "Sourcing",
            "DisplaySequence": 1,
            "Instructions": null,
            "SectionGeneratedFlag": true,
            "SectionCompletedFlag": "Y",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections/300100584890778",
                    "name": "questionnaireResponseSections",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections/300100584890778",
                    "name": "questionnaireResponseSections",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955",
                    "name": "questionnaireResponses",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections/300100584890778/child/questionnaireResponseDetails",
                    "name": "questionnaireResponseDetails",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections/300100584890778/action/processSection",
                    "name": "processSection",
                    "kind": "other"
                }
            ]
        },
        {…}
 
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584908955/child/questionnaireResponseSections",
            "name": "questionnaireResponseSections",
            "kind": "collection"
        }
    ]
}
Back to Top