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

すべてのサーベイ構成の取得

get

/crmRestApi/resources/11.13.18.05/surveyConfigurations

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey指定した主キーを持つサーベイ構成を検索します。
      ファインダ変数
      • ConfigId; integer; 調査構成の識別番号。
    • SurveyConfigNumberAltKey構成番号でサーベイ構成を検索します。
      ファインダ変数
      • SurveyConfigNumber; string; この数値は、サーベイ構成のインポートおよびエクスポートに使用される一意の自動生成番号です。
    • SurveyConfigVOAltKey構成名でサーベイ構成を検索します。
      ファインダ変数
      • 名前、文字列、構成の名前。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConfigId; integer; 調査構成の一意の識別子。
    • CreatedBy; string; 調査構成を作成したユーザー。
    • CreationDate; string; サーベイ構成が作成された日付。
    • 説明;文字列;調査構成の説明。
    • LastUpdateDate; string; サーベイ構成が最後に更新された日付。
    • LastUpdateLogin; string;サーベイ構成を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string;サーベイ構成を最後に更新したユーザー。
    • Name; string;サーベイ構成の名前。
    • ProductName; string;特定のサーベイが属するサーベイ製品(Survey Monkeyなど)。
    • SurveyConfigNumber; string; この数値は、サーベイ構成のインポートおよびエクスポートに使用される一意の自動生成番号です。
    • VendorCd; 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : surveyConfigurations
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : surveyConfigurations-item-response
タイプ: object
ソースを表示
  • タイトル: Survey Configuration ID
    読取り専用: true
    サーベイ構成の一意の識別子。
  • Survey Configuration Attributes
    タイトル: Survey Configuration Attributes
    サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    サーベイ構成を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    サーベイ構成が作成された日付。
  • タイトル: Survey Configuration Description
    最大長: 1000
    サーベイ構成の説明。
  • タイトル: Last Updated Date
    読取り専用: true
    サーベイ構成が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    サーベイ構成を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    サーベイ構成を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Survey Configuration Name
    最大長: 400
    サーベイ構成の名前。
  • タイトル: Object Version Number
    サーベイ構成のバージョン番号。
  • タイトル: Survey Product
    読取り専用: true
    最大長: 80
    サーベイ・モン・キーなど、特定のサーベイが属するサーベイ製品。
  • 最大長: 30
    この番号は、サーベイ構成のインポートおよびエクスポートに使用される一意の自動生成番号です。
  • タイトル: Survey Product
    最大長: 30
    サーベイの製品固有のコードです。 たとえば、SURVEY_MONKEYです。
ネストされたスキーマ : サーベイ構成属性
タイプ: array
タイトル: Survey Configuration Attributes
サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : surveyConfigurations-configurationAttributes-item-response
タイプ: object
ソースを表示
  • タイトル: Survey Configuration Attribute Code
    最大長: 30
    サーベイ構成属性のタイプです。 たとえば、SURVEY_LIST_APIまたはSURVEY_DETAIL_APIです。
  • タイトル: Survey Configuration Attribute Value
    最大長: 4000
    これはサーベイ構成属性の値です。
  • タイトル: Survey Configuration Attribute ID
    読取り専用: true
    サーベイ構成属性の識別子です。
  • タイトル: Survey Configuration 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
    サーベイ構成属性のバージョン番号。
  • 読取り専用: true
    最大長: 30
    この番号は、サーベイ構成属性のインポートおよびエクスポートに使用される一意の自動生成番号です。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "ConfigId": 300100205501354,
            "Name": "BIQA_Survey_Config_CDRM_1",
            "VendorCd": "ORA_SVC_SURVEY_MONKEY",
            "Description": null,
            "CreationDate": "2020-04-08T09:09:29+00:00",
            "CreatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2020-04-08T09:09:29.540+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateLogin": "A2695E930113EAC9E0533CFDF40AD639",
            "ObjectVersionNumber": 1,
            "SurveyConfigNumber": "CDRM_0000000001",
            "ProductName": "SurveyMonkey",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354",
                    "name": "surveyConfigurations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354",
                    "name": "surveyConfigurations",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354/lov/VendorCodeLookup",
                    "name": "VendorCodeLookup",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354/child/configurationAttributes",
                    "name": "configurationAttributes",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations",
            "name": "surveyConfigurations",
            "kind": "collection"
        }
    ]
}
「トップに戻る」