15. Endpoint Tags

This page contains all documentation under this Postman category.

Additional usage notes

endpointId should be sourced via GET Endpoint or from the Create Endpoint response.
Endpoint Tags allow logical classification and grouping of endpoints for operational and reporting purposes.

Tag - Create

Path: Endpoint Tags / Tag - Create

Method: POST

URL: https://sft.bics.com/api/createTag

Description

This API will be used to create one or multiple Tags for endpoints. Only enterprises can create Tag.

A tag can be attached to an endpoint with separate actions..

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
tagInfo	M	Tag details

Input tag Info Parameters

Field	Optional/ Mandatory	Description
createTag	M	Create Tag details

Input Tag Parameters

Field	Optional/ Mandatory	Description
tagName	M	Object of the Tag Name <br>Note: Tag Name field will allow maximum 100 character. Special characters are not allowed except hyphen(-) and underscore(_).
tagDescription	O	Object of the Tag Description <br>Note: Tag Description field will allow maximum 100 character. Special characters are not allowed except hyphen(-) and underscore(_)

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
tagId	O	Tag Id

Output ResultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
10149	Create Tag success
10150	Create Tag failure
10157	Failure..! Duplicate parameter- tagName in request
10120	Maximum number of tag is reached

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "tagInfo":{  
            "createTag": [
                {
                  "tagName": "Enterprise_Tags",
                  "tagDescription": "This is my tag description TAG1"
                },
                {
                  "tagName": "Enterprise_tag1",
                  "tagDescription": "This is my tag description TAG2"
                }
              ]
       }
}

Response Examples

Create -Tag- Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10149",
            "resultDescription": "Create Tag success"
        },
        "resultCode": "0",
        "responseId": "9039702343478319",
        "responseTimestamp": "28/09/2022 02:01:03",
        "tagId": "2885001,2890001"
    }
}

Create - Tag - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10150",
            "resultDescription": "Create Tag failure"
        },
        "resultCode": "1",
        "responseId": "9039040856456868",
        "responseTimestamp": "28/09/2022 01:50:01"
    }
}

Create - Tag - Failure - {Failure..! Duplicate parameter- tagName in request} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10157",
            "resultDescription": "Failure..! Duplicate parameter- tagName in request"
        },
        "resultCode": "1",
        "responseId": "9039839913917503",
        "responseTimestamp": "28/09/2022 02:03:20"
    }
}

Tag - Modify

Path: Endpoint Tags / Tag - Modify

Method: PATCH

URL: https://sft.bics.com/api/modifyTag

Description

This API will be used to modify existing endpoint Tags. You can modify one or multiple tags with the same API call. Use tagId to define which tag you wish to edit. You can change tagName or/and tagDescription.

Use Get Tag to find the available tagId

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
tagInfo	M	Object of tag info details

Input edit Tag Parameters

Field	Optional/ Mandatory	Description
editTag	M	Edit Tag details

Input edit Tag Parameters

Field	Optional/Mandatory	Description
tagId	M	Tag Id
tagName	O	Tag Name <br>Note: Tag Name field will allow maximum 100 characters. Special characters are not allowed except hyphen(-) and underscore(_)
tagDescription	O	Tag Description <br>Note: Tag Description field will allow maximum 100 characters. Special characters are not allowed except hyphen(-) and underscore(_).

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
10155	Modify Tag success
10156	Modify Tag failure
10120	Maximum number of tag is reached

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{
	"tagInfo": {
		"editTag": [{
				"tagId": "2890001",
				"tagName": "customer Enterprise_tag1",
                "tagDescription": "This is my tag description"
			},
            {
				"tagId": "2885001",
				"tagName": "customer Enterprise_tag2",
                "tagDescription": "This is my tag description"
			}

		]
	}
}

Response Examples

Modify - Tag - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10155",
            "resultDescription": "Modify Tag success"
        },
        "resultCode": "0",
        "responseId": "9041707442997558",
        "responseTimestamp": "28/09/2022 02:34:29"
    }
}

Modify - Tag - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10156",
            "resultDescription": "Modify Tag failure"
        },
        "resultCode": "1",
        "responseId": "9041661245993845",
        "responseTimestamp": "28/09/2022 02:33:42"
    }
}

Tag - Get

Path: Endpoint Tags / Tag - Get

Method: GET

URL: https://sft.bics.com/api/getTag

Description

This API will be used to get all the available Tags created for endpoints.

Details of all Tag will be given in the response.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
responseParam	O	Object of the Rule Details

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Output tag Parameter

Field	Optional/ Mandatory	Description
tagId	M	ID assigned / configured in the system against each Tag.
tagName	O	Tag Name
tagDescription	O	Tag Description

Result Codes

Result Codes	Description	Next Steps
10151	Get Tag success
10152	Get Tag failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Get - Tag - Success - — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10151",
            "resultDescription": "Get Tag success"
        },
        "resultCode": "0",
        "responseParam": {
            "rows": [
                {
                    "tagId": "2925001",
                    "tagName": "Enterprise_Tags8",
                    "tagDescription": "This is my tag description TAG8"
                },
                {
                    "tagId": "2935001",
                    "tagName": "Enterprise_tag10",
                    "tagDescription": "This is my tag description TAG10"
                },
                {
                    "tagId": "2875001",
                    "tagName": "MVNE_Tag",
                    "tagDescription": "This is my tag description TAG1"
                },
                {
                    "tagId": "2915001",
                    "tagName": "Enterprise_tag6",
                    "tagDescription": "This is my tag description TAG6"
                },
                {
                    "tagId": "2920001",
                    "tagName": "Enterprise_tag7",
                    "tagDescription": "This is my tag description TAG7"
                },
                {
                    "tagId": "2930001",
                    "tagName": "Enterprise_tag9",
                    "tagDescription": "This is my tag description TAG9"
                },
                {
                    "tagId": "2845001",
                    "tagName": "Tag_demo1",
                    "tagDescription": "bics_belgium A"
                },
                {
                    "tagId": "2900001",
                    "tagName": "Enterprise_tag3",
                    "tagDescription": "This is my tag description TAG2"
                },
                {
                    "tagId": "2880001",
                    "tagName": "MVNE_tag1",
                    "tagDescription": "This is my tag description TAG2"
                },
                {
                    "tagId": "2850001",
                    "tagName": "customer TAG1",
                    "tagDescription": "This is my tag description TAGS1"
                },
                {
                    "tagId": "2910001",
                    "tagName": "Enterprise_tag5",
                    "tagDescription": "This is my tag description TAG5"
                },
                {
                    "tagId": "2865001",
                    "tagName": "MVNE_Tag",
                    "tagDescription": "This is my tag description TAG1"
                },
                {
                    "tagId": "2895001",
                    "tagName": "Enterprise_Tags2",
                    "tagDescription": "This is my tag description TAG1"
                },
                {
                    "tagId": "2905001",
                    "tagName": "Enterprise_Tags4",
                    "tagDescription": "This is my tag description TAG4"
                },
                {
                    "tagId": "2885001",
                    "tagName": "Enterprise_Tags",
                    "tagDescription": "This is my tag description TAG1"
                },
                {
                    "tagId": "2870001",
                    "tagName": "MVNE_tag1",
                    "tagDescription": "This is my tag description TAG2"
                },
                {
                    "tagId": "2890001",
                    "tagName": "Enterprise_tag1",
                    "tagDescription": "This is my tag description TAG2"
                },
                {
                    "tagId": "2940001",
                    "tagName": "Enterprise_tag11",
                    "tagDescription": "This is my tag description TAG11"
                }
            ]
        },
        "responseId": "9039975215244886",
        "responseTimestamp": "28/09/2022 02:05:36"
    }
}

Get - Tag - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10152",
            "resultDescription": "Get Tag failure"
        },
        "resultCode": "1",
        "responseId": "9039040856456868",
        "responseTimestamp": "28/09/2022 01:50:01"
    }
}

Tag - Delete

Path: Endpoint Tags / Tag - Delete

Method: POST

URL: https://sft.bics.com/api/deleteTag

Description

This API will be used to delete one or multiple existing endpoint Tags. Use tagId to define which tag you wish to delete.

Use Get Tag to find the available tagId

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input tag Info Parameters

Field	Optional/Mandatory	Description
removeTag	M	The Id of the Tag you want to remove.

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result

Output ResultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
10153	Delete Tag success
10154	Delete Tag failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{
	"tagInfo": {
		"removeTag": ["2890001","2885001","2880001"]
	}
}

Response Examples

Modify -Tag- Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10153",
            "resultDescription": "Delete Tag success"
        },
        "resultCode": "0",
        "responseId": "9041798419445172",
        "responseTimestamp": "28/09/2022 02:35:59"
    }
}

Modify - Tag - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10154",
            "resultDescription": "Delete Tag failure"
        },
        "resultCode": "1",
        "responseId": "9041837652633325",
        "responseTimestamp": "28/09/2022 02:36:38"
    }
}