データ管理API
重要 - 画像/情報は四半期ごとのリリースで更新されます!
四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。
データ管理 APIは、REST (Representational State Transfer) を中心に構成されています。このドキュメントでは、管理者 がこれらの REST API を使用して Gainsightのオブジェクトとフィールドの詳細を取得する方法について詳しく説明します。
はじめに
Gainsightを使用すると、管理者はREST APIを使用してオブジェクトとフィールドのメタデータ情報を取得できます。データ管理にアクセスすることで恩恵を受けるすべてのチームが常にGainsightを使用しているわけではありません。彼らは自分たちで選んだシステムを持っており、Gainsightがそれらとよりよく統合することを期待しています。開発リソースをお持ちのお客様は、APIを使用して、Gainsightと使用している他のシステムとの間で、より緊密でカスタマイズされた統合を構築できます。
ビジネスユースケース: 顧客がアプリケーションをGainsightと統合したい場合。データがどのようにGainsightに保存されるのか、つまりGainsightオブジェクトのメタデータの構造を理解したいと思うでしょう。このようなお客様は、Gainsightアプリケーションにログインしなくても、これらのAPIを使用してGainsightオブジェクトのメタデータを理解することができます。
認証
これらのデータ管理 API を使用するには、必ずアクセストークンを生成してください。
- APIの認証：API アクセスは、固有のアクセスキーを使用して制御されます。REST API要求を送信するGainsightテナントのアクセスキーを取得するにはGainsight 管理者に連絡してください。アクセスキーを生成または共有する方法の詳細については、「API アクセスキーを生成」の記事を参照してください。
アクセスキーを受け取ったら、そのアクセスキーを各 API リクエストのリクエストヘッダー「accesskey」の一部として Gainsight に渡す必要があります。アクセスキーには有効期限はありません。
ヘッダー
|
キー |
値 |
|---|---|
|
アクセスキー |
アクセスキーを生成する方法の詳細については、「認証」セクションを参照してください。 |
|
コンテンツタイプ |
JSON |
スロットリング制限
Gainsight APIの推奨API制限は次のとおりです（正確な制限はパッケージによって異なる場合があります）。
- 同期 API コール: 1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し
- 非同期 API 呼び出し (Gainsight API の一括呼び出し): 1 時間あたり 10 コール/1 日あたり 100 コール
メモ: 上記の API 制限はすべて*固定ウィンドウ速度制限です。
* 固定ウィンドウレート制限により、特定の時間の API リクエストの数が制限されます。たとえば、サーバーには、1 分あたり 100 件のリクエストしか受け付けない固定ウィンドウアルゴリズムを実装するレート制限コンポーネントを含めることができます。時間枠は固定されており、特定の時間に始まります。たとえば、サーバーは午前 10:00 から午前 10:01 までの間に 100 件のリクエストのみを処理します。
|
API |
レートリミット |
|---|---|
|
OMD の説明を取得 |
1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し |
|
OMD の説明を投稿 |
1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し |
|
ライトAPIコールOMDを取得 |
1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し |
|
ポストライト API コール OMD |
1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し |
OMD の説明を取得
この API は、オブジェクトの詳細と、オブジェクト名、ラベル、オブジェクトタイプ、labelPlural、KeyPrefix などの関連するオブジェクトの詳細を取得します。また、オブジェクトフィールドに関する次の情報もインポートされます。
- フィルター可能
- ソート可能
- グループ化可能
- 作成可能
- 更新可能
- フォーミュラフィールド
- hasLookup
- 必須
- リッチテキスト
- ビリング可能
- 読み取り専用
- dependentPicklist
- fieldGroupType
- セルフルックアップ
- 索引付き
- decimalPlaces
- 非表示
- 名前フィールド
- 説明
- 集約可能
エンドポイントのURL
https://<customer-domain>/v1/meta/services/objects/<Objectname>/describe?ic=true&cl=3&idd=true
リクエストのサンプル
<customer-domain>https:///v1/meta/services/objects/au...0__gc/describe? ci=mda&ic=true&cl=3&idd=true
パラメータ
|
パラメータ* |
データタイプ |
説明 |
|---|---|---|
|
ic |
ブール値 |
クエリー対象のオブジェクトの子オブジェクトを含めることを指すブール型フラグ。 |
|
cl |
番号 |
レスポンスが必要な子レベルを示す数値フラグ。 |
|
idd |
ブール値 |
選択リスト項目の選択リスト詳細を応答に含めるかどうかを定義するブール型フラグ。 |
|
ihc |
ブール値 |
非表示の列をレスポンスに含めるべきかどうかを定義するブール型フラグ。 |
応答成功のサンプル
{
"requestId": "e5bf297f-1d17-44a8-a8e4-f65cbc1f758d",
"result": true,
"data": [
{
"objectName": "customobj__gc",
"label": "customobj",
"objectType": "CUSTOM",
"labelPlural": "customobj",
"keyPrefix": "1Z02W6JH35Q2P6CU2K",
"fields": [
{
"fieldName": "Name__gc",
"label": "Name",
"dataType": "STRING",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "STRING"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": true,
"updateable": true,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": false,
"dependentPicklist": false,
"fieldGroupType": "CUSTOM",
"selfLookup": false,
"indexed": false,
"decimalPlaces": 0,
"length": 500,
"hidden": false,
"nameField": false,
"aggregatable": true
}
},
{
"fieldName": "Gsid",
"label": "GSID",
"dataType": "GSID",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "GSID"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"hidden": false,
"nameField": false,
"description": "Gainsight ID",
"aggregatable": true
}
},
{
"fieldName": "CreatedDate",
"label": "GS Created Date",
"dataType": "DATETIME",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "DATETIME"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"hidden": false,
"nameField": false,
"description": "Created Date",
"aggregatable": true
}
},
{
"fieldName": "ModifiedDate",
"label": "GS Modified Date",
"dataType": "DATETIME",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "DATETIME"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"hidden": false,
"nameField": false,
"description": "Modified Date",
"aggregatable": true
}
},
{
"fieldName": "CreatedBy",
"label": "GS Created By",
"dataType": "LOOKUP",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "GSID",
"SEARCH_CONTROLLER": "AUTO_SUGGEST"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": true,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"lookupDetail": {
"lookupName": "CreatedBy__gr",
"fieldName": "Gsid",
"fieldDBName": "gsid",
"fieldLabel": "GSID",
"lookupId": "67905b63-dc89-4d7f-a82d-14eaa88bfd76",
"lookupObjects": [
{
"id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
"objectName": "gsuser",
"dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
"label": "User",
"namedFieldDetails": {
"hidden": false,
"indexed": true,
"unique": false,
"format": null,
"defaultValue": null,
"primary": false,
"distinctMemberCount": 0,
"dimensionBrowserCollection": "SELF",
"groupName": null,
"measureValueBucket": null,
"alignment": "LEFT",
"aggFunction": "SUM",
"numberType": "NUMBER",
"decimalPlaces": 0,
"thousandSeparatorUsed": false,
"negativeNumber": "MINUSVALUE",
"systemDefined": false,
"encrypted": false,
"deleted": false,
"mappings": {
"GAINSIGHT": {
"key": "GS_USER_NAME",
"keys": null,
"dataType": "string",
"format": null,
"idField": null
}
},
"source": null,
"example": null,
"maxLength": null,
"options": null,
"type": null,
"properties": null,
"collectionId": null,
"calculatedExpression": null,
"hasLookup": false,
"lookupDetail": null,
"gdmFormulaColumn": false,
"gdmFreeFormEditor": false,
"required": false,
"editedColumn": false,
"newColumn": false,
"picklistItems": null,
"currencyList": null,
"operationType": null,
"referenceOperation": null,
"operations": null,
"controllerField": null,
"defaultStringValue": null,
"name": "gsd88574",
"DBName": "gsd88574",
"datatype": "string",
"complexType": null,
"colattribtype": "DIMENSION",
"DisplayName": "Name",
"formula": null,
"ColumnDescription": null,
"FieldSchemaEditabilityType": "Fixed",
"FieldDataEditabilityType": "All",
"FieldGroupType": "STANDARD",
"fieldName": "Name",
"isSelfLookupField": false,
"resolutionKeys": [],
"isSearchable": false,
"expression": null,
"isReferenceField": false,
"withTimeZone": false,
"isTracked": false,
"isCompressed": false,
"isNamedField": true,
"isPermissionAttribute": false,
"isAdvancedFormula": false
}
}
]
},
"hidden": false,
"nameField": false,
"description": "GS Created By",
"aggregatable": true,
"onDeleteOperation": "None"
}
},
{
"fieldName": "ModifiedBy",
"label": "GS Modified By",
"dataType": "LOOKUP",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "GSID",
"SEARCH_CONTROLLER": "AUTO_SUGGEST"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": true,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"lookupDetail": {
"lookupName": "ModifiedBy__gr",
"fieldName": "Gsid",
"fieldDBName": "gsid",
"fieldLabel": "GSID",
"lookupId": "b0dcf8b2-1c7b-4767-ab63-b803d92305ec",
"lookupObjects": [
{
"id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
"objectName": "gsuser",
"dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
"label": "User",
"namedFieldDetails": {
"hidden": false,
"indexed": true,
"unique": false,
"format": null,
"defaultValue": null,
"primary": false,
"distinctMemberCount": 0,
"dimensionBrowserCollection": "SELF",
"groupName": null,
"measureValueBucket": null,
"alignment": "LEFT",
"aggFunction": "SUM",
"numberType": "NUMBER",
"decimalPlaces": 0,
"thousandSeparatorUsed": false,
"negativeNumber": "MINUSVALUE",
"systemDefined": false,
"encrypted": false,
"deleted": false,
"mappings": {
"GAINSIGHT": {
"key": "GS_USER_NAME",
"keys": null,
"dataType": "string",
"format": null,
"idField": null
}
},
"source": null,
"example": null,
"maxLength": null,
"options": null,
"type": null,
"properties": null,
"collectionId": null,
"calculatedExpression": null,
"hasLookup": false,
"lookupDetail": null,
"gdmFormulaColumn": false,
"gdmFreeFormEditor": false,
"required": false,
"editedColumn": false,
"newColumn": false,
"picklistItems": null,
"currencyList": null,
"operationType": null,
"referenceOperation": null,
"operations": null,
"controllerField": null,
"defaultStringValue": null,
"name": "gsd88574",
"DBName": "gsd88574",
"datatype": "string",
"complexType": null,
"colattribtype": "DIMENSION",
"DisplayName": "Name",
"formula": null,
"ColumnDescription": null,
"FieldSchemaEditabilityType": "Fixed",
"FieldDataEditabilityType": "All",
"FieldGroupType": "STANDARD",
"fieldName": "Name",
"isSelfLookupField": false,
"resolutionKeys": [],
"isSearchable": false,
"expression": null,
"isReferenceField": false,
"withTimeZone": false,
"isTracked": false,
"isCompressed": false,
"isNamedField": true,
"isPermissionAttribute": false,
"isAdvancedFormula": false
}
}
]
},
"hidden": false,
"nameField": false,
"description": "GS Modified By",
"aggregatable": true,
"onDeleteOperation": "None"
}
}
],
"transactional": true,
"multiCurrencySupported": true,
"readable": true,
"createable": true,
"schemaUpdateable": true,
"description": "Custom object"
}
]
}
応答失敗のサンプル
{
"requestId": "b698e142-fa4a-4c38-aa75-7d0cc34f3098",
"result": false,
"instance": "2021-02-03 10:31:28 UTC",
"title": "OBJECT_NOT_FOUND",
"detail": 「要求されたオブジェクトが見つかりません。「、
"errorDesc": 「要求されたオブジェクトが見つかりません。「
}
OMD の説明を投稿
この API は、レスポンスをフィルタリングして特定のオブジェクトの詳細と関連するオブジェクトの詳細を取得するために使用されます。オブジェクト名、ラベル、オブジェクトタイプ、ラベル複数形、キープレフィックスなどのオブジェクトの詳細が表示されます。また、オブジェクトフィールドに関する次の情報もインポートされます。
- フィルター可能
- ソート可能
- グループ化可能
- 作成可能
- 更新可能
- フォーミュラフィールド
- hasLookup
- 必須
- リッチテキスト
- ビリング可能
- 読み取り専用
- dependentPicklist
- fieldGroupType
- セルフルックアップ
- 索引付き
- decimalPlaces
- 非表示
- 名前フィールド
- 説明
- 集約可能
エンドポイントのURL
https://<customer-domain>/v1/meta/services/objects/describe
http://localhost:8080/v1/meta/services/objects/describe
リクエストのサンプル
{
"objectNames": [
"customobj__gc"
],
"includeChilds": "true",
"childLevels": "0",
"populatePickListOptions": "true",
"useCollectionId": "false",
"removeDeleted": "false",
"removeHidden": "false",
"host": "MDA",
"sortFieldsByLabel": "true",
"populateFieldId": "false",
"honorUserContext": "true",
"honorCustomLookup": "true",
"populateAutoSuggestDetails": "true",
"externalContext": "false"
}
パラメータ
|
パラメータ* |
データタイプ |
説明 |
|---|---|---|
|
objectNames |
文字列 |
クエリするオブジェクト名のリストを含む文字列。 |
|
includeChilds |
ブール値 |
オブジェクトのサブリレーションシップをクエリに含めるかどうかを示すブール値。 |
|
childLevels |
番号 |
クエリー対象の親オブジェクトからレベルダウンする番号。 |
|
removeHidden |
ブール値 |
レスポンス内の隠しフィールドを削除するブール型フィールド。 |
|
includeDropDowns |
ブール値 |
選択リスト項目の選択リスト詳細を応答に含めるかどうかを定義するブール型フラグ。 |
応答成功のサンプル
{
"requestId": "154cc3d2-8f04-497a-8598-ea55781c47e8",
"result": true,
"data": [
{
"objectName": "customobj__gc",
"label": "customobj",
"objectType": "CUSTOM",
"labelPlural": "customobj",
"keyPrefix": "1Z02W6JH35Q2P6CU2K",
"fields": [
{
"fieldName": "Name__gc",
"label": "Name",
"dataType": "STRING",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "STRING"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": true,
"updateable": true,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": false,
"dependentPicklist": false,
"fieldGroupType": "CUSTOM",
"selfLookup": false,
"indexed": false,
"decimalPlaces": 0,
"length": 500,
"hidden": false,
"nameField": false,
"aggregatable": true
}
},
{
"fieldName": "Gsid",
"label": "GSID",
"dataType": "GSID",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "GSID"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"hidden": false,
"nameField": false,
"description": "Gainsight ID",
"aggregatable": true
}
},
{
"fieldName": "CreatedDate",
"label": "GS Created Date",
"dataType": "DATETIME",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "DATETIME"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"hidden": false,
"nameField": false,
"description": "Created Date",
"aggregatable": true
}
},
{
"fieldName": "ModifiedDate",
"label": "GS Modified Date",
"dataType": "DATETIME",
"objectName": "customobj__gc",
"meta": {
"properties": {
"sourceType": "DATETIME"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": false,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"hidden": false,
"nameField": false,
"description": "Modified Date",
"aggregatable": true
}
},
{
"fieldName": "CreatedBy",
"label": "GS Created By",
"dataType": "LOOKUP",
"objectName": "customobj__gc",
"meta": {
"properties": {
"autoSuggestDetails": {
"object": "gsuser",
"searchOn": [
"Name",
"Email"
],
"dataStore": "HAPOSTGRES",
"columnsToList": [
"Gsid"
],
"connectionType": "MDA",
"connectionId": "MDA"
},
"sourceType": "GSID",
"SEARCH_CONTROLLER": "AUTO_SUGGEST"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": true,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"lookupDetail": {
"lookupName": "CreatedBy__gr",
"fieldName": "Gsid",
"fieldDBName": "gsid",
"fieldLabel": "GSID",
"lookupId": "67905b63-dc89-4d7f-a82d-14eaa88bfd76",
"lookupObjects": [
{
"id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
"objectName": "gsuser",
"dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
"label": "User",
"namedFieldDetails": {
"hidden": false,
"indexed": true,
"unique": false,
"format": null,
"defaultValue": null,
"primary": false,
"distinctMemberCount": 0,
"dimensionBrowserCollection": "SELF",
"groupName": null,
"measureValueBucket": null,
"alignment": "LEFT",
"aggFunction": "SUM",
"numberType": "NUMBER",
"decimalPlaces": 0,
"thousandSeparatorUsed": false,
"negativeNumber": "MINUSVALUE",
"systemDefined": false,
"encrypted": false,
"deleted": false,
"mappings": {
"GAINSIGHT": {
"key": "GS_USER_NAME",
"keys": null,
"dataType": "string",
"format": null,
"idField": null
}
},
"source": null,
"example": null,
"maxLength": null,
"options": null,
"type": null,
"properties": null,
"collectionId": null,
"calculatedExpression": null,
"hasLookup": false,
"lookupDetail": null,
"gdmFormulaColumn": false,
"gdmFreeFormEditor": false,
"required": false,
"editedColumn": false,
"newColumn": false,
"picklistItems": null,
"currencyList": null,
"operationType": null,
"referenceOperation": null,
"operations": null,
"controllerField": null,
"defaultStringValue": null,
"name": "gsd88574",
"DBName": "gsd88574",
"datatype": "string",
"complexType": null,
"colattribtype": "DIMENSION",
"DisplayName": "Name",
"formula": null,
"ColumnDescription": null,
"FieldSchemaEditabilityType": "Fixed",
"FieldDataEditabilityType": "All",
"FieldGroupType": "STANDARD",
"fieldName": "Name",
"isSelfLookupField": false,
"resolutionKeys": [],
"isSearchable": false,
"expression": null,
"isReferenceField": false,
"withTimeZone": false,
"isTracked": false,
"isCompressed": false,
"isNamedField": true,
"isPermissionAttribute": false,
"isAdvancedFormula": false
}
}
]
},
"hidden": false,
"nameField": false,
"description": "GS Created By",
"aggregatable": true,
"onDeleteOperation": "None"
}
},
{
"fieldName": "ModifiedBy",
"label": "GS Modified By",
"dataType": "LOOKUP",
"objectName": "customobj__gc",
"meta": {
"properties": {
"autoSuggestDetails": {
"object": "gsuser",
"searchOn": [
"Name",
"Email"
],
"dataStore": "HAPOSTGRES",
"columnsToList": [
"Gsid"
],
"connectionType": "MDA",
"connectionId": "MDA"
},
"sourceType": "GSID",
"SEARCH_CONTROLLER": "AUTO_SUGGEST"
},
"filterable": true,
"sortable": true,
"groupable": true,
"createable": false,
"updateable": false,
"formulaField": false,
"hasLookup": true,
"required": false,
"richText": false,
"nillable": true,
"readOnly": true,
"dependentPicklist": false,
"fieldGroupType": "SYSTEM",
"selfLookup": false,
"indexed": true,
"decimalPlaces": 0,
"length": 220,
"lookupDetail": {
"lookupName": "ModifiedBy__gr",
"fieldName": "Gsid",
"fieldDBName": "gsid",
"fieldLabel": "GSID",
"lookupId": "b0dcf8b2-1c7b-4767-ab63-b803d92305ec",
"lookupObjects": [
{
"id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
"objectName": "gsuser",
"dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
"label": "User",
"namedFieldDetails": {
"hidden": false,
"indexed": true,
"unique": false,
"format": null,
"defaultValue": null,
"primary": false,
"distinctMemberCount": 0,
"dimensionBrowserCollection": "SELF",
"groupName": null,
"measureValueBucket": null,
"alignment": "LEFT",
"aggFunction": "SUM",
"numberType": "NUMBER",
"decimalPlaces": 0,
"thousandSeparatorUsed": false,
"negativeNumber": "MINUSVALUE",
"systemDefined": false,
"encrypted": false,
"deleted": false,
"mappings": {
"GAINSIGHT": {
"key": "GS_USER_NAME",
"keys": null,
"dataType": "string",
"format": null,
"idField": null
}
},
"source": null,
"example": null,
"maxLength": null,
"options": null,
"type": null,
"properties": null,
"collectionId": null,
"calculatedExpression": null,
"hasLookup": false,
"lookupDetail": null,
"gdmFormulaColumn": false,
"gdmFreeFormEditor": false,
"required": false,
"editedColumn": false,
"newColumn": false,
"picklistItems": null,
"currencyList": null,
"operationType": null,
"referenceOperation": null,
"operations": null,
"controllerField": null,
"defaultStringValue": null,
"name": "gsd88574",
"DBName": "gsd88574",
"datatype": "string",
"complexType": null,
"colattribtype": "DIMENSION",
"DisplayName": "Name",
"formula": null,
"ColumnDescription": null,
"FieldSchemaEditabilityType": "Fixed",
"FieldDataEditabilityType": "All",
"FieldGroupType": "STANDARD",
"fieldName": "Name",
"isSelfLookupField": false,
"resolutionKeys": [],
"isSearchable": false,
"expression": null,
"isReferenceField": false,
"withTimeZone": false,
"isTracked": false,
"isCompressed": false,
"isNamedField": true,
"isPermissionAttribute": false,
"isAdvancedFormula": false
}
}
]
},
"hidden": false,
"nameField": false,
"description": "GS Modified By",
"aggregatable": true,
"onDeleteOperation": "None"
}
}
],
"transactional": true,
"multiCurrencySupported": true,
"readable": true,
"createable": true,
"schemaUpdateable": true,
"description": "Custom object"
}
]
}
ライトAPIコールOMDを取得
この API は、以下の最小限のメタデータ情報を含むオブジェクトのリストを取得するために使用されます。
- objectName
- ラベル
- objectType
- keyPrefix
- トランザクショナル
- multiCurrencySupported
- 読みやすい
- 作成可能
- schemaUpdateable
応答成功のサンプル
{
"requestId": "7ac6a2e6-85ac-44df-958a-ee4b00384436",
"result": true,
"data": [
{
"objectName": "autoindex10__gc",
"label": "AutoIndex10",
"objectType": "CUSTOM",
"keyPrefix": "1Z02KRI7NHRRVF6ZWJ",
"transactional": true,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "company",
"label": 「Company",
"objectType": "STANDARD",
"keyPrefix": "1P02C503CKNHR9B14K",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "company_person",
"label": 「会社員」
"objectType": "STANDARD",
"keyPrefix": "1C01TEHFH1FP2KG5WQ",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "email_logs",
"label": "Email Logs",
"objectType": "STANDARD",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "email_raw_events",
"label": 「未処理イベントをメールで送信」,
"objectType": "SYSTEM",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": false,
"schemaUpdateable": false
},
{
"objectName": "obj1__gc",
"label": "Obj1",
"objectType": "CUSTOM",
"keyPrefix": "1Z024OYZBEOENYQ9RH",
"transactional": true,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "relationship",
"label": "Relationship",
"objectType": "STANDARD",
"keyPrefix": "1P05VX75GX1CCNZ59W",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "relationship_person",
"label": 「リレーションシップパーソン」
"objectType": "STANDARD",
"keyPrefix": "1C03FQDZ4TJLWHYROF",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "sponsor_tracking",
"label": 「スポンサートラッキング」,
"objectType": "STANDARD",
"keyPrefix": "1S075PAB66AVNGO818Y",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": false,
"schemaUpdateable": true
},
{
"objectName": "gsuser",
"label": "User",
"objectType": "STANDARD",
"keyPrefix": "1P01N68IASVWNJD6IE",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "user_shared_detail",
"label": 「ユーザー共有詳細」,
"objectType": "STANDARD",
"keyPrefix": "P02",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": false,
"schemaUpdateable": true
}
]
}
応答失敗のサンプル
{
"requestId": "7007e23f-e5c7-4381-995a-86cba5635c19",
"result": false,
"instance": "2021-02-03 10:32:50 UTC",
"title": "PARENT_OBJECT_NOT_FOUND",
"detail": 「親オブジェクトが見つからない、またはオブジェクトが無効です」,
"errorDesc": 「親オブジェクトが見つからない、またはオブジェクトが無効です」
}
ポストライト API コール OMD
このAPIは、必要なオブジェクトをフィルタリングすることにより、最小限のメタデータ情報で特定のオブジェクトのリストを取得するために使用されます。次のオブジェクト詳細を取得します。
- objectName
- ラベル
- objectType
- keyPrefix
- トランザクショナル
- multiCurrencySupported
- 読みやすい
- 作成可能
- schemaUpdateable
リクエストのサンプル
{
"externalUse":"true",
"parentObject":"company",
"excludeMappings":"false",
"sortByLabel":"false"
}
応答成功のサンプル
{
"requestId": "ec934e17-5420-4221-80fc-97655e8e750b",
"result": true,
"data": [
{
"objectName": "anonymous_person",
"label": "Anonymous Person",
"objectType": "STANDARD",
"keyPrefix": "1C02M7XRJCBG6QI6SV",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": true,
"schemaUpdateable": true
},
{
"objectName": "user_shared_detail",
"label": 「ユーザー共有詳細」,
"objectType": "STANDARD",
"keyPrefix": "P02",
"transactional": false,
"multiCurrencySupported": false,
"readable": true,
"createable": false,
"schemaUpdateable": true
}
]
}