Connector

GET /connector
Get the single connector of a group by giving the connectorId and the groupId
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
connectorIdquerystringtrueThe connector id
groupIdqueryintegertrueThe id of the group

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnector
400Bad RequestBad requestNone

DELETE /connector
Delete connector
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
connectorIdquerystringtrueThe id of the connector to delete

Responses

StatusMeaningDescriptionSchema
defaultDefaultsuccessful operationConnector

POST /connector
Create a connector
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "groupId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "params": "string",
  "type": "string",
  "deviceTypes": [
    "string"
  ],
  "deviceIds": [
    "string"
  ],
  "messageFilter": "string",
  "format": "string",
  "dataFailurePolicy": {
    "storingDuration": 0,
    "hasData": true,
    "startTime": "2019-08-24",
    "resending": true
  },
  "retryPolicy": {
    "retryDelay": 0,
    "maxRetry": 0
  }
}

Parameters

NameInTypeRequiredDescription
bodybodyConnectorInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnector
400Bad RequestBad requestNone

PUT /connector
Update a connector
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "connectorId": "string",
  "groupId": "string",
  "params": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "deviceTypes": [
    "string"
  ],
  "deviceIds": [
    "string"
  ],
  "messageFilter": "string",
  "dataFailurePolicy": {
    "storingDuration": 0,
    "hasData": true,
    "startTime": "2019-08-24",
    "resending": true
  },
  "retryPolicy": {
    "retryDelay": 0,
    "maxRetry": 0
  },
  "format": "string",
  "enabled": true,
  "tags": [
    "string"
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateConnectorInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnector
400Bad RequestBad requestNone

POST /connector/resendData
Resend data
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "connectorId": "string",
  "groupId": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyResendDataInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnector
400Bad RequestBad requestNone

GET /connector/connectorEvent
Get all events of a connector
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
connectorIdquerystringtrueThe id of the connector
groupIdquerystringtrueThe id of the group
beginDatequerystring(date)trueThe begin timestamp of the period to get the data from
endDatequerystring(date)trueThe end timestamp of the period to get the data from
ascendingquerybooleanfalseThe order of the items by default is ascending

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnectorEventConnection
400Bad RequestBad requestNone

GET /connector/connectorTypes
Get the list of all UnaConnect connector types
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalsenone
nextTokenquerystringfalseThe key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

Responses

StatusMeaningDescriptionSchema
200OKA list of connector typesInline
400Bad RequestWrong parameters givenNone
404Not FoundCouldn't get deviceTypeNone

Response Schema

Status Code 200
NameTypeRequiredRestrictionsDescription
anonymous[ConnectorTypeConnection]falsenonenone

GET /connector/connectorType
Get a connectorType
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
typequerystringtruenone

Responses

StatusMeaningDescriptionSchema
200OKreturning connectorType successfullyConnectorType
400Bad RequestBad requestNone

GET /connector/connectors
Get the list of Connectors of a group
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnectorConnection
400Bad RequestBad requestNone

GET /connector/metrics
Get all metrics of a connector
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
groupIdquerystringtrueThe id of the group
connectorIdqueryintegertrueThe id of the connector
beginDatequerystring(date)trueTThe begin timestamp of the period to get the data from
endDatequerystring(date)trueThe end timestamp of the period to get the data from
timeSpanquerystring(date)falseThe timespan between each item in seconds

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseConnectorMetrics
400Bad RequestBad requestNone

Schemas

GenericReturn

{
  "message": "string"
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone

GenericReturnBoolean

{
  "message": "string",
  "value": true
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone
valuebooleanfalsenonenone

RetryPolicy

{
  "retryDelay": 0,
  "maxRetry": 0
}

NameTypeRequiredRestrictionsDescription
retryDelayintegerfalsenonenone
maxRetryintegerfalsenonenone

DataFailurePolicy

{
  "storingDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

NameTypeRequiredRestrictionsDescription
storingDurationintegerfalsenonenone
hasDatabooleanfalsenonenone
startTimestring(date)falsenonenone
resendingbooleanfalsenonenone

ConnectorError

{
  "at": "2019-08-24",
  "message": "string"
}

NameTypeRequiredRestrictionsDescription
atstring(date)falsenonenone
messagestringfalsenonenone

Connector

{
  "groupId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "params": "string",
  "type": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "updatedBy": "string",
  "createdBy": "string",
  "error": {
    "at": "2019-08-24",
    "message": "string"
  },
  "deviceTypes": [
    "string"
  ],
  "enabled": true,
  "messageFilter": "string",
  "format": "string",
  "dataFailurePolicy": {
    "storingDuration": 0,
    "hasData": true,
    "startTime": "2019-08-24",
    "resending": true
  },
  "retryPolicy": {
    "retryDelay": 0,
    "maxRetry": 0
  },
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
idstringtruenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
paramsstringtruenonenone
typestringtruenonenone
createdAtstring(date)truenonenone
updatedAtstring(date)truenonenone
updatedBystringtruenonenone
createdBystringtruenonenone

ConnectorConnection

{
  "test": [
    {
      "groupId": "string",
      "id": "string",
      "name": "string",
      "description": "string",
      "params": "string",
      "type": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "updatedBy": "string",
      "createdBy": "string",
      "error": {
        "at": "2019-08-24",
        "message": "string"
      },
      "deviceTypes": [
        "string"
      ],
      "enabled": true,
      "messageFilter": "string",
      "format": "string",
      "dataFailurePolicy": {
        "storingDuration": 0,
        "hasData": true,
        "startTime": "2019-08-24",
        "resending": true
      },
      "retryPolicy": {
        "retryDelay": 0,
        "maxRetry": 0
      },
      "tags": [
        "string"
      ]
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
test[Connector]falsenonenone

ConnectorType

{
  "expectedParameters": "string",
  "type": "string",
  "formatAvailable": [
    "string"
  ],
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
expectedParametersstringtruenonenone
typestringtruenonenone
formatAvailable[string]falsenonenone
namestringfalsenonenone

ConnectorTypeConnection

{
  "items": [
    {
      "expectedParameters": "string",
      "type": "string",
      "formatAvailable": [
        "string"
      ],
      "name": "string"
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[ConnectorType]falsenonenone

ConnectorEvent

{
  "connectorId": "string",
  "timestamp": "2019-08-24",
  "status": "string"
}

NameTypeRequiredRestrictionsDescription
connectorIdstringtruenonenone
timestampstring(date)falsenonenone
statusstringfalsenonenone

ConnectorEventStats

{
  "totalStillProcessing": 0,
  "totalSucceed": 0,
  "totalFailed": 0
}

NameTypeRequiredRestrictionsDescription
totalStillProcessingintegerfalsenonenone
totalSucceedintegerfalsenonenone
totalFailedintegerfalsenonenone

ConnectorEventConnection

{
  "items": [
    {
      "connectorId": "string",
      "timestamp": "2019-08-24",
      "status": "string"
    }
  ],
  "stats": {
    "totalStillProcessing": 0,
    "totalSucceed": 0,
    "totalFailed": 0
  }
}

NameTypeRequiredRestrictionsDescription
items[ConnectorEvent]falsenonenone

RetryPolicyInput

{
  "retryDelay": 0,
  "maxRetry": 0
}

NameTypeRequiredRestrictionsDescription
retryDelayintegertruenonenone
maxRetryintegertruenonenone

ConnectorInput

{
  "groupId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "params": "string",
  "type": "string",
  "deviceTypes": [
    "string"
  ],
  "deviceIds": [
    "string"
  ],
  "messageFilter": "string",
  "format": "string",
  "dataFailurePolicy": {
    "storingDuration": 0,
    "hasData": true,
    "startTime": "2019-08-24",
    "resending": true
  },
  "retryPolicy": {
    "retryDelay": 0,
    "maxRetry": 0
  }
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
idstringfalsenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
paramsstringtruenonenone
typestringtruenonenone
deviceTypes[string]falsenonenone
deviceIds[string]falsenonenone
messageFilterstringfalsenonenone
formatstringfalsenonenone

DataFailurePolicyInput

{
  "storingDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

NameTypeRequiredRestrictionsDescription
storingDurationintegerfalsenonenone
hasDatabooleanfalsenonenone
startTimestring(date)falsenonenone
resendingbooleanfalsenonenone

UpdateConnectorInput

{
  "connectorId": "string",
  "groupId": "string",
  "params": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "deviceTypes": [
    "string"
  ],
  "deviceIds": [
    "string"
  ],
  "messageFilter": "string",
  "dataFailurePolicy": {
    "storingDuration": 0,
    "hasData": true,
    "startTime": "2019-08-24",
    "resending": true
  },
  "retryPolicy": {
    "retryDelay": 0,
    "maxRetry": 0
  },
  "format": "string",
  "enabled": true,
  "tags": [
    "string"
  ]
}

NameTypeRequiredRestrictionsDescription
connectorIdstringtruenonenone
groupIdstringtruenonenone
paramsstringfalsenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
typestringfalsenonenone
deviceTypes[string]falsenonenone
deviceIds[string]falsenonenone
messageFilterstringfalsenonenone

ConnectorTypeInput

{
  "expectedParameters": "string",
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
expectedParametersstringtruenonenone
typestringtruenonenone

DeleteConnectorInput

{
  "groupId": "string",
  "connectorId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
connectorIdstringtruenonenone

DeleteConnectorTypeInput

{
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
typestringtruenonenone

ResendDataInput

{
  "connectorId": "string",
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
connectorIdstringtruenonenone
groupIdstringtruenonenone

ConnectorMetric

{
  "groupId": "string",
  "connectorId": "string",
  "timestamp": "2019-08-24",
  "totalConnectorMessageError": 0,
  "totalConnectorMessageProcessed": 0,
  "totalConnectorMessageProcessing": 0,
  "totalConnectorMessageStarted": 0,
  "totalConnectorRetryMessageError": 0,
  "totalConnectorRetryMessageProcessed": 0,
  "totalConnectorRetryMessageStarted": 0
}

NameTypeRequiredRestrictionsDescription
groupIdstringfalsenonenone
connectorIdstringfalsenonenone
timestampstring(date)falsenonenone
totalConnectorMessageErrorintegerfalsenonenone
totalConnectorMessageProcessedintegerfalsenonenone
totalConnectorMessageProcessingintegerfalsenonenone
totalConnectorMessageStartedintegerfalsenonenone
totalConnectorRetryMessageErrorintegerfalsenonenone
totalConnectorRetryMessageProcessedintegerfalsenonenone
totalConnectorRetryMessageStartedintegerfalsenonenone

ConnectorMetrics

{
  "groupId": "string",
  "connectorId": "string",
  "beginDate": "2019-08-24",
  "endDate": "2019-08-24",
  "totalConnectorMessageError": 0,
  "totalConnectorMessageProcessed": 0,
  "totalConnectorMessageProcessing": 0,
  "totalConnectorMessageStarted": 0,
  "totalConnectorRetryMessageError": 0,
  "totalConnectorRetryMessageProcessed": 0,
  "totalConnectorRetryMessageStarted": 0,
  "items": [
    {
      "groupId": "string",
      "connectorId": "string",
      "timestamp": "2019-08-24",
      "totalConnectorMessageError": 0,
      "totalConnectorMessageProcessed": 0,
      "totalConnectorMessageProcessing": 0,
      "totalConnectorMessageStarted": 0,
      "totalConnectorRetryMessageError": 0,
      "totalConnectorRetryMessageProcessed": 0,
      "totalConnectorRetryMessageStarted": 0
    }
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringfalsenonenone
connectorIdstringfalsenonenone
beginDatestring(date)falsenonenone
endDatestring(date)falsenonenone
totalConnectorMessageErrorintegerfalsenonenone
totalConnectorMessageProcessedintegerfalsenonenone
totalConnectorMessageProcessingintegerfalsenonenone
totalConnectorMessageStartedintegerfalsenonenone
totalConnectorRetryMessageErrorintegerfalsenonenone
totalConnectorRetryMessageProcessedintegerfalsenonenone
totalConnectorRetryMessageStartedintegerfalsenonenone
items[ConnectorMetric]falsenonenone