Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.99 KB

import_common_template.md

File metadata and controls

59 lines (45 loc) · 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