機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サーベイ

すべてのサーベイの取得

get

/crmRestApi/resources/11.13.18.05/surveys

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します

    • ActiveSurveyFinder現在アクティブなサーベイを検索します。
      ファインダ変数
      • BindCurrentDate; string;現在の日付。
    • PrimaryKey主キー別のサーベイを検索します。
      ファインダ変数
      • SurveyId; integer;調査識別番号。
    • SurveyNumberAltKey調査番号で調査を検索します。
      ファインダ変数
      • SurveyNumber; string;調査番号。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConfigName; string;サーベイ構成の名前。
    • CreatedBy; string;調査を作成したユーザー。
    • CreationDate; string;調査が作成された日付
    • DecisionModelName; string;サーベイを送信するタイミングを決定するために使用されるサーベイ決定モデルの名前。
    • DecisionModelService; string;サーベイを送信するタイミングを決定するために使用されるサーベイ決定モデルのサービス。
    • DecisionModelSpace; string;サーベイを送信するタイミングを決定するために使用されるサーベイ決定モデルのスペース。
    • DecisionModelSpaceName; string;サーベイを送信するタイミングを決定するために使用されるサーベイ決定モデルのスペース名。
    • DecisionModelVersion; string;サーベイを送信するタイミングを決定するために使用されるサーベイ決定モデルのバージョン番号。
    • EndDate; string;サーベイの送信が無効になる日付。
    • LastUpdateDate; string; サーベイが最後に更新された日付。
    • LastUpdatedBy; string; サーベイを最後に更新したユーザー。
    • 名前、文字列、サーベイの名前。
    • ObjectTypeCd; string; 調査に関連付けるオブジェクトのタイプ。 例:
    • ProductName; string;特定のサーベイが属するサーベイ製品(SurveyMonkeyなど)。
    • StartDate; string;調査の開始日。
    • StripeCd; string;サーベイに関連付けられているストライプ・コード。
    • SurveyId; integer; 調査の一意の識別番号。
    • SurveyNumber; string;調査番号。
    • VendorSurveyName; string; これは、サーベイの製品固有の名前です。 たとえば、SURVEY_MONKEYです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : サーベイ
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : surveys-item-response
タイプ: object
ソースを表示
  • タイトル: Survey Configuration ID
    サーベイの識別番号。
  • タイトル: Survey Configuration Name
    最大長: 400
    サーベイ構成の名前。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    サーベイを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    サーベイが作成された日付
  • タイトル: Decision Model Name
    最大長: 400
    サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルの名前。
  • タイトル: Decision Model Service
    最大長: 64
    サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのサービス。
  • タイトル: Decision Model Space
    最大長: 64
    サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース。
  • タイトル: Decision Model Space
    最大長: 64
    サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのスペース名。
  • タイトル: Decision Model Version
    最大長: 30
    サーベイを送信するタイミングをディシジョンするために使用されるサーベイ・ディシジョン・モデルのバージョン番号。
  • タイトル: Survey Template Description
    最大長: 1000
    サーベイの説明。
  • タイトル: Survey End Date
    サーベイの送信が無効になった日付。
  • タイトル: Last Updated Date
    読取り専用: true
    サーベイが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    サーベイを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    サーベイを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Survey Template Name
    最大長: 400
    サーベイの名前。
  • タイトル: Object Type
    最大長: 30
    サーベイに関連付けるオブジェクトのタイプ。 例:
  • タイトル: Object Version Number
    サーベイのバージョン番号。
  • タイトル: Survey Product
    読取り専用: true
    最大長: 80
    特定のサーベイが属するサーベイ製品(SurveyMonkeyなど)。
  • Survey Questions
    タイトル: Survey Questions
    質問リソースは、サーベイの質問を表示および更新するために使用します。
  • Survey Requests
    タイトル: Survey Requests
    リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。
  • タイトル: Survey Start Date
    サーベイの開始日。
  • タイトル: Stripe Code
    最大長: 30
    サーベイに関連付けられているストライプ・コード。
  • タイトル: Survey ID
    読取り専用: true
    サーベイの一意の識別番号。
  • タイトル: Survey Number
    最大長: 30
    サーベイ番号。
  • タイトル: Survey Product ID
    最大長: 1000
    サーベイの製品固有のサプライヤ識別番号です。
  • タイトル: External Survey Name
    最大長: 64
    サーベイの製品固有の名前です。 たとえば、SURVEY_MONKEYです。
  • タイトル: External Survey URL
    最大長: 1000
    サーベイの製品固有のURLです。
ネストされたスキーマ : 調査質問
タイプ: array
タイトル: Survey Questions
質問リソースは、サーベイの質問を表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : サーベイ・リクエスト
タイプ: array
タイトル: Survey Requests
リクエスト・リソースは、サーベイ要求の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : surveys-questions-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : サーベイ回答の選択
タイプ: array
タイトル: Survey Answer Choices
回答選択肢リソースは、サーベイの回答選択肢を表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : surveys-questions-answerChoices-item-response
タイプ: object
ソースを表示
  • タイトル: Survey Answer ID
    読取り専用: true
    回答選択識別番号。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    サーベイ回答選択肢を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    サーベイ回答選択肢が作成された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    サーベイ回答選択肢が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    サーベイ回答の選択肢を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    サーベイ回答選択肢を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Object Version Number
    サーベイ回答選択肢のバージョン番号。
  • タイトル: Survey Question ID
    読取り専用: true
    この回答選択肢が属する質問の識別番号。
  • タイトル: Survey Answer Text
    最大長: 4000
    回答選択のテキスト。
  • タイトル: Survey Product Answer ID
    最大長: 64
    外部製品回答選択識別番号。
ネストされたスキーマ : surveys-requests-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    サーベイ・リクエストを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    サーベイ・リクエストが作成された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    サーベイ・リクエストが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    サーベイ・リクエストを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    サーベイ・リクエストを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Survey Request Object ID
    サーベイが割り当てられるオブジェクトの識別子。 サービス・リクエストIDの例。
  • タイトル: Survey Request Object Type Code
    最大長: 30
    サーベイが割り当てられるオブジェクトのタイプ。 サービス・リクエスト、取引先の例。
  • タイトル: Object Version Number
    サーベイ・リクエストのバージョン番号。
  • タイトル: Owner ID
    サーベイ・レスポンスを所有する個人。
  • タイトル: Survey Request Party ID
    サーベイを受信する担当者の識別子。
  • タイトル: Survey Request Response Indicator
    最大長: 1
    サーベイが回答済かどうかを示すインジケータ。
  • タイトル: Response Date
    サーベイが回答された日付。
  • Survey Responses
    タイトル: Survey Responses
    レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
  • タイトル: Survey ID
    サーベイのキー識別子。
  • タイトル: Survey Request ID
    読取り専用: true
    サーベイ・リクエストのキー識別子。
  • タイトル: Survey Template Name
    読取り専用: true
    最大長: 400
    サーベイ・リクエストに関連付けられたサーベイ・テンプレートの名前。
  • タイトル: Survey Product Request ID
    最大長: 64
    外部サーベイ製品リクエストのキー識別子。
ネストされたスキーマ : サーベイ・レスポンス
タイプ: array
タイトル: Survey Responses
レスポンス・リソースは、サーベイ・レスポンスを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : surveys-requests-responses-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行することによって、すべてのサーベイを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "SurveyId": 300100205501361,
            "ConfigId": 300100205501354,
            "VendorSurveyId": "1001",
            "Name": "Quarterly Survey",
            "Description": null,
            "StartDate": "2019-01-01T00:00:00+00:00",
            "EndDate": null,
            "StripeCd": "ORA_SVC_CRM",
            "CreationDate": "2020-04-08T09:20:00+00:00",
            "CreatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2020-04-20T09:32:29+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateLogin": "A2695E930113EAC9E0533CFDF40AD639",
            "ObjectVersionNumber": 15,
            "VendorSurveyName": "BIQA Test SURVEY",
            "VendorSurveyURL": "http://api.surveymonkey.com/1001",
            "ObjectTypeCd": "ORA_SVC_SERVICE_REQUESTS",
            "DecisionModelName": "Qualify Survey Decision Model",
            "DecisionModelService": "QualifySurveyService",
            "DecisionModelSpace": "jhjdjgs-dkbbf-dfbdjbf",
            "DecisionModelVersion": "3.0",
            "ConfigName": "BIQA_Survey_Config_CDRM_1",
            "SurveyNumber": "CDRM_0000000005",
            "DecisionModelSpaceName": "mySpace",
            "ProductName": "SurveyMonkey",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361",
                    "name": "surveys",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000F78"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361",
                    "name": "surveys",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361/lov/StripeCodeLookup",
                    "name": "StripeCodeLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361/lov/ObjectTypeLookup",
                    "name": "ObjectTypeLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361/lov/SurveyConfigLOV",
                    "name": "SurveyConfigLOV",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361/child/questions",
                    "name": "questions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveys/300100205501361/child/requests",
                    "name": "requests",
                    "kind": "collection"
                }
            ]
        },
...
}
「トップに戻る」