機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

サーベイの作成

post

/crmRestApi/resources/11.13.18.05/surveys

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ConfigId(required): integer (int64)
  タイトル: Survey Configuration ID

  サーベイの識別番号。
• ConfigName(required): string
  タイトル: Survey Configuration Name

  最大長: 400

  サーベイ構成の名前。
• DecisionModelName: string
  タイトル: Decision Model Name

  最大長: 400

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルの名前。
• DecisionModelService: string
  タイトル: Decision Model Service

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのサービス。
• DecisionModelSpace: string
  タイトル: Decision Model Space

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース。
• DecisionModelSpaceName: string
  タイトル: Decision Model Space

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース名。
• DecisionModelVersion: string
  タイトル: Decision Model Version

  最大長: 30

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのバージョン番号。
• Description: string
  タイトル: Survey Template Description

  最大長: 1000

  サーベイの説明。
• EndDate: string (date-time)
  タイトル: Survey End Date

  サーベイの送信が無効になった日付。
• Name(required): string
  タイトル: Survey Template Name

  最大長: 400

  サーベイの名前。
• ObjectTypeCd(required): string
  タイトル: Object Type

  最大長: 30

  サーベイに関連付けるオブジェクトのタイプ。 例:
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイのバージョン番号。
• questions: array Survey Questions
  タイトル: Survey Questions

  質問リソースは、サーベイの質問を表示および更新するために使用します。
• requests: array Survey Requests
  タイトル: Survey Requests

  リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。
• StartDate(required): string (date-time)
  タイトル: Survey Start Date

  サーベイの開始日。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  サーベイに関連付けられているストライプ・コード。
• SurveyNumber: string
  タイトル: Survey Number

  最大長: 30

  サーベイ番号。
• VendorSurveyId(required): string
  タイトル: Survey Product ID

  最大長: 1000

  サーベイの製品固有のサプライヤ識別番号です。
• VendorSurveyName(required): string
  タイトル: External Survey Name

  最大長: 64

  サーベイの製品固有の名前です。 たとえば、SURVEY_MONKEYです。
• VendorSurveyURL: string
  タイトル: External Survey URL

  最大長: 1000

  サーベイの製品固有のURLです。

{
    "required":[
        "ConfigId",
        "ConfigName",
        "Name",
        "ObjectTypeCd",
        "StartDate",
        "VendorSurveyId",
        "VendorSurveyName"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "Description":{
            "title":"Survey Template Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey.",
            "nullable":true,
            "x-queryable":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
        },
        "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
        },
        "VendorSurveyURL":{
            "title":"External Survey URL",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific url for the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "SurveyNumber":{
            "title":"Survey Number",
            "maxLength":30,
            "type":"string",
            "description":"The survey number.",
            "nullable":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"
            }
        },
        "EndDate":{
            "title":"Survey End Date",
            "type":"string",
            "description":"The date the survey is no longer available to send.",
            "format":"date-time",
            "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
        },
        "Name":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey.",
            "nullable":false
        },
        "StartDate":{
            "title":"Survey Start Date",
            "type":"string",
            "description":"The start date of the survey.",
            "format":"date-time",
            "nullable":false
        },
        "ConfigName":{
            "title":"Survey Configuration Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey configuration.",
            "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
            }
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The stripe code that's associated to the survey.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
            }
        },
        "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":false
        },
        "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
        }
    }
}

ネストされたスキーマ : 調査質問

タイプ: array

タイトル: Survey Questions

質問リソースは、サーベイの質問を表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : サーベイ・リクエスト

タイプ: array

タイトル: Survey Requests

リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : surveys-questions-item-post-request

タイプ: object

ソースを表示

• answerChoices: array Survey Answer Choices
  タイトル: Survey Answer Choices

  回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ質問のバージョン番号。
• QuestionTypeCd(required): string
  タイトル: Survey Question Type Code

  最大長: 30

  サーベイ質問の質問タイプ(1つの選択肢の選択、テキストなど)。
• SurveyId(required): integer (int64)
  タイトル: Survey ID

  この質問が属するサーベイの識別番号。
• Text(required): string
  タイトル: Survey Question Text

  最大長: 4000

  質問のテキスト。
• VendorQuestionId(required): string
  タイトル: Survey Product Question ID

  最大長: 64

  外部製品質問識別番号。

{
    "required":[
        "QuestionTypeCd",
        "SurveyId",
        "Text",
        "VendorQuestionId"
    ],
    "type":"object",
    "properties":{
        "Text":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the question.",
            "nullable":false,
            "x-queryable":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"
            }
        },
        "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
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey question.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "VendorQuestionId":{
            "title":"Survey Product Question ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product question identification number.",
            "nullable":false
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : サーベイ回答の選択

タイプ: array

タイトル: Survey Answer Choices

回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ回答選択肢のバージョン番号。
• Text: string
  タイトル: Survey Answer Text

  最大長: 4000

  回答選択のテキスト。
• VendorAnswerId: string
  タイトル: Survey Product Answer ID

  最大長: 64

  外部製品回答選択識別番号。

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

ネストされたスキーマ : surveys-requests-item-post-request

タイプ: object

ソースを表示

• ObjectId(required): integer (int64)
  タイトル: Survey Request Object ID

  サーベイが割り当てられるオブジェクトの識別子。 サービス・リクエストIDの例。
• ObjectTypeCd(required): string
  タイトル: Survey Request Object Type Code

  最大長: 30

  サーベイが割り当てられるオブジェクトのタイプ。 サービス・リクエスト、取引先の例。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・リクエストのバージョン番号。
• OwnerId: integer (int64)
  タイトル: Owner ID

  サーベイ・レスポンスを所有する個人。
• PartyId(required): integer (int64)
  タイトル: Survey Request Party ID

  サーベイを受信する担当者の識別子。
• RespondedFlag(required): boolean
  タイトル: Survey Request Response Indicator

  最大長: 1

  サーベイが回答済かどうかを示すインジケータ。
• ResponseDate: string (date-time)
  タイトル: Response Date

  サーベイが回答された日付。
• responses: array Survey Responses
  タイトル: Survey Responses

  レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
• SurveyId(required): integer (int64)
  タイトル: Survey ID

  サーベイのキー識別子。
• VendorRequestId: string
  タイトル: Survey Product Request ID

  最大長: 64

  外部サーベイ製品リクエストのキー識別子。

{
    "required":[
        "ObjectId",
        "ObjectTypeCd",
        "PartyId",
        "RespondedFlag",
        "SurveyId"
    ],
    "type":"object",
    "properties":{
        "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
            }
        },
        "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
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The person who owns the survey responses.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "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
            }
        },
        "VendorRequestId":{
            "title":"Survey Product Request ID",
            "maxLength":64,
            "type":"string",
            "description":"The key identifier of the external survey product request.",
            "nullable":false
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : サーベイ・レスポンス

タイプ: array

タイトル: Survey Responses

レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• AnswerId: integer (int64)
  タイトル: Survey Answer ID

  回答選択のキー識別子。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・レスポンスのバージョン番号。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  このレスポンスの質問の質問識別番号。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  このレスポンスのサーベイ・リクエスト識別番号。
• テキスト: 文字列(バイト)
  タイトル: Survey Response Text

  サーベイに含まれるテキスト・レスポンス。

{
    "type":"object",
    "properties":{
        "Text":{
            "title":"Survey Response Text",
            "type":"string",
            "description":"The text response included in the survey.",
            "format":"byte",
            "nullable":true
        },
        "AnswerId":{
            "title":"Survey Answer ID",
            "type":"integer",
            "description":"The key identifier of the answer choice.",
            "format":"int64",
            "nullable":true,
            "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
            }
        },
        "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
            }
        },
        "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
            }
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : surveys-item-response

タイプ: object

ソースを表示

• ConfigId: integer (int64)
  タイトル: Survey Configuration ID

  サーベイの識別番号。
• ConfigName: string
  タイトル: Survey Configuration Name

  最大長: 400

  サーベイ構成の名前。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サーベイを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  サーベイが作成された日付
• DecisionModelName: string
  タイトル: Decision Model Name

  最大長: 400

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルの名前。
• DecisionModelService: string
  タイトル: Decision Model Service

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのサービス。
• DecisionModelSpace: string
  タイトル: Decision Model Space

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース。
• DecisionModelSpaceName: string
  タイトル: Decision Model Space

  最大長: 64

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース名。
• DecisionModelVersion: string
  タイトル: Decision Model Version

  最大長: 30

  サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのバージョン番号。
• Description: string
  タイトル: Survey Template Description

  最大長: 1000

  サーベイの説明。
• EndDate: string (date-time)
  タイトル: Survey End Date

  サーベイの送信が無効になった日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  サーベイが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  サーベイを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  サーベイを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  タイトル: Survey Template Name

  最大長: 400

  サーベイの名前。
• ObjectTypeCd: string
  タイトル: Object Type

  最大長: 30

  サーベイに関連付けるオブジェクトのタイプ。 例:
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイのバージョン番号。
• ProductName: string
  タイトル: Survey Product

  読取り専用: true

  最大長: 80

  特定のサーベイが属するサーベイ製品(SurveyMonkeyなど)。
• questions: array Survey Questions
  タイトル: Survey Questions

  質問リソースは、サーベイの質問を表示および更新するために使用します。
• requests: array Survey Requests
  タイトル: Survey Requests

  リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。
• StartDate: string (date-time)
  タイトル: Survey Start Date

  サーベイの開始日。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  サーベイに関連付けられているストライプ・コード。
• SurveyId: integer (int64)
  タイトル: Survey ID

  読取り専用: true

  サーベイの一意の識別番号。
• SurveyNumber: string
  タイトル: Survey Number

  最大長: 30

  サーベイ番号。
• VendorSurveyId: string
  タイトル: Survey Product ID

  最大長: 1000

  サーベイの製品固有のサプライヤ識別番号です。
• VendorSurveyName: string
  タイトル: External Survey Name

  最大長: 64

  サーベイの製品固有の名前です。 たとえば、SURVEY_MONKEYです。
• VendorSurveyURL: string
  タイトル: External Survey URL

  最大長: 1000

  サーベイの製品固有のURLです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey was created",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Survey Template Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey.",
            "nullable":true,
            "x-queryable":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,
            "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "Name":{
            "title":"Survey Template Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey.",
            "nullable":false,
            "readOnly":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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey.",
            "nullable":false,
            "readOnly":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
        },
        "VendorSurveyURL":{
            "title":"External Survey URL",
            "maxLength":1000,
            "type":"string",
            "description":"This is the product-specific url for the survey.",
            "nullable":true,
            "x-queryable":false
        },
        "SurveyNumber":{
            "title":"Survey Number",
            "maxLength":30,
            "type":"string",
            "description":"The survey number.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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":false
        },
        "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
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : 調査質問

タイプ: array

タイトル: Survey Questions

質問リソースは、サーベイの質問を表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : サーベイ・リクエスト

タイプ: array

タイトル: Survey Requests

リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : surveys-questions-item-response

タイプ: object

ソースを表示

• answerChoices: array Survey Answer Choices
  タイトル: Survey Answer Choices

  回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サーベイ質問を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  サーベイ質問が作成された日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  サーベイ質問が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  サーベイ質問を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  サーベイ質問を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ質問のバージョン番号。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  読取り専用: true

  サーベイ質問の識別番号。
• QuestionTypeCd: string
  タイトル: Survey Question Type Code

  最大長: 30

  サーベイ質問の質問タイプ(1つの選択肢の選択、テキストなど)。
• SurveyId: integer (int64)
  タイトル: Survey ID

  この質問が属するサーベイの識別番号。
• Text: string
  タイトル: Survey Question Text

  最大長: 4000

  質問のテキスト。
• VendorQuestionId: string
  タイトル: Survey Product Question ID

  最大長: 64

  外部製品質問識別番号。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey question.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "VendorQuestionId":{
            "title":"Survey Product Question ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product question identification number.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        }
    }
}

ネストされたスキーマ : サーベイ回答の選択

タイプ: array

タイトル: Survey Answer Choices

回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : surveys-questions-answerChoices-item-response

タイプ: object

ソースを表示

• AnswerId: integer (int64)
  タイトル: Survey Answer ID

  読取り専用: true

  回答選択識別番号。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サーベイ回答選択肢を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  サーベイ回答選択肢が作成された日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  サーベイ回答選択肢が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  サーベイ回答の選択肢を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  サーベイ回答選択肢を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ回答選択肢のバージョン番号。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  読取り専用: true

  この回答選択肢が属する質問の識別番号。
• Text: string
  タイトル: Survey Answer Text

  最大長: 4000

  回答選択のテキスト。
• VendorAnswerId: string
  タイトル: Survey Product Answer ID

  最大長: 64

  外部製品回答選択識別番号。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "VendorAnswerId":{
            "title":"Survey Product Answer ID",
            "maxLength":64,
            "type":"string",
            "description":"The external product answer choice identification number.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "Text":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text of the answer choice.",
            "nullable":false,
            "x-queryable":false
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : surveys-requests-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サーベイ・リクエストを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  サーベイ・リクエストが作成された日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  サーベイ・リクエストが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  サーベイ・リクエストを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  サーベイ・リクエストを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectId: integer (int64)
  タイトル: Survey Request Object ID

  サーベイが割り当てられるオブジェクトの識別子。 サービス・リクエストIDの例。
• ObjectTypeCd: string
  タイトル: Survey Request Object Type Code

  最大長: 30

  サーベイが割り当てられるオブジェクトのタイプ。 サービス・リクエスト、取引先の例。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・リクエストのバージョン番号。
• OwnerId: integer (int64)
  タイトル: Owner ID

  サーベイ・レスポンスを所有する個人。
• PartyId: integer (int64)
  タイトル: Survey Request Party ID

  サーベイを受信する担当者の識別子。
• RespondedFlag: boolean
  タイトル: Survey Request Response Indicator

  最大長: 1

  サーベイが回答済かどうかを示すインジケータ。
• ResponseDate: string (date-time)
  タイトル: Response Date

  サーベイが回答された日付。
• responses: array Survey Responses
  タイトル: Survey Responses

  レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
• SurveyId: integer (int64)
  タイトル: Survey ID

  サーベイのキー識別子。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  読取り専用: true

  サーベイ・リクエストのキー識別子。
• SurveyTemplateName: string
  タイトル: Survey Template Name

  読取り専用: true

  最大長: 400

  サーベイ・リクエストに関連付けられたサーベイ・テンプレートの名前。
• VendorRequestId: string
  タイトル: Survey Product Request ID

  最大長: 64

  外部サーベイ製品リクエストのキー識別子。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey request.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "RespondedFlag":{
            "title":"Survey Request Response Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator that indicates whether survey is answered.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : サーベイ・レスポンス

タイプ: array

タイトル: Survey Responses

レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : surveys-requests-responses-item-response

タイプ: object

ソースを表示

• Answer: string
  タイトル: Survey Answer Text

  読取り専用: true

  最大長: 4000

  このサーベイ・レスポンスの回答。
• AnswerId: integer (int64)
  タイトル: Survey Answer ID

  回答選択のキー識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サーベイ・レスポンスを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  サーベイ・レスポンスが作成された日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  サーベイ・レスポンスが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  サーベイ・レスポンスを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  サーベイ・レスポンスを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  サーベイ・レスポンスのバージョン番号。
• Question: string
  タイトル: Survey Question Text

  読取り専用: true

  最大長: 4000

  このサーベイ・レスポンスの質問。
• QuestionId: integer (int64)
  タイトル: Survey Question ID

  このレスポンスの質問の質問識別番号。
• SurveyRequestId: integer (int64)
  タイトル: Survey Request ID

  このレスポンスのサーベイ・リクエスト識別番号。
• SurveyResponseId: integer (int64)
  タイトル: Survey Response ID

  読取り専用: true

  サーベイ・レスポンスの識別番号。
• テキスト: 文字列(バイト)
  タイトル: Survey Response Text

  サーベイに含まれるテキスト・レスポンス。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey responses.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "Answer":{
            "title":"Survey Answer Text",
            "maxLength":4000,
            "type":"string",
            "description":"The answer 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
        },
        "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
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Question":{
            "title":"Survey Question Text",
            "maxLength":4000,
            "type":"string",
            "description":"The question for this survey response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

リンク

ObjectTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_OBJECT_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ObjectTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

StripeCodeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: StripeCd;ターゲット属性: LookupCode
• 表示属性: 意味

質問

操作: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions

パラメータ:

• SurveyId: $request.path.SurveyId

質問リソースは、サーベイの質問を表示および更新するために使用します。

リクエスト

操作: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests

パラメータ:

• SurveyId: $request.path.SurveyId

リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。

「トップに戻る」