Surveys
surveys Based on latest (2026.09)
Create, change, delete and look up Surveys, with questions and requests.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
SurveyId- Required on create
ConfigIdConfigNameNameObjectTypeCdStartDateVendorSurveyIdVendorSurveyName- At a glance
- 26 fields2 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/surveys?fields=ActiveFlag,ConfigId,ConfigName,CreatedBy,CreationDate&limit=25&onlyData=true
{
"items": [
{
"ActiveFlag": true,
"ConfigId": 0,
"ConfigName": "<string, max 400>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 26
| Attribute | Type | Use |
|---|---|---|
ActiveFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
ConfigId | number | Required on create |
ConfigName | text · max 400 | Required on createSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DecisionModelName | text · max 400 | Optional on createUpdatableSearchable |
DecisionModelService | text · max 64 | Optional on createSearchable |
DecisionModelSpace | text · max 64 | Optional on createSearchable |
DecisionModelSpaceName | text · max 64 | Optional on createUpdatableSearchable |
DecisionModelVersion | text · max 30 | Optional on createSearchable |
Description | text · max 1000 | Optional on createUpdatable |
EndDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Name | text · max 400 | Required on createUpdatableSearchable |
ObjectTypeCd | text · max 30 | Required on createSearchable |
ObjectVersionNumber | number | Optional on createUpdatable |
ProductName | text · max 80 | Read-onlySearchable |
StartDate | date-time | Required on createUpdatableSearchable |
StripeCd | text · max 30 | Optional on createSearchable |
SurveyId | number | Read-onlySearchable |
SurveyNumber | text · max 30 | Optional on createSearchable |
VendorSurveyId | text · max 1000 | Required on createUpdatableSearchable |
VendorSurveyName | text · max 64 | Required on createUpdatableSearchable |
VendorSurveyURL | text · max 1000 | Optional on create |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ActiveSurveyFinder·BindCurrentDateSurveyNumberAltKey·SurveyNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/<name>. Add them to a GET with expand.
questionsGET · POST · PATCH · DELETE Survey Questions · 11 fields · 1 findersCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberQuestionIdQuestionTypeCdSurveyIdTextVendorQuestionIdanswerChoicesGET · POST · PATCH · DELETE Survey Answer Choices · 10 fields · 1 findersAnswerIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberQuestionIdTextVendorAnswerIdrequestsGET · POST · PATCH Survey Requests · 17 fields · 2 findersCreatedByCreationDateInterviewNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectIdObjectTypeCdObjectVersionNumberOwnerIdPartyIdRespondedFlagResponseDateSurveyIdSurveyRequestIdSurveyTemplateNameVendorRequestIdresponsesGET · POST · PATCH Survey Responses · 13 fields · 1 findersAnswerAnswerIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberQuestionQuestionIdSurveyRequestIdSurveyResponseIdText
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/surveysand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ActiveSurveyFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ActiveFlag, notactiveflag. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.