Get Connector - IRIS360 PUBLIC API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Unique ID of the connector

Example:

1

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

optional

id

string

required

Connector unique id

name

string

required

Connector name

type

string

required

Connector type

status

string

required

Connector status

user_id

integer

required

User id connector belongs to

last_connection

string

required

Connector last connection

connectable_type

string

required

Connector type

connectable_id

integer

required

Connector id

entities

array[integer]

required

Ids of the entities that are related to this connector

devices

array[integer]

required

Ids of the devices that are related to this connector

mapping_schemas

array [object {3}]

required

Mapping schema related to this connector

ipAddress

string

required

port

number

required

username

string

required

password

string

required

clientId

string

required

sslCert

string

required

ssl

string

required

topicTemplate

object

required

Topic of the message

messageTemplate

object

required

The configuration of the payload format

{
  "id": 1,
  "name": "Conector http",
  "type": "http",
  "status": "active",
  "user_id": 1,
  "last_connection": null,
  "connectable_type": "http_connector",
  "connectable_id": 48,
  "entities": [],
  "devices": [
    {
      "id": 7,
      "case_id": "112-112",
      "name": "One fiware",
      "serial": "oneFiware",
      "description": "One fiware",
      "is_subscribed": true,
      "owner": false,
      "properties": null,
      "subscribed_until": "2029-02-23 08:00:38",
      "type": {
        "id": 3,
        "code": "one",
        "name": "ONE",
        "brand": "Libelium",
        "category": "One"
      },
      "entities": [
        1
      ]
    }
  ],
  "mapping_schemas": [],
  "method": "POST",
  "url": "https://example.com",
  "authorization": null,
  "retries": 0,
  "timeout": 0,
  "bulk": false,
  "payload_config": [
    {
      "key": "timestamp",
      "type": "timestamp",
      "value": "timestamp",
      "active": true,
      "required": true
    },
    {
      "key": "value",
      "type": "number | string | boolean",
      "value": "value",
      "active": true,
      "required": true
    },
    {
      "key": "urn",
      "type": "string",
      "value": "urn",
      "active": true,
      "required": false
    },
    {
      "key": "tenant",
      "type": "string",
      "value": "tenant",
      "active": true,
      "required": false
    },
    {
      "key": "scope",
      "type": "string",
      "value": "scope",
      "active": true,
      "required": false
    },
    {
      "key": "measure",
      "type": "string",
      "value": "measure",
      "active": true,
      "required": true
    },
    {
      "key": "unit",
      "type": "string",
      "value": "unit",
      "active": true,
      "required": true
    }
  ]
}