Get all survey requests

get

/crmRestApi/resources/11.13.18.05/surveyRequests

Request

Query Parameters
  • 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

    • AltKey Finds a survey request by alternate key.
      Finder Variables
      • ObjectId; integer; The object identification number of the object associate with the survey.
      • ObjectTypeCd; string; The object type of the object associate with the survey.
      • SurveyId; integer; The survey identification number.
    • PrimaryKey Finds a survey request by primary key.
      Finder Variables
      • SurveyRequestId; integer; Finds a survey request with a specified survey request identification number.
    • VendorAltKey Finds a survey request by survey template and external product survey request key.
      Finder Variables
      • SurveyId; integer; The survey identification number.
      • VendorRequestId; string; The key identifier of the external survey product request.
  • 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:
    • CreatedBy; string; The user who created the survey request.
    • CreationDate; string; The date when the survey request was created.
    • LastUpdateDate; string; The date the survey request was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the survey request.
    • LastUpdatedBy; string; The user who last updated the survey request.
    • ObjectId; integer; The identifier of the object for which the survey will be assigned. Example Service Request ID.
    • ObjectTypeCd; string; The type of the object for which the survey will be assigned. Example Service Request, Account.
    • OwnerId; integer; The person who owns the survey responses.
    • PartyId; integer; The identifier of the contact who will receive the survey.
    • RespondedFlag; boolean; The indicator that indicates whether survey is answered.
    • ResponseDate; string; The date when survey was answered.
    • SurveyId; integer; The key identifier of the survey.
    • SurveyRequestId; integer; The key identifier of the survey request.
    • SurveyTemplateName; string; The name of the survey template associated with the survey request.
    • VendorRequestId; string; The key identifier of the external survey product request.
  • 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 : surveyRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : surveyRequests-item-response
Type: object
Show Source
Nested Schema : Survey Responses
Type: array
Title: Survey Responses
The response resource is used to view and update the survey responses.
Show Source
Nested Schema : surveyRequests-responses-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all survey requests by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "SurveyRequestId": 300100205486366,
            "SurveyId": 300100205501361,
            "ObjectId": 300100111024246,
            "ObjectTypeCd": "ORA_SVC_SERVICE_REQUESTS",
            "PartyId": 100010025532672,
            "CreationDate": "2020-04-08T09:24:50+00:00",
            "CreatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2020-04-20T09:31:38.030+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateLogin": "A2695E930113EAC9E0533CFDF40AD639",
            "ObjectVersionNumber": 2,
            "RespondedFlag": true,
            "ResponseDate": "2020-04-11T12:00:20+00:00",
            "VendorRequestId": "300100205486366",
            "OwnerId": null,
            "SurveyTemplateName": "Quarterly Survey",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205486366",
                    "name": "surveyRequests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205486366",
                    "name": "surveyRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205486366/child/responses",
                    "name": "responses",
                    "kind": "collection"
                }
            ]
        },
        {
            "SurveyRequestId": 300100205501367,
            "SurveyId": 300100205486361,
            "ObjectId": 300100111024263,
            "ObjectTypeCd": "ORA_SVC_SERVICE_REQUESTS",
            "PartyId": 100010025532672,
            "CreationDate": "2020-04-08T09:25:28+00:00",
            "CreatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2020-04-08T09:25:28.077+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateLogin": "A2695E930113EAC9E0533CFDF40AD639",
            "ObjectVersionNumber": 1,
            "RespondedFlag": false,
            "ResponseDate": null,
            "VendorRequestId": "300100205501367",
            "OwnerId": null,
            "SurveyTemplateName": "Yearly Survey",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205501367",
                    "name": "surveyRequests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205501367",
                    "name": "surveyRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyRequests/300100205501367/child/responses",
                    "name": "responses",
                    "kind": "collection"
                }
            ]
        },
 ...
}
Back to Top