docs/apidoc/en/import_common_template.md · 1a1zy/bk-sops - Gitee.com

forked from 腾讯蓝鲸智云 / bk-sops

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

import_common_template.md 1.99 KB

### Functional description

import common flow template

### Request Parameters

#### General Parameters

|   Field         |  Type       | Required |  Description    |
|-----------------|-------------|---------|------------------|
|   bk_app_code   |   string    |   YES    |  APP ID |
|   bk_app_secret |   string    |   YES    |  APP Secret(APP TOKEN), which can be got via BlueKing Developer Center -> Click APP ID -> Basic Info |
|   bk_token      |   string    |   NO     |  Current user login token, bk_token or bk_username must be valid, bk_token can be got by Cookie      |
|   bk_username   |   string    |   NO     |  Current user username, APP in the white list, can use this field to specify the current user        |

#### Interface Parameters

| Field          |  Type       | Required   |  Description             |
| ------------ | ------------ | ------ | ---------------- |
|   template_data    |   string     |   YES   |  flow data, the content of file which download from bk-sops - common templates - export |
|   override        | bool     | NO         | whether to override flows which has same ID           |           |

### Request Parameters Example

```
{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "template_data": "xxx",
    "override": true
}
```

### Return Result Example

```
{
    "message": "Successfully imported 2 common flows",
    "data": {
        "count": 2
    },
    "result": true
}
```

### Return Result Description

| Field      | Type      | Description      |
| ------------  | ---------- | ------------------------------ |
|  result   |    bool    |      true or false, indicate success or failure   |
|  message  |    string  |      error message returned when result is false  |
|  data         | dict        |    return data                |

#### data

| Field      | Type      | Description      |
| ------------ | ---------- | ------------------------------ |
|  count      |    int    |       the number of flows had been imported    |

一键复制原始数据按行查看历史

提交于 2019-07-16 22:09 . docs: 版本号升级到V3.3.18

Functional description

import common flow template

Request Parameters

General Parameters

Field	Type	Required	Description
bk_app_code	string	YES	APP ID
bk_app_secret	string	YES	APP Secret(APP TOKEN), which can be got via BlueKing Developer Center -> Click APP ID -> Basic Info
bk_token	string	NO	Current user login token, bk_token or bk_username must be valid, bk_token can be got by Cookie
bk_username	string	NO	Current user username, APP in the white list, can use this field to specify the current user

Interface Parameters

Field	Type	Required	Description
template_data	string	YES	flow data, the content of file which download from bk-sops - common templates - export
override	bool	NO	whether to override flows which has same ID

Request Parameters Example

{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "template_data": "xxx",
    "override": true
}

Return Result Example

{
    "message": "Successfully imported 2 common flows",
    "data": {
        "count": 2
    },
    "result": true
}

Return Result Description

Field	Type	Description
result	bool	true or false, indicate success or failure
message	string	error message returned when result is false
data	dict	return data

data

Field	Type	Description
count	int	the number of flows had been imported

Python

1

https://gitee.com/thiefz/bk-sops.git

git@gitee.com:thiefz/bk-sops.git

thiefz

bk-sops

bk-sops

master