Get the single connector of a group
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 Name In Type Required Description connectorId query string true The connector id groupId query integer true The id of the group
Responses DELETE /connector
Delete connector
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description groupId query string true The id of the group connectorId query string true The id of the connector to delete
Responses Status Meaning Description Schema default Default successful operation Connector
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
Responses 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
Responses 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
Responses Get all events of a connector
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 Name In Type Required Description connectorId query string true The id of the connector groupId query string true The id of the group beginDate query string(date) true The begin timestamp of the period to get the data from endDate query string(date) true The end timestamp of the period to get the data from ascending query boolean false The order of the items by default is ascending
Responses Get the list of all UnaConnect connector types
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 Name In Type Required Description limit query integer false none nextToken query string false The 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 Status Meaning Description Schema 200 OK A list of connector types Inline 400 Bad Request Wrong parameters given None 404 Not Found Couldn't get deviceType None
Response Schema Status Code 200
GET /connector/connectorType
Get a connectorType
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description type query string true none
Responses Get the list of Connectors of a group
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 Name In Type Required Description groupId query string true The id of the group limit query integer false The maximum number of items to retrieve nextToken query string false The 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 Get all metrics of a connector
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 Name In Type Required Description groupId query string true The id of the group connectorId query integer true The id of the connector beginDate query string(date) true TThe begin timestamp of the period to get the data from endDate query string(date) true The end timestamp of the period to get the data from timeSpan query string(date) false The timespan between each item in seconds
Responses Schemas
GenericReturn {
"message" : "string"
}
Name Type Required Restrictions Description message string false none none
GenericReturnBoolean {
"message" : "string" ,
"value" : true
}
Name Type Required Restrictions Description message string false none none value boolean false none none
RetryPolicy {
"retryDelay" : 0 ,
"maxRetry" : 0
}
Name Type Required Restrictions Description retryDelay integer false none none maxRetry integer false none none
DataFailurePolicy {
"storingDuration" : 0 ,
"hasData" : true ,
"startTime" : "2019-08-24" ,
"resending" : true
}
Name Type Required Restrictions Description storingDuration integer false none none hasData boolean false none none startTime string(date) false none none resending boolean false none none
ConnectorError {
"at" : "2019-08-24" ,
"message" : "string"
}
Name Type Required Restrictions Description at string(date) false none none message string false none none
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"
]
}
Name Type Required Restrictions Description groupId string true none none id string true none none name string false none none description string false none none params string true none none type string true none none createdAt string(date) true none none updatedAt string(date) true none none updatedBy string true none none createdBy string true none none
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"
}
Name Type Required Restrictions Description test [Connector ] false none none
ConnectorType {
"expectedParameters" : "string" ,
"type" : "string" ,
"formatAvailable" : [
"string"
] ,
"name" : "string"
}
Name Type Required Restrictions Description expectedParameters string true none none type string true none none formatAvailable [string] false none none name string false none none
ConnectorTypeConnection {
"items" : [
{
"expectedParameters" : "string" ,
"type" : "string" ,
"formatAvailable" : [
"string"
] ,
"name" : "string"
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [ConnectorType ] false none none
ConnectorEvent {
"connectorId" : "string" ,
"timestamp" : "2019-08-24" ,
"status" : "string"
}
Name Type Required Restrictions Description connectorId string true none none timestamp string(date) false none none status string false none none
ConnectorEventStats {
"totalStillProcessing" : 0 ,
"totalSucceed" : 0 ,
"totalFailed" : 0
}
Name Type Required Restrictions Description totalStillProcessing integer false none none totalSucceed integer false none none totalFailed integer false none none
ConnectorEventConnection {
"items" : [
{
"connectorId" : "string" ,
"timestamp" : "2019-08-24" ,
"status" : "string"
}
] ,
"stats" : {
"totalStillProcessing" : 0 ,
"totalSucceed" : 0 ,
"totalFailed" : 0
}
}
Name Type Required Restrictions Description items [ConnectorEvent ] false none none
{
"retryDelay" : 0 ,
"maxRetry" : 0
}
Name Type Required Restrictions Description retryDelay integer true none none maxRetry integer true none none
{
"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
}
}
Name Type Required Restrictions Description groupId string true none none id string false none none name string false none none description string false none none params string true none none type string true none none deviceTypes [string] false none none deviceIds [string] false none none messageFilter string false none none format string false none none
{
"storingDuration" : 0 ,
"hasData" : true ,
"startTime" : "2019-08-24" ,
"resending" : true
}
Name Type Required Restrictions Description storingDuration integer false none none hasData boolean false none none startTime string(date) false none none resending boolean false none none
{
"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"
]
}
Name Type Required Restrictions Description connectorId string true none none groupId string true none none params string false none none name string false none none description string false none none type string false none none deviceTypes [string] false none none deviceIds [string] false none none messageFilter string false none none
{
"expectedParameters" : "string" ,
"type" : "string"
}
Name Type Required Restrictions Description expectedParameters string true none none type string true none none
{
"groupId" : "string" ,
"connectorId" : "string"
}
Name Type Required Restrictions Description groupId string true none none connectorId string true none none
{
"type" : "string"
}
Name Type Required Restrictions Description type string true none none
{
"connectorId" : "string" ,
"groupId" : "string"
}
Name Type Required Restrictions Description connectorId string true none none groupId string true none none
ConnectorMetric {
"groupId" : "string" ,
"connectorId" : "string" ,
"timestamp" : "2019-08-24" ,
"totalConnectorMessageError" : 0 ,
"totalConnectorMessageProcessed" : 0 ,
"totalConnectorMessageProcessing" : 0 ,
"totalConnectorMessageStarted" : 0 ,
"totalConnectorRetryMessageError" : 0 ,
"totalConnectorRetryMessageProcessed" : 0 ,
"totalConnectorRetryMessageStarted" : 0
}
Name Type Required Restrictions Description groupId string false none none connectorId string false none none timestamp string(date) false none none totalConnectorMessageError integer false none none totalConnectorMessageProcessed integer false none none totalConnectorMessageProcessing integer false none none totalConnectorMessageStarted integer false none none totalConnectorRetryMessageError integer false none none totalConnectorRetryMessageProcessed integer false none none totalConnectorRetryMessageStarted integer false none none
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
}
]
}
Name Type Required Restrictions Description groupId string false none none connectorId string false none none beginDate string(date) false none none endDate string(date) false none none totalConnectorMessageError integer false none none totalConnectorMessageProcessed integer false none none totalConnectorMessageProcessing integer false none none totalConnectorMessageStarted integer false none none totalConnectorRetryMessageError integer false none none totalConnectorRetryMessageProcessed integer false none none totalConnectorRetryMessageStarted integer false none none items [ConnectorMetric ] false none none