iCube
  • iCube Learning
  • Introduction
    • What is iCube?
  • iCube Platform
    • iCube Server
      • Overview
      • Data
        • Value & Value Relation editor
          • Query Data
          • Add Data
          • Update Data
          • Delete Data
      • Tag
        • What is Tag?
          • Tag configuration
            • Create Tag
            • Update Tag
            • Delete Tag
        • What is TagRelation?
          • TagRelation configuration
            • Create TagRelation
            • Update TagRelation
            • Delete TagRelation
      • Interface
        • Interface configuration
          • Create Interface
          • Update Interface
          • Delete Interface
        • Mapping configuration
          • Create Mapping
          • Update Mapping
          • Delete Mapping
      • Integration
        • Provider
          • [Integration Provider] API Document
            • Get service list all
            • Get connection
            • Get Tag all
            • Get Tag Relation all
            • Get Tag by name
            • Get Tag Relation by name
            • Get single Tag value
            • Get single Tag Relation value
            • Get multiple Tag values
            • Get multiple Tag Relation values
            • Get multiple Tag values (with Body)
            • Get multiple Tag Relation values (with Body)
            • Insert multiple Tag values
            • Insert multiple Tag Relation values
            • Update multiple Tag value
            • Update multiple Tag Relation value
            • Delete multiple Tag values
            • Delete multiple Tag Relation values
          • APIs Document
            • Get service lists
            • Get connection
            • Get tags
            • Get tagrelations
            • Get tag by tagname
            • Get tagrelation by tagrelation name
            • Get single tag value
            • Get single tagrelation value
            • Get multiple tags values
            • Get multiple tagrelations values
            • Get multiple tags values (with Body)
            • Get multiple tagrelations values (with Body)
            • Insert multiple tag values
            • Insert multiple tagrelation values
            • Update multiple tag values
            • Update multiple tagrelation values
        • Publisher
          • Create Publisher
          • Update Publisher
          • Delete Publisher
      • Scheduling
        • Create Schedule
        • Update Schedule
        • Delete Schedule
      • Security
        • User configuration
          • Create User
          • Update User
          • Delete User
        • Role & Permission configuration
          • Create Role
          • Update Role
          • Delete Role
        • Token provider configuration
          • Create Token
          • Delete Token
    • iCube Form
      • Overview
        • Create Group
        • Manage Group
        • Setting Group
        • Delete Group
      • Form
        • Create Form
        • Setting Form
        • Design
          • Input
          • Editor
          • Card
          • Date Form
          • Table
          • Submit Button
          • Navigate
          • Signature
          • Drop Down
          • Upload file
          • Custom graphic
        • Duplicate Form
        • Delete Form
      • Workflow
        • Task
        • Request
          • Action
          • Create Request
        • Flow Template
          • Create Flow Template
          • Update Flow Template
          • Delete Flow Template
        • Workflow history
      • History
        • Form
      • Upload
      • Security
        • User
        • Role Permission
        • Menu Permission
    • Power BI Connector
      • Download & Install
      • Setting Options Security
  • iCube API
    • Overview of Resource URL Patterns
      • Get Connection
      • Get Tag all
      • Get Tag Relation all
      • Get Tag detail
      • Get Tag Relation detail
      • Get single Tag value
      • Get single Tag Relation value
      • Get multiple Tag values
      • Get multiple Tag Relation values
      • Get multiple Tag values (with Body)
      • Get multiple Tag Relation values (with Body)
      • Insert multiple Tag values
      • Insert multiple Tag Relation values
      • Update single/multiple Tag value
      • Update single/multiple Tag Relation value
      • Delete multiple Tag values
      • Delete multiple Tag Relation values
Powered by GitBook
On this page
Export as PDF
  1. iCube Platform
  2. iCube Server
  3. Integration
  4. Provider
  5. [Integration Provider] API Document

Get multiple Tag Relation values (with Body)

Fetches the values of specified tag relations based on the provided criteria.

Example URL

https://api.icube.co.th/integration/webapi/tagrelation/value?mode=read

Last Update: 7 NOV 2024

Retrieve Tag Relation Values

Method: POST

URL: {{base_url}}/tagrelation/value?mode=read


Query Parameters:

Parameter
Data Type
Description

mode

string

Mode of the Request

  • read: Use this mode to retrieve data.

  • write: Use this mode to insert data.

(Default: mode=read)

updateStatus

bool

Update Status of data

  • True: Use this when need to update the status of data

  • False: Use this when don't need to update the status of data

(Default: updateStatus=False)

clearAll

bool

Clear records of data

  • True: Use this when need to clear all records of data before insert the new one

  • False: Use this when don't need to clear all records of data before insert the new one

(Default: clearAll=False)


Request Body:

Parameter
Data Type
Description

tagrelations

string

Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,TagRelationManagementSystem)

starttime

string

Starting time for filtering the data (e.g., *-10y) (Default: starttime=*-10m)

endtime

string

Ending time for filtering the data (e.g., *) (Default: endtime=*)

statusData

integer

Status filter for the tag relation values


Time Expression:

Expression
Description

sec

Second

m

Minute

h

Hour

d

Day

mo

Month

y

Year

-

Go back (e.g., *-10y means go back 10 years)

*

Present

+

Go forward (e.g., *+10mo means go forward 10 months)


Example Request Body:

{
    "tagrelations": "tagrelationname,tagrelationname",
    "starttime": "*-10y",
    "endtime": "*",
    "statusData": 9
}

Response Example:

{
    "data": [
        {
            "tagRelationName": "string",
            "Id": "string",
            "name": "string",
            "tel": "string",
            "quality": integer,
            "status": integer,
            "timeStamp": "datetime"
        }
    ]
}

Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.

Response Details:

Object
Data Type
Description

data

array

Array of tag relation value objects returned from the API.

tagRelationName

string

Name of the tag relation.

Id

string

Unique identifier for the tag relation.

name

string

Name associated with the tag relation.

tel

string

Telephone number associated with the tag relation.

quality

integer

Quality indicator of the tag relation value.

status

integer

Status code associated with the tag relation value.

timeStamp

datetime

Timestamp when the tag relation value was recorded.

PreviousGet multiple Tag values (with Body)NextInsert multiple Tag values

Last updated 6 months ago