Instructions for use #

This OpenAPI provides you with the ability to create tags based on uploaded files. Currently, it is not supported to append or modify created tags.

Request description #

Path:/openapi/v1/app/{app_id}/tag
Method: POST
Content-type: application/json

Request parameters #

Path-parameters: Just refer to the public parameters
Body:

{
    "name": "tag_test_tag",  # "name" must start with "tag_"
    "show_name": "test tag",
    "value_type": "string",
    "description": "",
    "create_type": "upload",
    "refresh_rule": "manual",
    "tag_rule": {
        "file": {
            "file_key": "tag_upload_uuid/164314/20220527/564b19debe5a448396504802ab5ea69a.json",  # file_key 需要和上传标签数据得到的返回结果一致
            "detail": {
                "name": "user_tag.csv"
            }
        }
    }
}

Field meaning description

Back to example #

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "tag_name": "tag_test_tag"
    },
    "total_execute_time": null
}

Field meaning description

Request example #

Bc is the RangersClient created. For its initialization, please refer to the "OpenAPI SDK Instructions". SDKs in various languages provide similar interfaces.
Call (Python):

method = 'POST'
service_url = '/datatag/openapi/v1/app/164314/tag'
body = {
    "name": "tag_test_tag", 
    "show_name": "test tag",
    "value_type": "string",
    "description": "",
    "create_type": "upload",
    "refresh_rule": "manual",
    "tag_rule": {
        "file": {
            "file_key": "tag_upload_uuid/164314/20220527/564b19debe5a448396504802ab5ea69a.json",
            "detail": {
                "name": "user_tag.csv"
            }
        }
    }
}
resp = bc.request(method=method, service_url=service_url, body=body)
print(resp.content.decode('utf-8'))

Call (Java):

String method = "POST";
String serviceUrl = "/datatag/openapi/v1/app/164314/tag";
HashMap<String, String> headers = null;
HashMap<String, String> params = null;
String body = "{\n" +
        "    \"name\": \"tag_test_tag\",\n" +
        "    \"show_name\": \"test tag\",\n" +
        "    \"value_type\": \"string\",\n" +
        "    \"description\": \"\",\n" +
        "    \"create_type\": \"upload\",\n" +
        "    \"refresh_rule\": \"manual\",\n" +
        "    \"tag_rule\": {\n" +
        "        \"file\": {\n" +
        "            \"file_key\": \"tag_upload_uuid/164314/20220527/564b19debe5a448396504802ab5ea69a.json\",\n" +
        "            \"detail\": {\n" +
        "                \"name\": \"user_tag.csv\"\n" +
        "            }\n" +
        "        }\n" +
        "    }\n" +
        "}";

String resp = bc.request(method, serviceUrl, headers, params, body);
System.out.println(resp);

Back to example #

Return result:

{
    "code": 200,
    "message": "success",
    "data": {
        "tag_name": "tag_test_tag"
    },
    "total_execute_time": null
}