適応型検索メタ・モデル
メタ・モデル
適応型検索では、アーカイブ済、アクティブ、BeingPublished、サンドボックス、シード済など、異なるワークフロー状態を持つ複数のメタ・モデルがサポートされます。 1つの環境には複数のメタ・モデルが存在できますが、アクティブ・メタ・モデルは1つのみです。 クライアントは、検索サービスに接続するときにアクティブ・メタ・モデルを利用する必要があります。 'MetamodelUuid'は、公開後にメタ・モデルに割り当てられます。
https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/metaModels
レスポンス・ペイロードには、次のリンクが含まれています:
| リンク | 摘要 | 例: |
|---|---|---|
| セルフ・リンク | 現在のオブジェクトを返す適応型検索リンク | <servername>/crmRestApi/searchResources/11.13.18.05/metaModels |
| 正規リンク | <servername>/crmRestApi/searchResources/11.13.18.05/metaModels | |
| 親リンク | メタ・モデルの親であるルートを返す適応型検索リンク | <servername>/crmRestApi/searchResources/11.13.18.05/ |
| 子リンク | メタ・モデルの子オブジェクト、エンティティを返す適応型検索リンク | <servername>/crmRestApi/searchResources/11.13.18.05/entities?metaModelUuid=<metaModelUuid> |
レスポンス・ペイロードには次の属性が含まれます:
| 属性 | 摘要 |
|---|---|
| metaModeluuid | メタ・モデルの一意の識別子。 |
| workflowState | メタ・モデルのワークフロー状態。 たとえば、アクティブ、アーカイブ済、シード済などです。 |
ノート:
<metaModeluuid>がアクティブまたはアーカイブされていない場合、RESTサービスはエラーを示します。 クライアントは、URLをアクティブ・メタ・モデルにキャッシュして、単一セッションで使用できます。エンティティ
エンティティ・リソースには、トップレベルとアクティブなメタ・モデル内の子エンティティがリストされます。このエンティティは、他のデータベースからデータをインポートするために使用できます。
2つの異なるメソッドを使用してエンティティ・リソースをコールできます。
- MetamodelUuidを使用して特定のメタ・モデルをコール
- MetamodelUuidを指定せずにcURLコマンドを使用します。 この場合、アクティブなMetamodel内のすべてのエンティティがレスポンス・ペイロードで返されます。
RESTコールは、最上位レベルのエンティティと子エンティティを返します。 パラメータ'isDocument'を使用して、最上位レベル・エンティティと子エンティティを区別できます。
エンティティ・リソースのレスポンス・ペイロードには、次のリンクが含まれています:
| リンク | 摘要 | 例: |
|---|---|---|
| セルフ・リンク | 現在のオブジェクトを返す適応型検索リンク | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>?metaModelUuid=<metaModelUuid> |
| 正規リンク | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>?metaModelUuid=<metaModelUuid> | |
| 親リンク | エンティティの親であるメタ・モデルを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities?metaModelUuid=<metaModelUuid> |
| 属性リンク | エンティティの属性を返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/attributes?metaModelUuid=<metaModelUuid> |
| フィールド・リンク | 検索可能、集計可能、ソート可能またはそれ以外に索引付けされたフィールドを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/fields?metaModelUuid=<metaModelUuid> |
| 問合せリンク | エンティティの問合せを返す適応型検索リンク。 このリンクは、エンティティが問合せ対応の場合にのみ返されます。 | <servername>/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?metaModelUuid=<metaModelUuid>&entity=<entityName> |
| アクション・リンク | エンティティの問合せを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/actions?metaModelUuid=<metaModelUuid> |
| メタ・モデル・リンク | エンティティの現在のメタ・モデルを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/metaModel/<metaModelUuid> |
レスポンス・ペイロードには、次のその他の属性が含まれます:
| 属性 | 摘要 |
|---|---|
| entityUuid | エンティティの一意の識別子。 |
| entityName | エンティティの名前。 |
| localizedName | エンティティのローカライズされた名前。 |
| isDocument | レスポンスが文書かどうかを示します。 |
属性
Attributesリソースは、特定のエンティティの属性を返します。 属性は、公開されているmeatamodelのカスタム属性を含む、OOBリソースに関連付けられた標準属性です。 レスポンス・ペイロードの各アイテムは、属性を表します。
属性のレスポンス・ペイロードには、次のリンクが含まれています:
| リンク | 摘要 | 例: |
|---|---|---|
| セルフ・リンク | 現在のオブジェクトを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/attributes?metaModelUuid=<metaModelUuid> |
| 正規リンク | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/attributes?metaModelUuid=<metaModelUuid> | |
| 親リンク | 属性の親であるメタ・モデルを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>?metaModelUuid=<metaModelUuid> |
| 子アイテム・リンク | 「意味」という名前の属性の子アイテムを返す適応型検索リンク。 このリンクは、属性が列挙型である場合にのみ返されます。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/attributes/<attributeUuid>/meanings |
属性のレスポンス・ペイロードには、次の属性が含まれます:
| 属性 | 摘要 |
|---|---|
| attributeUuid | 属性の一意の識別子。 |
| attributeName | 属性の名前。 |
| localizedAttributeName | ローカライズされた属性名。 |
| AttributeType | 属性のタイプ。 |
| minOccurs | 属性が発生する必要がある最小回数。 |
| maxOccurs | 属性の発生可能な最大回数。 |
| isEnabled | 属性が有効かどうかを示します。 |
| isSearchable | 属性が検索可能かどうかを示します。 |
| isSortable | 属性がソート可能かどうかを示します。 |
| isIndexed | 属性が索引付けされているかどうかを示します。 |
フィールド
Fieldsリソースは、特定のエンティティに関連付けられたLOVリソース属性を返します。 フィールドは、OOBリソースに関連付けられた標準LOVリソースです。 レスポンス・ペイロードの各アイテムは1つのフィールドを表します。 フィールドのレスポンス・ペイロードには、次のものも含まれます。
| リンク | 摘要 | 例: |
|---|---|---|
| セルフ・リンク | 現在のオブジェクトを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/fields?metaModelUuid=<metaModelUuid> |
| 正規リンク | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>/fields?metaModelUuid=<metaModelUuid> | |
| 親リンク | フィールドの親であるメタ・モデルを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/entities/<entityName>?metaModelUuid=<metaModelUuid> |
レスポンス・ペイロードには次の属性が含まれます:
| 属性 | 摘要 |
|---|---|
| uuid | 一意のUID。 |
| docFieldPath | ドキュメント・フィールドのパス。 |
| adfRestAttributeName | ADF RESTリソースの対応する属性。 |
| adfRestAttributeNameForLocalizedValue | ADF RESTリソースのローカライズされた値の対応する属性。 |
| attributeUuid | 属性の一意のUID。 |
| attributeType | 属性のタイプ。 |
| displayAttributePath | アプリケーションでの属性の表示に対応するパス。 |
| displayLabel | 属性の表示ラベル。 |
| isVisible | 属性を表示するかどうかを示します。 |
| isAllField | すべてのフィールドを表示するかどうかを示します。 |
| isAggregatable | 属性を集計できるかどうかを示します。 |
| isRecordSet | レスポンスにレコード・セットが含まれているかどうかを示します。 |
| isSortable | 属性がソート可能かどうかを示します。 |
| isSearchable | 属性が検索可能かどうかを示します。 |
| localizedFieldPath | フィールドのローカライズされたパス。 |
検索演算子
検索演算子コレクションは、特定のフィールドに適用される検索演算子を返します。 コレクション内の各アイテムは、検索演算子に対応します。 検索演算子のレスポンス・ペイロードには、次のものも含まれます。
| リンク | 摘要 | 例: |
|---|---|---|
| セルフ・リンク | 現在のオブジェクトを返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/ searchOperators |
| 正規リンク | <servername>/crmRestApi/searchResources/11.13.18.05/ searchOperators | |
| 親リンク | 検索演算子の親を返す適応型検索リンク。 | <servername>/crmRestApi/searchResources/11.13.18.05/ |
レスポンス・ペイロードには次の属性が含まれます:
| 属性 | 説明 |
|---|---|
| searchOperatorUuid | 検索演算子の一意の識別子。 |
| searchOperatorName | 検索演算子の名前。 |
| numberOfArguments | 必要な引数の数。 |
| isApplicableForRequiredFields | 属性が必須フィールドに適用可能かどうかを示します。 |
| isApplicableToAllField | 属性がすべてのフィールドかどうかを示します。 |
| isApplicableToRecordSetField | 属性がレコード・セット・フィールドに適用可能かどうかを示します。 |
| isEnabled | 属性が有効かどうかを示します。 |