Overview of InputInfo goes here.
Item -> BaseInfo -> PeripheralInfo -> InputInfo
InputInfo -> AscInputInfo -> iStarInputInfo -> SafrInputInfo
| Field | Type | Inherited from | Description |
|---|---|---|---|
| Href | String | Item | Gets or sets the Href value |
| CommonName | String | BaseInfo | Gets or sets the CommonName value |
| ConcurrencyVersion | Nullable<Int64> | BaseInfo | Gets or sets the ConcurrencyVersion value |
| InFolderHref | String | BaseInfo | Gets or sets the InFolderHref value |
| InFolderKey | String | BaseInfo | Gets or sets the InFolderKey value |
| IsGlobal | Boolean | BaseInfo | Gets or sets the IsGlobal value |
| Key | String | BaseInfo | Gets or sets the Key value |
| Links | List<Link> | BaseInfo | Gets or sets the Links value |
| Metadata | MetadataItem[] | BaseInfo | Gets or sets the Metadata value |
| Monikers | MonikerItem[] | BaseInfo | Gets or sets the Monikers value |
| Notes | NoteInfo[] | BaseInfo | Gets or sets the Notes value |
| ObjectLinks | ObjectLinkItem[] | BaseInfo | Gets or sets the ObjectLinks value |
| Tags | String[] | BaseInfo | Gets or sets the Tags value |
{
"Href" : "String",
"CommonName" : "String",
"ConcurrencyVersion" : "Nullable\<Int64\>",
"InFolderHref" : "String",
"InFolderKey" : "String",
"IsGlobal" : "Boolean",
"Key" : "String",
"Links" : "List\<[Link](/object-model/link)\>",
"Metadata" : "[MetadataItem](/object-model/metadataitem)[]",
"Monikers" : "[MonikerItem](/object-model/monikeritem)[]",
"Notes" : "[NoteInfo](/object-model/noteinfo)[]",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"Tags" : "String[]"
}
Example in C#
// Returns: InputInfo
var inputInfo = await client.AddInputAsync(FolderInfo folder, InputInfo item);
Example in C#
// Returns: InputScannerInfo
var inputScannerInfo = await client.AddInputScannerAsync(FolderInfo folder, InputScannerInfo item);
Example in CURL
curl -X POST \
http://qa-v3.feenicsdev.com/api/f/5b61d62492dacd062c424424/inputscanners \
-H 'Content-Type: application/json' \
-d
'{
"$type":"Feenics.Keep.WebApi.Model.InputScannerInfo, Feenics.Keep.WebApi.Model",
"NonSettlingErrorPriority":0,
"NonSettlingErrorStatus":0,
"InputScannerReportingPriorities":
[
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, shorted circuit",
"Priority":1,
"StatusCode":3,
"MinResistanceCode":-2,
"MaxResistanceCode":50
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":50,
"MaxResistanceCode":850
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Inactive, normal state of circuit",
"Priority":2,
"StatusCode":0,
"MinResistanceCode":850,
"MaxResistanceCode":1150
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":1150,
"MaxResistanceCode":1800
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Active",
"Priority":0,
"StatusCode":1,
"MinResistanceCode":1800,
"MaxResistanceCode":2200
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":2200,
"MaxResistanceCode":25000
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, open circuit",
"Priority":1,
"StatusCode":4,
"MinResistanceCode":25000,
"MaxResistanceCode":-1
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, ground fault",
"Priority":1,
"StatusCode":2,
"MinResistanceCode":-4,
"MaxResistanceCode":-3
}
],
"Key":null,
"CommonName":"InputScannerRestAPIIntegrationTestingPreExisiting",
"InFolderHref":null,
"InFolderKey":null,
"Links":[],
"ObjectLinks":null,
"Metadata":null,
"Notes":null,
"Tags":null,
"Monikers":null,
"Href":null
}'
Example in C#
// Returns: nothing
await client.DeleteInputAsync(InputInfo item);
Example in C#
// Returns: nothing
await client.DeleteInputScannerAsync(InputScannerInfo item);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<InputInfo>
var inputInfo = await client.GetInputsAsync(FolderInfo folder);
Example in C#
// Returns: IEnumerable<InputScannerInfo>
var inputScannerInfo = await client.GetInputScannersAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateInputAsync(InputInfo item);
Example in C#
// Returns: nothing
await client.UpdateInputScannerAsync(InputScannerInfo item);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY \
-H 'Content-Type: application/json' \
-d
'{
"$type":"Feenics.Keep.WebApi.Model.InputScannerInfo, Feenics.Keep.WebApi.Model",
"NonSettlingErrorPriority":0,
"NonSettlingErrorStatus":0,
"InputScannerReportingPriorities":
[
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, shorted circuit",
"Priority":1,
"StatusCode":3,
"MinResistanceCode":-2,
"MaxResistanceCode":50
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":50,
"MaxResistanceCode":850
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Inactive, normal state of circuit",
"Priority":2,
"StatusCode":0,
"MinResistanceCode":850,
"MaxResistanceCode":1150
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":1150,
"MaxResistanceCode":1800
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Active",
"Priority":0,
"StatusCode":1,
"MinResistanceCode":1800,
"MaxResistanceCode":2200
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":2200,
"MaxResistanceCode":25000
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, open circuit",
"Priority":1,
"StatusCode":4,
"MinResistanceCode":25000,
"MaxResistanceCode":-1
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, ground fault",
"Priority":1,
"StatusCode":2,
"MinResistanceCode":-4,
"MaxResistanceCode":-3
}
],
"Key":"INPUTSCANNER.KEY",
"CommonName":"INPUTSCANNER",
"InFolderHref":"/api/f/FOLDER.KEY",
"InFolderKey":"FOLDER.KEY",
"Links":
[
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Meta",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"meta",
"Text":"Metadata"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Monikers",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"monikers",
"Text":"Monikers"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"CommonName",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"commonname",
"Text":"Common Name"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Images",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"images",
"Text":"Images"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"TakeOwnership",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"takeownership",
"Text":"Take Ownership"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Connections",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"connections",
"Text":"Connected Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"References",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"references",
"Text":"Referencing Objects"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Notes",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"notes",
"Text":"Notes"
}
}
],
"ObjectLinks":
[
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"Instance",
"Relation":"InInstance",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
},
{
"$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
"Href":null,
"LinkedObjectKey":"INSTANCE.KEY",
"CommonName":"Instance",
"Relation":"InstanceScope",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
}
],
"Metadata":[],
"Notes":[],
"Tags":[],
"Monikers":[],
"Href":"/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY"
}'