Get Data-Source
Get data-source by ID. returns data-source properties and schema metrics
Get
https://api.zira.us/public/data-sources/[id]
Example response
{
"data": {
"id": "23139",
"name": "Expression test",
"description": "bla bla",
"externalId": null,
"type": {
"id": "40",
"name": "Other"
},
"offset": -360,
"timezoneId": "79",
"tzTimezoneName": "US/Central",
"site": {
"id": "1038",
"name": "test site",
"channelId": "14727"
},
"model": {
"id": null,
"name": null
},
"manufacturer": null,
"inactiveThreshold": 60,
"locationOnSite": null,
"recommendedAssociationType": null,
"validationStatus": {
"id": "10",
"name": "Pending Validation"
},
"activityStatus": {
"id": "40",
"name": "Pending Readings"
},
"geoLocation": null,
"sourceDevice": null,
"endpointDevice": {
"id": null,
"name": null
},
"collector": {
"id": "29",
"name": "Form"
},
"ipAddress": null,
"port": null,
"communicationType": null,
"carrier": null,
"simNumber": null,
"slaveId": null,
"collectionInfo": null,
"readingInterval": null,
"isCustomSchema": true,
"collectorType": {
"id": "1",
"name": "Push"
},
"isPotentialEndpoint": null,
"images": null,
"files": null,
"auditInfo": {
"createdBy": {
"id": "1224",
"name": "yuriy a (old)"
},
"createdDate": "2023-01-09T13:52:53.432929Z",
"lastModifiedBy": {
"id": "1998",
"name": "Yuriy Andriyevskyy"
},
"lastModifiedDate": "2023-06-04T08:16:20.783070Z"
},
"channelId": "28111",
"displayUoms": [
{
"metricId": "91",
"uomId": "2600"
},
{
"metricId": "329",
"uomId": "2000"
},
{
"metricId": "330",
"uomId": "2000"
},
{
"metricId": "331",
"uomId": "2100"
},
{
"metricId": "3792",
"uomId": "2300"
},
{
"metricId": "3793",
"uomId": "2600"
}
],
"linkedDevice": null,
"isShared": false,
"collectionEnabled": true,
"handleCounterResets": false,
"formConfig": {
"type": "object",
"order": [
"2smtaoga7qf",
"1dnecldyba",
"rbv09p03nmr"
],
"isStatic": false,
"required": [
"2smtaoga7qf",
"rbv09p03nmr"
],
"companyId": "640",
"applyingId": "2",
"properties": {
"1dnecldyba": {
"type": "boolean",
"title": "Reset"
},
"2smtaoga7qf": {
"type": "number",
"title": "Number"
},
"rbv09p03nmr": {
"type": "number",
"title": "Accumulated Units"
}
},
"reEvaluate": true,
"description": "bla bla",
"deviceTypeId": "40",
"collectionInfo": null,
"formattedDescription": [
{
"type": "paragraph",
"children": [
{
"text": ""
}
]
}
]
},
"normalizeTimezoneId": null,
"publishToChannels": null,
"deviceTemplateId": null,
"createFromDeviceTemplateId": null,
"applying": {
"id": "2",
"name": "form"
},
"isTemplate": false,
"isDeleted": false,
"companyId": "640"
}
}
Query Params
Property | Required | Type | Example | Description |
---|---|---|---|---|
withLastReading | false | Boolean | true | Will include last reading of this data-source in the response payload |
withSchema | false | Boolean | true | Will include the schema and metrics information of this data-source in the response payload |