Content Comparison

...

Paste code macro

language	http
theme	Sunburst

POST https://${CloudVendor}.${CountryCode}.machlake.com/v1/lakes/${lake_id}/tags
 
{
    "tag" : [["{tag_name}", {additional value 1}, "{additional value 2}"], [ second tag values ], ...]
}

...

Request Example

Paste code macro

language	jsonhttp
theme	Sunburst

POST https://aws1.us.machlake.com/v1/lakes/xbacd1234/tags

{
    "tag" : [["newtag01"], ["newtag02"]]
}

...

Paste code macro

language	json
theme	Sunburst

Status 200
 
{
    "success": true,
    "statusreason" : "create tag success",
    "data"   : {
        "success_count": 2,
        "tag": [
            {"name": "newtag01"},
            {"name": "newtag02"}
        ]
    }
}

...

# Text Encoding to UTF-8 in CMD # Example For Create Tag API by using curl in ubuntu # written by yeony kim API_KEY=YOUR_API_TOKEN CONTENT_HEADER=Content-Type:application/json API_HEADER=x-api-key:$API_KEY LAKE_ID=YOUR_LAKE_ID URL=https://$LAKE_ID.machlake.com/lakes/tags # ------------------------------------------------------------------------------------------------- # # CASE - create TAG curl -k -X POST $URL -H $CONTENT_HEADER -H $API_HEADER --data "{\"tag\": [[\"sensor1\"], [\"sensor2\"]]}" # Return Format # {"data":{"success_count":2,"tag":[{"name":"sensor1"},{"name":"sensor2"}]},"status":"success"} # ------------------------------------------------------------------------------------------------- # # CASE - tag duplicate error curl -k -X POST $URL -H $CONTENT_HEADER -H $API_HEADER --data "{\"tag\": [[\"sensor1\"], [\"sensor2\"]]}" # Return Format / Example For Exist same tag name in lake # {"message":"Metadata key (sensor2) of TAGDATA table is already inserted.","status":"error"} #

Expand

title	Window(Batch)

github

Code Block

chcp 65001 
:: Text Encoding to UTF-8 in CMD
:: Example For Create Tag API by using curl in window script
:: written by yeony kim

set API_KEY=YOUR_API_TOKEN_KEY
set LAKE_ID=YOUR_LAKE_ID
set CLOUD_VENDOR=YOUR_CLOUD_VENDOR
set CLOUD_REGION=YOUR_CLOUD_REGION

set CONTENT_HEADER="Content-Type: application/json"
set API_HEADER="x-api-key: %API_KEY%"
set LAKE_ID=YOUR_LAKE_ID

set URL=URL="https://%LAKE_ID%%CLOUD_VENDOR%.%CLOUD_REGION%.machlake.com/v1/lakes/%LAKE_ID%/tags"

:: ------------------------------------------------------------------------------------------------- ::

:: CASE - create TAG

curl:: -kdata -Xformat
POST:: %URL%{
-H %CONTENT_HEADER% -H %API_HEADER% --data "{\"tag\": [[\"sensor1\"], [\"sensor2\"]]}"::     "tag":[
::         ["sensor1"], 
:: Return      Format :: {["datasensor2":{"success_count":2,"tag":[{"name":"sensor1"},{"name":"sensor2"}]},"status":"success"}

:: ------------------------------------------------------------------------------------------------- ::

:: CASE - tag duplicate error

curl -k -X POST %URL% -H %CONTENT_HEADER% -H %API_HEADER% --data "{\"tag\": [[\"sensor1\"], [\"sensor2\"]]}"

:: Return Format / Example For Exist same tag name in lake
:: {"message":"Metadata key (sensor2) of TAGDATA table is already inserted.","status":"error"}

]
::     ]
:: }

curl -k -X POST %URL% -H %CONTENT_HEADER% -H %API_HEADER% --data "{\"tag\": [[\"sensor1\"], [\"sensor2\"]]}"

:: Return Format
:: {
::     "success":true,
::     "reason":"create tag success",
::     "data":{
::         "success_count":2,
::         "tag":[
::             {"name":"sensor1"},
::             {"name":"sensor2"}
::         ]
::     }
:: }

:: ------------------------------------------------------------------------------------------------- #
::

Expand

title	Linux(Shell)

github

Code Block


:: CASE - Create Tag with addition columns
:: columns
:: name (varchar, 80), location (varchar, 40)

:: data format
:: {
::     "tag":[
::         ["sensor01", "3F-101"],
::         ["sensor02", "3F-102"]
::     ]
:: }

curl -k -X POST %URL% -H %CONTENT_HEADER% -H %API_HEADER% -d "{\"tag\":[[\"sensor01\",\"3F-101\"],[\"sensor02\",\"3F-102\"]]}"

:: Return Format
:: {
::     "success":true,
::     "reason":"create tag success",
::     "data":{
::         "success_count":2,
::         "tag":[
::             {
::                 "location":"3F-101",
::                 "name":"sensor01"
::             },
::             {
::                 "location":"3F-102",
::                 "name":"sensor02"
::             }
::         ]
::     }
:: }

:: ------------------------------------------------------------------------------------------------- #

Expand

title	javascript

github

Code Block

language	js

//

Example

For

::

Create

CASE

Tag

API

Create

by

exist

using

Tag

request

in

::

nodejs

data

//

format

written

::

by

yeony

::

kim

process.env.NODE_TLS_REJECT_UNAUTHORIZED

=

"0"; const express = require('express'); const app = express(); const API_KEY = "YOUR_API_TOKEN"; const LAKE_ID = "YOUR_LAKE_ID" const URL = "https://" + LAKE_ID + ".machlake.com/lakes/tags"; // CASE - create TAG / tag duplicate error app.get( '/create_tag_sensor1_2', function(req, res) { const Data = { tag: [['sensor1'], ['t_sensor1'], ['t_sensor2']], } var request = require('request'); var option = { url: URL, headers: {

"tag":[["sensor1"]]
:: }

curl -k -X POST %URL% -H %CONTENT_HEADER% -H %API_HEADER% -d "{\"tag\":[[\"sensor1\"]]}"

:: Return Format
:: status code:400 Bad Request
:: {
::     "success":false,
::     "reason":"Metadata key (sensor1) of TAGDATA table is already inserted."
:: }

""" Example For Create Tag API by using request in python written by yeony kim sensor1, sensor2 is applied in lake """ import requests API_KEY = "YOUR_API_TOKEN" LAKE_ID = "YOUR_LAKE_ID" URL = f"https://{LAKE_ID}.machlake.com/lakes/tags" # CASE - create TAG / tag duplicate error headers = { 'Content-Type': 'application/json', 'x-api-key': API_KEY }

Expand

title	Linux(Shell)

github

Code Block

language	bash

# Text Encoding to UTF-8 in CMD
# Example For Create Tag API by using curl in ubuntu

LAKE_ID=$YOUR_LAKE_ID
API_KEY=$YOUR_API_KEY
CLOUD_VENDOR=$YOUR_CLOUD_VENDOR
CLOUD_REGION=$YOUR_CLOUD_REGION

CONTENT_HEADER=Content-Type:application/json
API_HEADER=x-api-key:$API_KEY
URL=https://${CLOUD_VENDOR}.${CLOUD_REGION}.machlake.com/v1/lakes/${LAKE_ID}/tags

# ------------------------------------------------------------------------------------------------- #

# CASE - Create Tag

# data format
# {
#     "tag":[
#         ["sensor1"], 
#

'Content-Type':

'application/json',

     ["sensor2"]
#     ]
# }

curl -k

'x-api-key': API_KEY },

-X POST $URL -H $CONTENT_HEADER -H $API_HEADER -d "{\"tag\":[[\"sensor1\"], [\"sensor2\"]]}"

# Return Format
# {
#

body: JSON.stringify(Data)

"success":true,
#     "reason":"create tag success",
#

};

   "data":{
#

request.post(

option, function(error, response, body) {

   "success_count":2,
#         "tag":[
#

if

(!error)

{

       {"name":"sensor1"},
#

res.writeHead(200);

    {"name":"sensor2"}
#         ]
#

res.end(body);

   }
# }

console.log(body) // {"data":{"success_count":2,"tag":[{"name":"sensor1"},{"name":"sensor2"}]},"status":"success"} or {"message":"Metadata key (sensor2) of TAGDATA table is already inserted.","status":"error"} } else {

# ------------------------------------------------------------------------------------------------- #

# CASE - Create Tag with addition columns
# columns
# name (varchar, 80), location (varchar, 40)

# data format
# {
#     "tag":[
#

console.log(error)

 ["sensor01", "3F-101"],
#

}

["sensor02", "3F-102"]
#     ]

# }

)



curl -k -X

} ) app.listen(8888, function() { console.log('http://127.0.0.1:8888/create_tag_sensor1_2 is result for create sensor1 and sensor2 tag') })

Expand

title	python

github

Code Block

language	py

POST $URL -H $CONTENT_HEADER -H $API_HEADER -d "{\"tag\":[[\"sensor01\",\"3F-101\"],[\"sensor02\",\"3F-102\"]]}"

# Return Format
# {
#     "success":true,
#     "reason":"create tag success",
#     "data":{
#         "success_count":2,
#         "tag":[
#             {
#                 "location":"3F-101",
#                 "name":"sensor01"
#             },
#             {
#                 "location":"3F-102",
#                 "name":"sensor02"
#             }
#         ]
#     }
# }

# ------------------------------------------------------------------------------------------------- #

# CASE - Create exist Tag

# data format
# {
#     "tag":[["sensor1"]]
# }

curl -k -X POST $URL -H $CONTENT_HEADER -H $API_HEADER -d "{\"tag\":[[\"sensor1\"]]}"

# Return Format
# status code:400 Bad Request
# {
#     "success":false,
#     "reason":"Metadata key (sensor1) of TAGDATA table is already inserted."
# }

Expand

title	javascript

github

Code Block

language	js

// Example For Create Tag API by using request in nodejs
// written by yeony kim

// process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

const API_KEY = "YOUR_API_TOKEN";
const LAKE_ID = "YOUR_LAKE_ID"
const CLOUD_VENDOR="CLOUD_VENDOR";
const CLOUD_REGION="CLOUD_REGION";
const URL =  `https://${CLOUD_VENDOR}.${CLOUD_REGION}.machlake.com/v1/lakes/${LAKE_ID}/tags`;


var request = require('request');


/* ------------------------------------------------------------------------------------------------- */

//  CASE - create TAG

var Data = {
    tag: [
        ["sensor1"], 
        ["sensor2"]
    ]
}

request.post({
    url: URL, 
    headers: {
        "Content-Type": "application/json",
        "x-api-key": API_KEY
    },
    body: JSON.stringify(Data)
    }, 
    function(error, response, body) {
        console.log(body);
        // Return Format
        // {
        //     "success":true,
        //     "reason":"create tag success",
        //     "data":{
        //         "success_count":2,
        //         "tag":[
        //             {"name":"sensor1"},
        //             {"name":"sensor2"}
        //         ]
        //     }
        // }
    })

/* ------------------------------------------------------------------------------------------------- */

//  CASE - create TAG with addition columns

var Data = {
    tag: [
        ["sensor01", "3F-101"],
        ["sensor02", "3F-102"]
    ]
}

request.post({
    url: URL, 
    headers: {
        "Content-Type": "application/json",
        "x-api-key": API_KEY
    },
    body: JSON.stringify(Data)
    }, 
    function(error, response, body) {
        console.log(body);
        // Return Format
        // {
        //     "success":true,
        //     "reason":"create tag success",
        //     "data":{
        //         "success_count":2,
        //         "tag":[
        //             {
        //                 "location":"3F-101",
        //                 "name":"sensor01"
        //             },
        //             {
        //                 "location":"3F-102",
        //                 "name":"sensor02"
        //             }
        //         ]
        //     }
        // }        
    })

/* ------------------------------------------------------------------------------------------------- */

//  CASE - Create exist Tag

var Data = {
    tag: [
        ["sensor1"]
    ]
}

request.post({
    url: URL, 
    headers: {
        "Content-Type": "application/json",
        "x-api-key": API_KEY
    },
    body: JSON.stringify(Data)
    }, 
    function(error, response, body) {
        console.log(body);
        // Return Format
        // status code:400 Bad Request
        // {
        //     "success":false,
        //     "reason":"Metadata key (sensor1) of TAGDATA table is already inserted."
        // }
    })

Expand

title	python

github

Code Block

language	py

"""
Example For Create Tag API by using request in python
written by yeony kim
"""

import requests

API_KEY = "YOUR_API_TOKEN"
LAKE_ID = "YOUR_LAKE_ID"
CLOUD_VENDOR="CLOUD_VENDOR"
CLOUD_REGION="CLOUD_REGION"

URL = f"https://{CLOUD_VENDOR}.{CLOUD_REGION}.machlake.com/v1/lakes/{LAKE_ID}/tags"

headers = {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
}


# ------------------------------------------------------------------------------------------------- #

# CASE - Create Tag

params = {
    "tag": [
        ["sensor1"], 
        ["sensor2"]
    ]
}

response = requests.post(URL, headers=headers,  json=params, verify=False)
print(response.content.decode("utf-8")) 

# Return Format
# {
#     "success":true,
#     "reason":"create tag success",
#     "data":{
#         "success_count":2,
#         "tag":[
#             {"name":"sensor1"},
#             {"name":"sensor2"}
#         ]
#     }
# }

# ------------------------------------------------------------------------------------------------- #

# CASE - Create Tag with addition columns
# columns
# name (varchar, 80), location (varchar, 40)

params = {
    "tag":[
        ["sensor01", "3F-101"],
        ["sensor02", "3F-102"]
    ]
}

response = requests.post(URL, headers=headers,  json=params, verify=False)
print(response.content.decode("utf-8")) 

# Return Format
# {
#     "success":true,
#     "reason":"create tag success",
#     "data":{
#         "success_count":2,
#         "tag":[
#             {
#                 "location":"3F-101",
#                 "name":"sensor01"
#             },
#             {
#                 "location":"3F-102",
#                 "name":"sensor02"
#             }
#         ]
#     }
# }

# ------------------------------------------------------------------------------------------------- #

# CASE - Create exist Tag

params = {

'

"tag

'

": [

['sensor1'], ['sensor2']],


        ["sensor1"]
    ]
}

response = requests.post(URL, headers=headers,  json=params, verify=False)
print(response.content.decode(

'

"utf-8

'

")) 

# Return Format
# status code:400 Bad Request
# {
#

#

{

data":{"

success

_count

":

2,"tag

false,
#     "reason":

[{"name":"sensor1"},{"name":"sensor2"}]},"status":"success"}

"Metadata key (sensor1) of TAGDATA table is already inserted."
# }

Version	Old Version 12	New Version Current
Changes made by	Andrew Kim	machlake
Saved on	Aug 01, 2022	Feb 21, 2023

Versions Compared

Key

Request Example