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

機械翻訳について

サーベイ構成の作成

post

/crmRestApi/resources/11.13.18.05/surveyConfigurations

リクエスト

ヘッダー・パラメータ

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

ソースを表示

configurationAttributes: array Survey Configuration Attributes

タイトル: Survey Configuration Attributes

サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。
Description: string

タイトル: Survey Configuration Description

最大長: 1000

サーベイ構成の説明。
Name(required): string

タイトル: Survey Configuration Name

最大長: 400

サーベイ構成の名前。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

サーベイ構成のバージョン番号。
SurveyConfigNumber: string

最大長: 30

この番号は、サーベイ構成のインポートおよびエクスポートに使用される一意の自動生成番号です。
VendorCd(required): string

タイトル: Survey Product

最大長: 30

サーベイの製品固有のコードです。たとえば、SURVEY_MONKEYです。

{
    "required":[
        "Name",
        "VendorCd"
    ],
    "type":"object",
    "properties":{
        "configurationAttributes":{
            "title":"Survey Configuration Attributes",
            "type":"array",
            "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
            "items":{
                "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-post-request"
            }
        },
        "Description":{
            "title":"Survey Configuration Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey configuration.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "VendorCd":{
            "title":"Survey Product",
            "maxLength":30,
            "type":"string",
            "description":"This is the product-specific code for the survey. For example, SURVEY_MONKEY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SurveyConfigNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This number is an auto-generated unique number that's used for import and export of Survey Configurations.",
            "nullable":false
        },
        "Name":{
            "title":"Survey Configuration Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : サーベイ構成属性

タイプ: array

タイトル: Survey Configuration Attributes

サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。

ソースを表示

Array of: object schema

{
    "title":"Survey Configuration Attributes",
    "type":"array",
    "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
    "items":{
        "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-post-request"
    }
}

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

タイプ: object

ソースを表示

AttributeCd: string

タイトル: Survey Configuration Attribute Code

最大長: 30

サーベイ構成属性のタイプです。たとえば、SURVEY_LIST_APIまたはSURVEY_DETAIL_APIです。
AttributeValue: string

タイトル: Survey Configuration Attribute Value

最大長: 4000

これはサーベイ構成属性の値です。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

サーベイ構成属性のバージョン番号。

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "title":"Survey Configuration Attribute Value",
            "maxLength":4000,
            "type":"string",
            "description":"This is the value of the survey configuration attribute.",
            "nullable":false
        },
        "AttributeCd":{
            "title":"Survey Configuration Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration attribute.",
            "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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ConfigId: integer (int64)

タイトル: Survey Configuration ID

読取り専用: true

サーベイ構成の一意の識別子。
configurationAttributes: array Survey Configuration Attributes

タイトル: Survey Configuration Attributes

サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

サーベイ構成を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

サーベイ構成が作成された日付。
Description: string

タイトル: Survey Configuration Description

最大長: 1000

サーベイ構成の説明。
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 Configuration Name

最大長: 400

サーベイ構成の名前。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

サーベイ構成のバージョン番号。
ProductName: string

タイトル: Survey Product

読取り専用: true

最大長: 80

サーベイ・モン・キーなど、特定のサーベイが属するサーベイ製品。
SurveyConfigNumber: string

最大長: 30

この番号は、サーベイ構成のインポートおよびエクスポートに使用される一意の自動生成番号です。
VendorCd: string

タイトル: Survey Product

最大長: 30

サーベイの製品固有のコードです。たとえば、SURVEY_MONKEYです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey configuration 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 configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Survey Configuration Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the survey configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Survey Product",
            "maxLength":80,
            "type":"string",
            "description":"The survey product which a particular survey belongs to, such as Survey Monkey.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorCd":{
            "title":"Survey Product",
            "maxLength":30,
            "type":"string",
            "description":"This is the product-specific code for the survey. For example, SURVEY_MONKEY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SurveyConfigNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This number is an auto-generated unique number that's used for import and export of Survey Configurations.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Survey Configuration Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the survey configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the survey configuration.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "configurationAttributes":{
            "title":"Survey Configuration Attributes",
            "type":"array",
            "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
            "items":{
                "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-item-response"
            }
        },
        "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 unique identifier of the survey configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the survey configuration 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 configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : サーベイ構成属性

タイプ: array

タイトル: Survey Configuration Attributes

サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。

ソースを表示

Array of: object surveyConfigurations-configurationAttributes-item-response

{
    "title":"Survey Configuration Attributes",
    "type":"array",
    "description":"The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.",
    "items":{
        "$ref":"#/components/schemas/surveyConfigurations-configurationAttributes-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"
    }
}

ネストされたスキーマ : surveyConfigurations-configurationAttributes-item-response

タイプ: object

ソースを表示

AttributeCd: string

タイトル: Survey Configuration Attribute Code

最大長: 30

サーベイ構成属性のタイプです。たとえば、SURVEY_LIST_APIまたはSURVEY_DETAIL_APIです。
AttributeValue: string

タイトル: Survey Configuration Attribute Value

最大長: 4000

これはサーベイ構成属性の値です。
ConfigAttrId: integer (int64)

タイトル: Survey Configuration Attribute ID

読取り専用: true

サーベイ構成属性の識別子です。
ConfigId: integer (int64)

タイトル: Survey Configuration 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

サーベイ構成属性のバージョン番号。
SurveyConfigNumber: string

読取り専用: true

最大長: 30

この番号は、サーベイ構成属性のインポートおよびエクスポートに使用される一意の自動生成番号です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the survey configuration attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the survey configuration attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Survey Configuration Attribute Value",
            "maxLength":4000,
            "type":"string",
            "description":"This is the value of the survey configuration attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the survey configuration attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigAttrId":{
            "title":"Survey Configuration Attribute ID",
            "type":"integer",
            "description":"This is the identifier of the survey configuration attribute.",
            "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 configuration attribute.",
            "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"
            }
        },
        "ConfigId":{
            "title":"Survey Configuration ID",
            "type":"integer",
            "description":"This is the unique identifier of the survey configuration attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeCd":{
            "title":"Survey Configuration Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the survey configuration attribute 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 configuration attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SurveyConfigNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This number is an auto-generated unique number that's used for import and export of Survey Configuration Attributes.",
            "nullable":false,
            "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."
        }
    }
}

リンク

VendorCodeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

configurationAttributes

操作: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes

パラメータ:

ConfigId: $request.path.ConfigId

サーベイ構成属性リソースは、サーベイ構成に関連付けられた属性の作成、読取り、更新および削除に使用されます。

「トップに戻る」