Jump to

• Request
• Response

Create a survey

post

/crmRestApi/resources/11.13.18.05/surveys

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether or not the survey is active. Value is Y when the survey is active. Value is N when the survey is inactive.
• ConfigId(required): integer (int64)
  Title: Survey Configuration ID

  The identification number of the survey.
• ConfigName(required): string
  Title: Survey Configuration Name

  Maximum Length: 400

  The name of the survey configuration.
• DecisionModelName: string
  Title: Decision Model Name

  Maximum Length: 400

  The name of the survey decision model which is used to determine when to send the survey.
• DecisionModelService: string
  Title: Decision Model Service

  Maximum Length: 64

  The service of the survey decision model which is used to determine when to send the survey.
• DecisionModelSpace: string
  Title: Decision Model Space

  Maximum Length: 64

  The space of the survey decision model which is used to determine when to send the survey.
• DecisionModelSpaceName: string
  Title: Decision Model Space

  Maximum Length: 64

  The space name of the survey decision model which is used to determine when to send the survey.
• DecisionModelVersion: string
  Title: Decision Model Version

  Maximum Length: 30

  The version number of the survey decision model which is used to determine when to send the survey.
• Description: string
  Title: Survey Template Description

  Maximum Length: 1000

  The description of the survey.
• EndDate: string (date-time)
  Title: Survey End Date

  The date the survey is no longer available to send.
• Name(required): string
  Title: Survey Template Name

  Maximum Length: 400

  The name of the survey.
• ObjectTypeCd(required): string
  Title: Object Type

  Maximum Length: 30

  The type of the object associate with the survey. Example
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey.
• questions: array Survey Questions
  Title: Survey Questions

  The questions resource is used to view and update the questions in the survey.
• requests: array Survey Requests
  Title: Survey Requests

  The request resource is used to view and update the survey requests.
• StartDate(required): string (date-time)
  Title: Survey Start Date

  The start date of the survey.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The stripe code that's associated to the survey.
• SurveyNumber: string
  Title: Survey Number

  Maximum Length: 30

  The survey number.
• VendorSurveyId(required): string
  Title: Survey Product ID

  Maximum Length: 1000

  This is the product-specific supplier identification number for the survey.
• VendorSurveyName(required): string
  Title: External Survey Name

  Maximum Length: 64

  This is the product-specific name for the survey. For example, SURVEY_MONKEY.
• VendorSurveyURL: string
  Title: External Survey URL

  Maximum Length: 1000

  This is the product-specific url for the survey.

{
    "required":[
        "ConfigId",
        "ConfigName",
        "Name",
        "ObjectTypeCd",
        "StartDate",
        "VendorSurveyId",
        "VendorSurveyName"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether or not the survey is active. Value is Y when the survey is active. Value is N when the survey is inactive.",
            "nullable":false,
            "default":true
        },
        "ConfigId":{
            "title":"Survey Configuration ID",
            "type":"integer",
            "description":"The identification number of the survey.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ConfigName":{
            "title":"Survey Configuration Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DecisionModelName":{
            "title":"Decision Model Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey decision model which is used to determine when to send the survey.",
            "nullable":true
        },
        "DecisionModelService":{
            "title":"Decision Model Service",
            "maxLength":64,
            "type":"string",
            "description":"The service of the survey decision model which is used to determine when to send the survey.",
            "nullable":true
        },
        "DecisionModelSpace":{
            "title":"Decision Model Space",
            "maxLength":64,
            "type":"string",
            "description":"The space of the survey decision model which is used to determine when to send the survey.",
            "nullable":true
        },
        "DecisionModelSpaceName":{
            "title":"Decision Model Space",
            "maxLength":64,
            "type":"string",
            "description":"The space name of the survey decision model which is used to determine when to send the survey.",
            "nullable":true
        },
        "DecisionModelVersion":{
            "title":"Decision Model Version",
            "maxLength":30,
            "type":"string",
            "description":"The version number of the survey decision model which is used to determine when to send the survey.",
            "nullable":true
        },
        "Description":{
            "title":"Survey Template Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"Survey End Date",
            "type":"string",
            "description":"The date the survey is no longer available to send.",
            "format":"date-time",
            "nullable":true
        },
        "Name":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey.",
            "nullable":false
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object associate with the survey. Example",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "StartDate":{
            "title":"Survey Start Date",
            "type":"string",
            "description":"The start date of the survey.",
            "format":"date-time",
            "nullable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The stripe code that's associated to the survey.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SurveyNumber":{
            "title":"Survey Number",
            "maxLength":30,
            "type":"string",
            "description":"The survey number.",
            "nullable":false
        },
        "VendorSurveyId":{
            "title":"Survey Product ID",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific supplier identification number for the survey.",
            "nullable":false
        },
        "VendorSurveyName":{
            "title":"External Survey Name",
            "maxLength":64,
            "type":"string",
            "description":"This is the product-specific name for the survey. For example, SURVEY_MONKEY.",
            "nullable":false
        },
        "VendorSurveyURL":{
            "title":"External Survey URL",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific url for the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "questions":{
            "title":"Survey Questions",
            "type":"array",
            "description":"The questions resource is used to view and update the questions in the survey.",
            "items":{
                "$ref":"#/components/schemas/surveys-questions-item-post-request"
            }
        },
        "requests":{
            "title":"Survey Requests",
            "type":"array",
            "description":"The request resource is used to view and update the survey requests.",
            "items":{
                "$ref":"#/components/schemas/surveys-requests-item-post-request"
            }
        }
    }
}

Nested Schema : Survey Questions

Type: array

Title: Survey Questions

The questions resource is used to view and update the questions in the survey.

Show Source

• Array of: object surveys-questions-item-post-request

{
    "title":"Survey Questions",
    "type":"array",
    "description":"The questions resource is used to view and update the questions in the survey.",
    "items":{
        "$ref":"#/components/schemas/surveys-questions-item-post-request"
    }
}

Nested Schema : Survey Requests

Type: array

Title: Survey Requests

The request resource is used to view and update the survey requests.

Show Source

• Array of: object surveys-requests-item-post-request

{
    "title":"Survey Requests",
    "type":"array",
    "description":"The request resource is used to view and update the survey requests.",
    "items":{
        "$ref":"#/components/schemas/surveys-requests-item-post-request"
    }
}

Nested Schema : surveys-questions-item-post-request

Type: object

Show Source

• answerChoices: array Survey Answer Choices
  Title: Survey Answer Choices

  The answer choices resource is used to view and update the answer choices in the survey.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey question.
• QuestionTypeCd(required): string
  Title: Survey Question Type Code

  Maximum Length: 30

  The question type of the survey question, such as Select One Choice, Text, and so on.
• SurveyId(required): integer (int64)
  Title: Survey ID

  The identification number of the survey of which this question is a part of.
• Text(required): string
  Title: Survey Question Text

  Maximum Length: 4000

  The text of the question.
• VendorQuestionId(required): string
  Title: Survey Product Question ID

  Maximum Length: 64

  The external product question identification number.

{
    "required":[
        "QuestionTypeCd",
        "SurveyId",
        "Text",
        "VendorQuestionId"
    ],
    "type":"object",
    "properties":{
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey question.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "QuestionTypeCd":{
            "title":"Survey Question Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The question type of the survey question, such as Select One Choice, Text, and so on.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The identification number of the survey of which this question is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Text":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the question.",
            "nullable":false,
            "x-queryable":false
        },
        "VendorQuestionId":{
            "title":"Survey Product Question ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product question identification number.",
            "nullable":false
        },
        "answerChoices":{
            "title":"Survey Answer Choices",
            "type":"array",
            "description":"The answer choices resource is used to view and update the answer choices in the survey.",
            "items":{
                "$ref":"#/components/schemas/surveys-questions-answerChoices-item-post-request"
            }
        }
    }
}

Nested Schema : Survey Answer Choices

Type: array

Title: Survey Answer Choices

The answer choices resource is used to view and update the answer choices in the survey.

Show Source

• Array of: object schema

{
    "title":"Survey Answer Choices",
    "type":"array",
    "description":"The answer choices resource is used to view and update the answer choices in the survey.",
    "items":{
        "$ref":"#/components/schemas/surveys-questions-answerChoices-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey answer choices.
• Text: string
  Title: Survey Answer Text

  Maximum Length: 4000

  The text of the answer choice.
• VendorAnswerId: string
  Title: Survey Product Answer ID

  Maximum Length: 64

  The external product answer choice identification number.

{
    "type":"object",
    "properties":{
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey answer choices.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Text":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the answer choice.",
            "nullable":false,
            "x-queryable":false
        },
        "VendorAnswerId":{
            "title":"Survey Product Answer ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product answer choice identification number.",
            "nullable":true
        }
    }
}

Nested Schema : surveys-requests-item-post-request

Type: object

Show Source

• InterviewNumber: string
  Title: Interview Number

  The interview number derived from the parent survey's VendorSurveyId.
• ObjectId(required): integer (int64)
  Title: Survey Request Object ID

  The identifier of the object for which the survey will be assigned. Example Service Request ID.
• ObjectTypeCd(required): string
  Title: Survey Request Object Type Code

  Maximum Length: 30

  The type of the object for which the survey will be assigned. Example Service Request, Account.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey request.
• OwnerId: integer (int64)
  Title: Owner ID

  The person who owns the survey responses.
• PartyId(required): integer (int64)
  Title: Survey Request Party ID

  The identifier of the contact who will receive the survey.
• RespondedFlag(required): boolean
  Title: Survey Request Response Indicator

  Maximum Length: 1

  The indicator that indicates whether survey is answered.
• ResponseDate: string (date-time)
  Title: Response Date

  The date when survey was answered.
• responses: array Survey Responses
  Title: Survey Responses

  The response resource is used to view and update the survey responses.
• SurveyId(required): integer (int64)
  Title: Survey ID

  The key identifier of the survey.
• VendorRequestId: string
  Title: Survey Product Request ID

  Maximum Length: 64

  The key identifier of the external survey product request.

{
    "required":[
        "ObjectId",
        "ObjectTypeCd",
        "PartyId",
        "RespondedFlag",
        "SurveyId"
    ],
    "type":"object",
    "properties":{
        "InterviewNumber":{
            "title":"Interview Number",
            "type":"string",
            "description":"The interview number derived from the parent survey's VendorSurveyId.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectId":{
            "title":"Survey Request Object ID",
            "type":"integer",
            "description":"The identifier of the object for which the survey will be assigned. Example Service Request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectTypeCd":{
            "title":"Survey Request Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object for which the survey will be assigned. Example Service Request, Account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey request.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "title":"Survey Request Party ID",
            "type":"integer",
            "description":"The identifier of the contact who will receive the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false
        },
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when survey was answered.",
            "format":"date-time",
            "nullable":true
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The key identifier of the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false
        },
        "responses":{
            "title":"Survey Responses",
            "type":"array",
            "description":"The response resource is used to view and update the survey responses.",
            "items":{
                "$ref":"#/components/schemas/surveys-requests-responses-item-post-request"
            }
        }
    }
}

Nested Schema : Survey Responses

Type: array

Title: Survey Responses

The response resource is used to view and update the survey responses.

Show Source

• Array of: object schema

{
    "title":"Survey Responses",
    "type":"array",
    "description":"The response resource is used to view and update the survey responses.",
    "items":{
        "$ref":"#/components/schemas/surveys-requests-responses-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AnswerId: integer (int64)
  Title: Survey Answer ID

  The key identifier of the answer choice.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey response.
• QuestionId: integer (int64)
  Title: Survey Question ID

  The question identification number of the question for this response.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  The survey request identification number for this response.
• Text: string (byte)
  Title: Survey Response Text

  The text response included in the survey.

{
    "type":"object",
    "properties":{
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey response.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The question identification number of the question for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The survey request identification number for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : surveys-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether or not the survey is active. Value is Y when the survey is active. Value is N when the survey is inactive.
• ConfigId: integer (int64)
  Title: Survey Configuration ID

  The identification number of the survey.
• ConfigName: string
  Title: Survey Configuration Name

  Maximum Length: 400

  The name of the survey configuration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey was created
• DecisionModelName: string
  Title: Decision Model Name

  Maximum Length: 400

  The name of the survey decision model which is used to determine when to send the survey.
• DecisionModelService: string
  Title: Decision Model Service

  Maximum Length: 64

  The service of the survey decision model which is used to determine when to send the survey.
• DecisionModelSpace: string
  Title: Decision Model Space

  Maximum Length: 64

  The space of the survey decision model which is used to determine when to send the survey.
• DecisionModelSpaceName: string
  Title: Decision Model Space

  Maximum Length: 64

  The space name of the survey decision model which is used to determine when to send the survey.
• DecisionModelVersion: string
  Title: Decision Model Version

  Maximum Length: 30

  The version number of the survey decision model which is used to determine when to send the survey.
• Description: string
  Title: Survey Template Description

  Maximum Length: 1000

  The description of the survey.
• EndDate: string (date-time)
  Title: Survey End Date

  The date the survey is no longer available to send.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Survey Template Name

  Maximum Length: 400

  The name of the survey.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The type of the object associate with the survey. Example
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey.
• ProductName: string
  Title: Survey Product

  Read Only: true

  Maximum Length: 80

  The survey product which a particular survey belongs to, such as SurveyMonkey.
• questions: array Survey Questions
  Title: Survey Questions

  The questions resource is used to view and update the questions in the survey.
• requests: array Survey Requests
  Title: Survey Requests

  The request resource is used to view and update the survey requests.
• StartDate: string (date-time)
  Title: Survey Start Date

  The start date of the survey.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The stripe code that's associated to the survey.
• SurveyId: integer (int64)
  Title: Survey ID

  Read Only: true

  The survey unique identification number.
• SurveyNumber: string
  Title: Survey Number

  Maximum Length: 30

  The survey number.
• VendorSurveyId: string
  Title: Survey Product ID

  Maximum Length: 1000

  This is the product-specific supplier identification number for the survey.
• VendorSurveyName: string
  Title: External Survey Name

  Maximum Length: 64

  This is the product-specific name for the survey. For example, SURVEY_MONKEY.
• VendorSurveyURL: string
  Title: External Survey URL

  Maximum Length: 1000

  This is the product-specific url for the survey.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether or not the survey is active. Value is Y when the survey is active. Value is N when the survey is inactive.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ConfigId":{
            "title":"Survey Configuration ID",
            "type":"integer",
            "description":"The identification number of the survey.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ConfigName":{
            "title":"Survey Configuration Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey was created",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DecisionModelName":{
            "title":"Decision Model Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey decision model which is used to determine when to send the survey.",
            "nullable":true,
            "x-queryable":true
        },
        "DecisionModelService":{
            "title":"Decision Model Service",
            "maxLength":64,
            "type":"string",
            "description":"The service of the survey decision model which is used to determine when to send the survey.",
            "nullable":true,
            "x-queryable":true
        },
        "DecisionModelSpace":{
            "title":"Decision Model Space",
            "maxLength":64,
            "type":"string",
            "description":"The space of the survey decision model which is used to determine when to send the survey.",
            "nullable":true,
            "x-queryable":true
        },
        "DecisionModelSpaceName":{
            "title":"Decision Model Space",
            "maxLength":64,
            "type":"string",
            "description":"The space name of the survey decision model which is used to determine when to send the survey.",
            "nullable":true,
            "x-queryable":true
        },
        "DecisionModelVersion":{
            "title":"Decision Model Version",
            "maxLength":30,
            "type":"string",
            "description":"The version number of the survey decision model which is used to determine when to send the survey.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Survey Template Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"Survey End Date",
            "type":"string",
            "description":"The date the survey is no longer available to send.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the survey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object associate with the survey. Example",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ProductName":{
            "title":"Survey Product",
            "maxLength":80,
            "type":"string",
            "description":"The survey product which a particular survey belongs to, such as SurveyMonkey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Survey Start Date",
            "type":"string",
            "description":"The start date of the survey.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The stripe code that's associated to the survey.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The survey unique identification number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyNumber":{
            "title":"Survey Number",
            "maxLength":30,
            "type":"string",
            "description":"The survey number.",
            "nullable":false,
            "x-queryable":true
        },
        "VendorSurveyId":{
            "title":"Survey Product ID",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific supplier identification number for the survey.",
            "nullable":false,
            "x-queryable":true
        },
        "VendorSurveyName":{
            "title":"External Survey Name",
            "maxLength":64,
            "type":"string",
            "description":"This is the product-specific name for the survey. For example, SURVEY_MONKEY.",
            "nullable":false,
            "x-queryable":true
        },
        "VendorSurveyURL":{
            "title":"External Survey URL",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific url for the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questions":{
            "title":"Survey Questions",
            "type":"array",
            "description":"The questions resource is used to view and update the questions in the survey.",
            "items":{
                "$ref":"#/components/schemas/surveys-questions-item-response"
            }
        },
        "requests":{
            "title":"Survey Requests",
            "type":"array",
            "description":"The request resource is used to view and update the survey requests.",
            "items":{
                "$ref":"#/components/schemas/surveys-requests-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Survey Questions

Type: array

Title: Survey Questions

The questions resource is used to view and update the questions in the survey.

Show Source

• Array of: object surveys-questions-item-response

{
    "title":"Survey Questions",
    "type":"array",
    "description":"The questions resource is used to view and update the questions in the survey.",
    "items":{
        "$ref":"#/components/schemas/surveys-questions-item-response"
    }
}

Nested Schema : Survey Requests

Type: array

Title: Survey Requests

The request resource is used to view and update the survey requests.

Show Source

• Array of: object surveys-requests-item-response

{
    "title":"Survey Requests",
    "type":"array",
    "description":"The request resource is used to view and update the survey requests.",
    "items":{
        "$ref":"#/components/schemas/surveys-requests-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : surveys-questions-item-response

Type: object

Show Source

• answerChoices: array Survey Answer Choices
  Title: Survey Answer Choices

  The answer choices resource is used to view and update the answer choices in the survey.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey question.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey question was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey question was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey question.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey question.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey question.
• QuestionId: integer (int64)
  Title: Survey Question ID

  Read Only: true

  The identification number of the survey question.
• QuestionTypeCd: string
  Title: Survey Question Type Code

  Maximum Length: 30

  The question type of the survey question, such as Select One Choice, Text, and so on.
• SurveyId: integer (int64)
  Title: Survey ID

  The identification number of the survey of which this question is a part of.
• Text: string
  Title: Survey Question Text

  Maximum Length: 4000

  The text of the question.
• VendorQuestionId: string
  Title: Survey Product Question ID

  Maximum Length: 64

  The external product question identification number.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey question was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey question was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the survey question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey question.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The identification number of the survey question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionTypeCd":{
            "title":"Survey Question Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The question type of the survey question, such as Select One Choice, Text, and so on.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The identification number of the survey of which this question is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the question.",
            "nullable":false,
            "x-queryable":false
        },
        "VendorQuestionId":{
            "title":"Survey Product Question ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product question identification number.",
            "nullable":false,
            "x-queryable":true
        },
        "answerChoices":{
            "title":"Survey Answer Choices",
            "type":"array",
            "description":"The answer choices resource is used to view and update the answer choices in the survey.",
            "items":{
                "$ref":"#/components/schemas/surveys-questions-answerChoices-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Survey Answer Choices

Type: array

Title: Survey Answer Choices

The answer choices resource is used to view and update the answer choices in the survey.

Show Source

• Array of: object surveys-questions-answerChoices-item-response

{
    "title":"Survey Answer Choices",
    "type":"array",
    "description":"The answer choices resource is used to view and update the answer choices in the survey.",
    "items":{
        "$ref":"#/components/schemas/surveys-questions-answerChoices-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : surveys-questions-answerChoices-item-response

Type: object

Show Source

• AnswerId: integer (int64)
  Title: Survey Answer ID

  Read Only: true

  The answer choice identification number.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey answer choices.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey answer choices was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey answer choices was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey answer choices.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey answer choices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey answer choices.
• QuestionId: integer (int64)
  Title: Survey Question ID

  Read Only: true

  The identification number of the question of which this answer choice is a part of.
• Text: string
  Title: Survey Answer Text

  Maximum Length: 4000

  The text of the answer choice.
• VendorAnswerId: string
  Title: Survey Product Answer ID

  Maximum Length: 64

  The external product answer choice identification number.

{
    "type":"object",
    "properties":{
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The answer choice identification number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey answer choices.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey answer choices was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey answer choices was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the survey answer choices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey answer choices.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey answer choices.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The identification number of the question of which this answer choice is a part of.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the answer choice.",
            "nullable":false,
            "x-queryable":false
        },
        "VendorAnswerId":{
            "title":"Survey Product Answer ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product answer choice identification number.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : surveys-requests-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey request was created.
• InterviewNumber: string
  Title: Interview Number

  The interview number derived from the parent survey's VendorSurveyId.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey request was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey request.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Survey Request Object ID

  The identifier of the object for which the survey will be assigned. Example Service Request ID.
• ObjectTypeCd: string
  Title: Survey Request Object Type Code

  Maximum Length: 30

  The type of the object for which the survey will be assigned. Example Service Request, Account.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey request.
• OwnerId: integer (int64)
  Title: Owner ID

  The person who owns the survey responses.
• PartyId: integer (int64)
  Title: Survey Request Party ID

  The identifier of the contact who will receive the survey.
• RespondedFlag: boolean
  Title: Survey Request Response Indicator

  Maximum Length: 1

  The indicator that indicates whether survey is answered.
• ResponseDate: string (date-time)
  Title: Response Date

  The date when survey was answered.
• responses: array Survey Responses
  Title: Survey Responses

  The response resource is used to view and update the survey responses.
• SurveyId: integer (int64)
  Title: Survey ID

  The key identifier of the survey.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  Read Only: true

  The key identifier of the survey request.
• SurveyTemplateName: string
  Title: Survey Template Name

  Read Only: true

  Maximum Length: 400

  The name of the survey template associated with the survey request.
• VendorRequestId: string
  Title: Survey Product Request ID

  Maximum Length: 64

  The key identifier of the external survey product request.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InterviewNumber":{
            "title":"Interview Number",
            "type":"string",
            "description":"The interview number derived from the parent survey's VendorSurveyId.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the survey request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Survey Request Object ID",
            "type":"integer",
            "description":"The identifier of the object for which the survey will be assigned. Example Service Request ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Survey Request Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the object for which the survey will be assigned. Example Service Request, Account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey request.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Survey Request Party ID",
            "type":"integer",
            "description":"The identifier of the contact who will receive the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false,
            "x-queryable":true
        },
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when survey was answered.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SurveyId":{
            "title":"Survey ID",
            "type":"integer",
            "description":"The key identifier of the survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The key identifier of the survey request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyTemplateName":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey template associated with the survey request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "responses":{
            "title":"Survey Responses",
            "type":"array",
            "description":"The response resource is used to view and update the survey responses.",
            "items":{
                "$ref":"#/components/schemas/surveys-requests-responses-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Survey Responses

Type: array

Title: Survey Responses

The response resource is used to view and update the survey responses.

Show Source

• Array of: object surveys-requests-responses-item-response

{
    "title":"Survey Responses",
    "type":"array",
    "description":"The response resource is used to view and update the survey responses.",
    "items":{
        "$ref":"#/components/schemas/surveys-requests-responses-item-response"
    }
}

Nested Schema : surveys-requests-responses-item-response

Type: object

Show Source

• Answer: string
  Title: Survey Answer Text

  Read Only: true

  Maximum Length: 4000

  The answer for this survey response.
• AnswerId: integer (int64)
  Title: Survey Answer ID

  The key identifier of the answer choice.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the survey responses.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the survey response was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the survey response was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the survey response.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the survey response.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the survey response.
• Question: string
  Title: Survey Question Text

  Read Only: true

  Maximum Length: 4000

  The question for this survey response.
• QuestionId: integer (int64)
  Title: Survey Question ID

  The question identification number of the question for this response.
• SurveyRequestId: integer (int64)
  Title: Survey Request ID

  The survey request identification number for this response.
• SurveyResponseId: integer (int64)
  Title: Survey Response ID

  Read Only: true

  The identification number of a survey response.
• Text: string (byte)
  Title: Survey Response Text

  The text response included in the survey.

{
    "type":"object",
    "properties":{
        "Answer":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The answer for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey responses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the survey response was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the survey response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey response.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Question":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The question for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Survey Question ID",
            "type":"integer",
            "description":"The question identification number of the question for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyRequestId":{
            "title":"Survey Request ID",
            "type":"integer",
            "description":"The survey request identification number for this response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SurveyResponseId":{
            "title":"Survey Response ID",
            "type":"integer",
            "description":"The identification number of a survey response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ObjectTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_OBJECT_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

StripeCodeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: StripeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

questions

Operation: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions

Parameters:

• SurveyId: $request.path.SurveyId

The questions resource is used to view and update the questions in the survey.

requests

Operation: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests

Parameters:

• SurveyId: $request.path.SurveyId

The request resource is used to view and update the survey requests.

Back to Top