Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

サーベイ質問の作成

post

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

リクエスト

パス・パラメータ

SurveyId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: 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
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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"
    }
}

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

タイプ: 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."
        }
    }
}

リンク

QuestionTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_QUES_TYPE_CD

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

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

answerChoices

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

パラメータ:

QuestionId: $request.path.QuestionId
SurveyId: $request.path.SurveyId

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

「トップに戻る」