作成¶
POST /api/v1/objc_cfg/create
概要¶
リソースカタログ設定を作成します。
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| sourceType | string | Y | ソースタイプ、デフォルト値は custom_object空の値を許可: False 例: custom_object 選択可能な値: ['object', 'custom_object'] |
| objcGroupUUID | string | ビジネスグループ UUID 空の値を許可: False 例: objcg_xxxx 空文字列を許可: True 最大長: 64 |
|
| fields | array | カスタム属性フィールド（報告されるデータにこれらのフィールドが必ず含まれている必要があります。含まれていない場合、報告されたデータは破棄されます） 空の値を許可: False 例: [{'name': 'ak', 'alias': '機関銃'}] |
|
| templateInfo | json | テンプレート設定情報 空の値を許可: False 例: {} |
パラメータ補足説明¶
fields パラメータ説明
このパラメータはリスト形式でバインドされたフィールド情報を格納します。リストメンバーのパラメータは次のとおりです。
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| name | string | フィールド名 |
| alias | string | フィールドエイリアス |
templateInfo パラメータ説明
詳細な構造の説明は、【リソースエクスプローラーを作成 - JSON 設定 - テンプレート設定説明】を参照してください。
1. source パラメータ説明 リソースの所属クラスと、そのクラスが UI ページに表示するテキスト内容を定義します。リストメンバーのパラメータは次のとおりです。
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| key | string | リソースクラス |
| name | string | リソースクラスのエイリアス |
2. filters パラメータ説明 リソースエクスプローラーのクイックフィルターにデフォルトで表示されるフィールドを定義します。形式は次のとおりです。
3. columns パラメータ説明 リソースエクスプローラーのリストにデフォルトで表示されるフィールドを定義します。形式は次のとおりです。
4. views パラメータ説明
| パラメータ | 必須 | 説明 | 記述例 |
|---|---|---|---|
| title | / | タブの表示タイトル | 「テキスト」 |
| required | false | タブページを表示しないかどうか。固定値：true、false。
|
「false」 |
| keys | / | required パラメータと連携。キーフィールドとフィールド値のマッチングロジックを設定可能。マッチングした場合に表示。注意：このパラメータを使用する場合、required パラメータの値は true である必要があります。 |
|
| timerange | default | インターフェースのデータクエリ時間範囲の定義。基本形式：
|
|
| viewType | / | ページタイプ。現在は「組み込みページ」と「組み込みビュー」の 2 タイプをサポート。それぞれ "component" と "dashboard" に対応。 | / |
| viewName | / | ページ名。ページタイプが組み込みページの場合は、ページの相対パスを入力。ページタイプが組み込みビューの場合は、ビュー名を入力。以下の【組み込みページの関連付け】【組み込みビューの関連付け】の説明を参照。 | / |
5. templateInfo パラメータ例
{
"main": [
{
"class":"custom_object",
"source": {
"key":"リソースクラス",
"name":"リソースクラスのエイリアス"
},
"filters":[
{
"key":"フィールド名"
},
{
"key":"フィールド名"
}
],
"table":{
"columns":[
{
"key":"フィールド名",
},
{
"key":"フィールド名",
}
],
},
"detail":{
"views":[
{
"title":"タブタイトル",
"required":"false",
"keys":{},
"view_type": "component",
"viewName":"組み込みページ"
},
{
"title":"タブタイトル",
"required":"false",
"keys":{},
"timerange":"default",
"view_type": "dashboard",
"viewName":"組み込みビュー"
}
]
}
}
],
"title": "リソースクラスまたはエイリアス"
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/objc_cfg/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"sourceType":"custom_object","objcGroupUUID":"objcg_xxxx","fields":[{"name":"name"}],"templateInfo":{"main":[{"class":"custom_object","source":{"key":"test","name":""},"filters":[],"fills":[],"groups":[],"table":{"columns":[],"detail":{"views":[{"keys":{},"viewType":"dashboard","viewName":"NtpQ Monitor View","title":"viewer","required":true,"timerange":"default"}]}}}],"title":"test"}}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"sourceType": "custom_object",
"name": "test",
"alias": "",
"workspaceUUID": "wksp_xxxx",
"objcGroupUUID": "objcg_xxx",
"dashboardBindSet": [],
"fields": [
{
"name": "name"
}
],
"extend": {
"fills": [],
"groups": [],
"columns": [],
"filters": [],
"iconSet": {},
"tableDetailViews": [
{
"keys": {},
"viewType": "dashboard",
"viewName": "NtpQ Monitor View",
"title": "viewer",
"required": true,
"timerange": "default"
}
]
},
"id": 260,
"uuid": "objc_xxxx",
"status": 0,
"creator": "acnt_xxxx",
"updator": "acnt_xxxx",
"createAt": 1734576782,
"deleteAt": -1,
"updateAt": 1734590084.4779553
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "96555412482790535"
}