サーベイの更新
patch
/crmRestApi/resources/11.13.18.05/surveys/{SurveyId}
リクエスト
パス・パラメータ
- SurveyId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
DecisionModelName: string
タイトル:
Decision Model Name
最大長:400
サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルの名前。 -
DecisionModelSpaceName: string
タイトル:
Decision Model Space
最大長:64
サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース名。 -
Description: string
タイトル:
Survey Template Description
最大長:1000
サーベイの説明。 -
EndDate: string (date-time)
タイトル:
Survey End Date
サーベイの送信が無効になった日付。 -
Name: string
タイトル:
Survey Template Name
最大長:400
サーベイの名前。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
サーベイのバージョン番号。 -
questions: array Survey Questions
タイトル:
Survey Questions
質問リソースは、サーベイの質問を表示および更新するために使用します。 -
requests: array Survey Requests
タイトル:
Survey Requests
リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。 -
StartDate: string (date-time)
タイトル:
Survey Start Date
サーベイの開始日。 -
VendorSurveyId: string
タイトル:
Survey Product ID
最大長:1000
サーベイの製品固有のサプライヤ識別番号です。 -
VendorSurveyName: string
タイトル:
External Survey Name
最大長:64
サーベイの製品固有の名前です。 たとえば、SURVEY_MONKEYです。
ネストされたスキーマ : surveys-questions-item-patch-request
タイプ:
ソースを表示
object
-
answerChoices: array Survey Answer Choices
タイトル:
Survey Answer Choices
回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
サーベイ質問のバージョン番号。 -
QuestionTypeCd: string
タイトル:
Survey Question Type Code
最大長:30
サーベイ質問の質問タイプ(1つの選択肢の選択、テキストなど)。 -
Text: string
タイトル:
Survey Question Text
最大長:4000
質問のテキスト。 -
VendorQuestionId: string
タイトル:
Survey Product Question ID
最大長:64
外部製品質問識別番号。
ネストされたスキーマ : サーベイ回答の選択
タイプ:
array
タイトル:
Survey Answer Choices
回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : surveys-questions-answerChoices-item-patch-request
タイプ:
ソースを表示
object
-
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
サーベイ回答選択肢のバージョン番号。 -
Text: string
タイトル:
Survey Answer Text
最大長:4000
回答選択のテキスト。 -
VendorAnswerId: string
タイトル:
Survey Product Answer ID
最大長:64
外部製品回答選択識別番号。
ネストされたスキーマ : surveys-requests-item-patch-request
タイプ:
ソースを表示
object
-
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
レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。 -
VendorRequestId: string
タイトル:
Survey Product Request ID
最大長:64
外部サーベイ製品リクエストのキー識別子。
ネストされたスキーマ : サーベイ・レスポンス
タイプ:
array
タイトル:
Survey Responses
レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : surveys-requests-responses-item-patch-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
サーベイに含まれるテキスト・レスポンス。
応答
サポートされるメディア・タイプ
- 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です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : 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
外部製品質問識別番号。
ネストされたスキーマ : サーベイ回答の選択
タイプ:
array
タイトル:
Survey Answer Choices
回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : 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
外部製品回答選択識別番号。
ネストされたスキーマ : 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
外部サーベイ製品リクエストのキー識別子。
ネストされたスキーマ : サーベイ・レスポンス
タイプ:
array
タイトル:
Survey Responses
レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : 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
サーベイに含まれるテキスト・レスポンス。
リンク
- ObjectTypeLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_OBJECT_TYPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ObjectTypeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- StripeCodeLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: StripeCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- 質問
-
パラメータ:
- SurveyId:
$request.path.SurveyId
質問リソースは、サーベイの質問を表示および更新するために使用します。 - SurveyId:
- リクエスト
-
パラメータ:
- SurveyId:
$request.path.SurveyId
リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。 - SurveyId: