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

機械翻訳について

オブジェクト・タイプの取得

get

/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}

リクエスト

パス・パラメータ

ObjectTypeCode(required): string

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

オブジェクト・タイプがユーザー・コンテキストに対して使用可能かどうかを示します。デフォルト値は'Y'です。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
objectConfigs: array Object Configurations

タイトル: Object Configurations

オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。
objectCriteria: array Object Criteria

タイトル: Object Criteria

オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。
ObjectTypeCode: string

タイトル: Object Type Code

最大長: 30

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
relatedObjects: array Related Objects

タイトル: Related Objects

関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "objectConfigs":{
            "title":"Object Configurations",
            "type":"array",
            "description":"The object configurations resource is used to view and update an object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-item-response"
            }
        },
        "objectCriteria":{
            "title":"Object Criteria",
            "type":"array",
            "description":"The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectCriteria-item-response"
            }
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object type is enabled for user context. The default value is 'Y'.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedObjects":{
            "title":"Related Objects",
            "type":"array",
            "description":"The related objects resource is used to view and update a related object.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-relatedObjects-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : オブジェクト構成

タイプ: array

タイトル: Object Configurations

オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。

ソースを表示

Array of: object userContextObjectTypes-objectConfigs-item-response

{
    "title":"Object Configurations",
    "type":"array",
    "description":"The object configurations resource is used to view and update an object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-item-response"
    }
}

ネストされたスキーマ : オブジェクト基準

タイプ: array

タイトル: Object Criteria

オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。

ソースを表示

Array of: object userContextObjectTypes-objectCriteria-item-response

{
    "title":"Object Criteria",
    "type":"array",
    "description":"The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectCriteria-item-response"
    }
}

ネストされたスキーマ : 関連オブジェクト

タイプ: array

タイトル: Related Objects

関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。

ソースを表示

Array of: object userContextObjectTypes-relatedObjects-item-response

{
    "title":"Related Objects",
    "type":"array",
    "description":"The related objects resource is used to view and update a related object.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-relatedObjects-item-response"
    }
}

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

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

ネストされたスキーマ : userContextObjectTypes-objectConfigs-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DataSourceCode: string

タイトル: Data Source Code

最大長: 30

ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

データ・ソースのオブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
objectConfigDetails: array Object Configuration Details

タイトル: Object Configuration Details

オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
ObjectMappingCode: string

タイトル: Object Mapping Code

読取り専用: true

最大長: 30

データ・ソースに使用されるオブジェクト・タイプの名前。
ObjectTypeCode: string

タイトル: Object Type Code

最大長: 30

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
ObjectWeight: 整数(int32)

タイトル: Object Weight

データ・ソースの重みまたは関連性。これは、関連スコアの計算に使用されます。
Score: integer (int64)

タイトル: Score

関連アイテムのスコア。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object for the data source is enabled for user context.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "objectConfigDetails":{
            "title":"Object Configuration Details",
            "type":"array",
            "description":"The object configuration details resource is used to view and update the object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-response"
            }
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":false,
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "ObjectWeight":{
            "title":"Object Weight",
            "type":"integer",
            "description":"The weight or relevance of a data source. This is used to calculate the relevance score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectMappingCode":{
            "title":"Object Mapping Code",
            "maxLength":30,
            "type":"string",
            "description":"The name of the object type used for the data source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : オブジェクト構成詳細

タイプ: array

タイトル: Object Configuration Details

オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。

ソースを表示

Array of: object userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

{
    "title":"Object Configuration Details",
    "type":"array",
    "description":"The object configuration details resource is used to view and update the object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-response"
    }
}

ネストされたスキーマ : userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DataSourceCode: string

タイトル: Data Source Code

最大長: 30

ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MaximumFetchSize: 整数(int32)

タイトル: Maximum Fetch Size

デフォルト値: 5

ユーザー・コンテキストに追加できる一致オブジェクトの最大数を示します。
ObjectConfigDetailsId: string

タイトル: Object Configuration Details Identifier

最大長: 512

オブジェクト構成詳細の一意の識別子。
ObjectTypeCode: string

タイトル: Object Type Code

最大長: 30

オブジェクトのタイプのコードを示します。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

デフォルト値: 1

この属性は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SavedSearchJson: 文字列(バイト)

タイトル: Saved Search JSON

保存済検索基準パラメータをJSON形式で格納します。
スコア: 整数(int32)

タイトル: Score

デフォルト値: 0

保存済検索基準に定義されているベース・スコアを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"Stores the saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the code for the type of object.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Saved Search is enabled for the user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"Indicates the maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Indicates the base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectConfigDetailsId":{
            "title":"Object Configuration Details Identifier",
            "maxLength":512,
            "type":"string",
            "description":"The unique identifier of the object configuration detail.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row 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 of the user who last updated the row.",
            "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"
    }
}

ネストされたスキーマ : userContextObjectTypes-objectCriteria-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MaximumFetchSize: 整数(int32)

タイトル: Maximum Fetch Size

デフォルト値: 5

ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
ObjectTypeCode: string

タイトル: Object Type Code

最大長: 30

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

デフォルト値: 1

オプティミスティック・ロックの実装に使用される属性。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SavedSearchJson: 文字列(バイト)

タイトル: Saved Search JSON

JSON形式の保存済検索基準パラメータ。
SavedSearchUuid: string

タイトル: Saved Search GUID

最大長: 512

ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
スコア: 整数(int32)

タイトル: Score

デフォルト値: 0

保存検索条件に定義されたベース・スコア。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"The saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the Saved Search is enabled for user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"The maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "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"
            }
        },
        "SavedSearchUuid":{
            "title":"Saved Search GUID",
            "maxLength":512,
            "type":"string",
            "description":"The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row 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 of the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : userContextObjectTypes-relatedObjects-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

ソース・オブジェクトの関連オブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update 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

オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SourceObjectTypeCode: string

タイトル: Source Object Type Code

最大長: 30

ソース・ビジネス・オブジェクトのオブジェクト・タイプ・コード。
TargetObjectId: string

タイトル: Target Object Id

最大長: 30

ユーザー・コンテキストの導出に使用されるカスタム・オブジェクト・フィールド・マッピング。
TargetObjectTypeCode: string

タイトル: Related Object Type Code

最大長: 30

関連オブジェクトのオブジェクト・タイプ・コード。関連するオブジェクト・マッピングは、ユーザー・コンテキストの導出に使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectTypeCode":{
            "title":"Source Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of the source business object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "TargetObjectTypeCode":{
            "title":"Related Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of the related object. The related object mapping is used for deriving user context.",
            "nullable":true,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the related object for the source object is enabled for user context.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TargetObjectId":{
            "title":"Target Object Id",
            "maxLength":30,
            "type":"string",
            "description":"The custom object field mapping used for deriving user context.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

objectConfigs

操作: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs

パラメータ:

ObjectTypeCode: $request.path.ObjectTypeCode

オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。

objectCriteria

操作: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria

パラメータ:

ObjectTypeCode: $request.path.ObjectTypeCode

パラメータ:

ObjectTypeCode: $request.path.ObjectTypeCode

関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、オブジェクト・タイプを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
    "ObjectTypeCode": "CRMProduct",
    "Enabled": "Y",
    "CreationDate": "2020-02-29T22:11:03+00:00",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2020-02-29T22:11:03.045+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateLogin": "-1",
    "ObjectVersionNumber": 1,
    
}

「トップに戻る」