nisystemlink.clients.assetmanagement
- class nisystemlink.clients.assetmanagement.AssetManagementClient(configuration=None)[source]
- __init__(configuration=None)[source]
Initialize an instance.
- Parameters
configuration (
Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, theHttpConfigurationManageris used to obtain the configuration.- Raises
ApiException – If unable to communicate with the asset management Service.
- create_assets(assets)[source]
Create Assets.
- Parameters
assets (
List[nisystemlink.clients.assetmanagement.models.CreateAssetRequest]) – Array of assets that should be created.- Returns
Array of created assets and array of failed.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid
arguments. –
- query_assets(query)[source]
Query Assets.
- Parameters
query (
nisystemlink.clients.assetmanagement.models.QueryAssetsRequest) – Object containing filters to apply when retrieving assets.- Returns
Assets Response containing the assets satisfying the query and the total count of matching assets.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid
arguments. –
- delete_assets(ids)[source]
Delete Assets.
- Parameters
ids (
List[str]) – List of IDs of the assets to delete.- Returns
Response containing the IDs of the assets that were deleted.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- link_files(asset_id, file_ids)[source]
Link files to an asset.
- Parameters
asset_id (
str) – The ID of the asset to which files should be linked.file_ids (
List[str]) – The list of file IDs to link.
- Return type
Optional[nisystemlink.clients.assetmanagement.models.LinkFilesPartialSuccessResponse]- Returns
None if all link files succeed, otherwise a response containing the IDs of files that were successfully linked and those that failed.
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- start_utilization(request)[source]
Start asset utilization tracking.
- Parameters
request (
nisystemlink.clients.assetmanagement.models.StartUtilizationRequest) – Object containing the utilization identifier, minion ID, asset identifications, utilization category, task name, user name, and utilization timestamp.- Returns
Response containing arrays of assets that successfully started utilization and those that failed, along with error information if any failures occurred.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- utilization_heartbeat(ids, timestamp=None)[source]
Send utilization heartbeat to update asset utilization tracking.
- Parameters
ids (
List[str]) – Array of utilization identifiers representing the unique identifier of asset utilization history records to update.timestamp (
Optional[datetime.datetime]) – The timestamp to use for the heartbeat. If not provided, the current server time will be used.
- Returns
Response containing arrays of utilization IDs that were successfully updated and those that failed, along with error information if any failures occurred.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- end_utilization(ids, timestamp=None)[source]
End asset utilization tracking.
- Parameters
ids (
List[str]) – Array of utilization identifiers representing the unique identifier of asset utilization history records to end.timestamp (
Optional[datetime.datetime]) – The timestamp to use when ending the utilization. If not provided, the current server time will be used.
- Returns
Response containing arrays of utilization IDs that were successfully updated and those that failed, along with error information if any failures occurred.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- query_asset_utilization_history(request)[source]
Query asset utilization history.
- Parameters
request (
nisystemlink.clients.assetmanagement.models.QueryAssetUtilizationHistoryRequest) – Object containing filters for asset utilization and assets, including utilization_filter, asset_filter, date range, and pagination options.- Returns
Response containing the list of asset utilization history records that match the query, along with optional continuation token for pagination.
- Return type
- Raises
ApiException – If unable to communicate with the asset management service or if there are invalid arguments.
- pydantic model nisystemlink.clients.assetmanagement.models.Asset[source]
Model for an object describing an asset with all of its properties.
Show JSON schema
{ "title": "Asset", "description": "Model for an object describing an asset with all of its properties.", "type": "object", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "assetType": { "anyOf": [ { "$ref": "#/$defs/AssetType" }, { "type": "null" } ], "default": null }, "discoveryType": { "anyOf": [ { "$ref": "#/$defs/AssetDiscoveryType" }, { "type": "null" } ], "default": null }, "firmwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Firmwareversion" }, "hardwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hardwareversion" }, "visaResourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Visaresourcename" }, "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "supportsSelfCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselfcalibration" }, "supportsExternalCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsexternalcalibration" }, "customCalibrationInterval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Customcalibrationinterval" }, "selfCalibration": { "anyOf": [ { "$ref": "#/$defs/SelfCalibration" }, { "type": "null" } ], "default": null }, "isNIAsset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isniasset" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "location": { "anyOf": [ { "$ref": "#/$defs/AssetLocation" }, { "type": "null" } ], "default": null }, "calibrationStatus": { "anyOf": [ { "$ref": "#/$defs/CalibrationStatus" }, { "type": "null" } ], "default": null }, "isSystemController": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Issystemcontroller" }, "externalCalibration": { "anyOf": [ { "$ref": "#/$defs/ExternalCalibration" }, { "type": "null" } ], "default": null }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "lastUpdatedTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Lastupdatedtimestamp" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "supportsSelfTest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselftest" }, "supportsReset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsreset" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "outForCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Outforcalibration" } }, "$defs": { "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetDiscoveryType": { "description": "All discovery types.", "enum": [ "MANUAL", "AUTOMATIC" ], "title": "AssetDiscoveryType", "type": "string" }, "AssetLocation": { "description": "Model for information about the asset location, presence and the connection status of the system.", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresenceWithSystemConnection" } }, "required": [ "state" ], "title": "AssetLocation", "type": "object" }, "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "AssetPresenceWithSystemConnection": { "description": "Model for the presence of an asset and the connection of the system in which it resides.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" }, "systemConnection": { "anyOf": [ { "$ref": "#/$defs/SystemConnection" }, { "type": "null" } ], "default": null } }, "required": [ "assetPresence" ], "title": "AssetPresenceWithSystemConnection", "type": "object" }, "AssetType": { "description": "All supported asset types.", "enum": [ "GENERIC", "DEVICE_UNDER_TEST", "FIXTURE", "SYSTEM" ], "title": "AssetType", "type": "string" }, "CalibrationMode": { "description": "Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.", "enum": [ "AUTOMATIC", "MANUAL" ], "title": "CalibrationMode", "type": "string" }, "CalibrationStatus": { "description": "Calibration category the asset belongs to based on the next due calibration date.", "enum": [ "OK", "APPROACHING_RECOMMENDED_DUE_DATE", "PAST_RECOMMENDED_DUE_DATE", "OUT_FOR_CALIBRATION" ], "title": "CalibrationStatus", "type": "string" }, "ExternalCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" }, "recommendedInterval": { "title": "Recommendedinterval", "type": "integer" }, "nextRecommendedDate": { "format": "date-time", "title": "Nextrecommendeddate", "type": "string" }, "nextCustomDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcustomduedate" }, "resolvedDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Resolvedduedate" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comments" }, "entryType": { "anyOf": [ { "$ref": "#/$defs/CalibrationMode" }, { "type": "null" } ], "default": null } }, "required": [ "date", "recommendedInterval", "nextRecommendedDate" ], "title": "ExternalCalibration", "type": "object" }, "SelfCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" } }, "required": [ "date" ], "title": "SelfCalibration", "type": "object" }, "SystemConnection": { "description": "Whether or not the minion is connected to the server and has updated the server with its data.\nTo maintain compatibility with previous versions of SystemLink, the values\n[APPROVED, UNSUPPORTED, ACTIVATED] are considered equivalent to DISCONNECTED and\n[CONNECTED_UPDATE_PENDING, CONNECTED_UPDATE_SUCCESSFUL, CONNECTED_UPDATE_FAILED] are equivalent to CONNECTED.", "enum": [ "APPROVED", "DISCONNECTED", "CONNECTED_UPDATE_PENDING", "CONNECTED", "CONNECTED_UPDATE_FAILED", "UNSUPPORTED", "ACTIVATED", "CONNECTED_UPDATE_SUCCESSFUL" ], "title": "SystemConnection", "type": "string" }, "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } } }
- Fields
-
field bus_type:
Optional[AssetBusType] = None Gets or sets all supported bus types for an asset.
-
field calibration_status:
Optional[CalibrationStatus] = None Gets or sets the calibration category the asset belongs to based on the next due calibration date.
-
field custom_calibration_interval:
Optional[int] = None Gets or sets the interval represented in months used for computing calibration due date.
-
field discovery_type:
Optional[AssetDiscoveryType] = None Gets or sets the discovery type.
-
field external_calibration:
Optional[ExternalCalibration] = None Gets or sets the last external calibration of the asset.
-
field file_ids:
Optional[List[str]] = None Gets or sets all files linked to the asset.
-
field firmware_version:
Optional[str] = None Gets or sets firmware version of the asset.
-
field hardware_version:
Optional[str] = None Gets or sets hardware version of the asset.
-
field id:
Optional[str] = None Gets or sets unique identifier of the asset.
-
field is_NI_asset:
Optional[bool] = None Gets or sets whether this asset is an NI asset (true) or a third-party asset (false).
-
field is_system_controller:
Optional[bool] = None Gets or sets whether this asset represents a System Controller.
-
field keywords:
Optional[List[str]] = None Gets or sets words or phrases associated with an asset.
-
field last_updated_timestamp:
Optional[datetime] = None Gets or sets ISO-8601 formatted timestamp specifying the last date that the asset has had a property update.
-
field location:
Optional[AssetLocation] = None Model for information about the asset location, presence and the connection status of the system
-
field model_name:
Optional[str] = None Gets or sets model name of the asset.
-
field model_number:
Optional[int] = None Gets or sets model number of the asset.
-
field name:
Optional[str] = None Gets or sets name of the asset.
-
field out_for_calibration:
Optional[bool] = None Get or set whether the asset is out for calibration.
-
field part_number:
Optional[str] = None Gets or sets part number of the asset.
-
field properties:
Optional[Dict[str,str]] = None Gets or sets key-value-pair metadata associated with an asset.
-
field self_calibration:
Optional[SelfCalibration] = None Gets or sets the last self-calibration of the asset.
-
field serial_number:
Optional[str] = None Gets or sets serial number of the asset.
-
field supports_external_calibration:
Optional[bool] = None Gets or sets whether the asset supports external calibration.
-
field supports_reset:
Optional[bool] = None Gets or sets whether the asset supports reset.
-
field supports_self_calibration:
Optional[bool] = None Gets or sets whether the asset supports self-calibration.
-
field supports_self_test:
Optional[bool] = None Gets or sets whether the asset supports self-test.
-
field temperature_sensors:
Optional[List[TemperatureSensor]] = None Gets or sets an array of temperature sensor information.
-
field vendor_name:
Optional[str] = None Gets or sets vendor name of the asset.
-
field vendor_number:
Optional[int] = None Gets or sets vendor number of the asset.
-
field visa_resource_name:
Optional[str] = None Gets or sets VISA resource name of the asset.
-
field workspace:
Optional[str] = None Gets or sets the ID of the workspace.
- class nisystemlink.clients.assetmanagement.models.AssetBusType(value)[source]
All supported bus types for an asset.
- class nisystemlink.clients.assetmanagement.models.AssetDiscoveryType(value)[source]
All discovery types.
- class nisystemlink.clients.assetmanagement.models.AssetField(value)[source]
Model for an object describing an asset with all of its properties.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetIdentification[source]
Model for object containing properties which identify an asset.
An asset is uniquely identified by a combination of:
bus_typemodel_nameormodel_numbervendor_nameorvendor_numberserial_number
Show JSON schema
{ "title": "AssetIdentification", "description": "Model for object containing properties which identify an asset.\n\nAn asset is uniquely identified by a combination of:\n\n* ``bus_type``\n* ``model_name`` or ``model_number``\n* ``vendor_name`` or ``vendor_number``\n* ``serial_number``", "type": "object", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null } }, "$defs": { "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" } } }
-
field bus_type:
Optional[AssetBusType] = None Bus type for the asset.
-
field model_name:
Optional[str] = None Model name of the asset.
-
field model_number:
Optional[int] = None Model number of the asset.
-
field serial_number:
Optional[str] = None Serial number of the asset.
-
field vendor_name:
Optional[str] = None Vendor name of the asset.
-
field vendor_number:
Optional[int] = None Vendor number of the asset.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetLocation[source]
Model for information about the asset location, presence and the connection status of the system.
Show JSON schema
{ "title": "AssetLocation", "description": "Model for information about the asset location, presence and the connection status of the system.", "type": "object", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresenceWithSystemConnection" } }, "$defs": { "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "AssetPresenceWithSystemConnection": { "description": "Model for the presence of an asset and the connection of the system in which it resides.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" }, "systemConnection": { "anyOf": [ { "$ref": "#/$defs/SystemConnection" }, { "type": "null" } ], "default": null } }, "required": [ "assetPresence" ], "title": "AssetPresenceWithSystemConnection", "type": "object" }, "SystemConnection": { "description": "Whether or not the minion is connected to the server and has updated the server with its data.\nTo maintain compatibility with previous versions of SystemLink, the values\n[APPROVED, UNSUPPORTED, ACTIVATED] are considered equivalent to DISCONNECTED and\n[CONNECTED_UPDATE_PENDING, CONNECTED_UPDATE_SUCCESSFUL, CONNECTED_UPDATE_FAILED] are equivalent to CONNECTED.", "enum": [ "APPROVED", "DISCONNECTED", "CONNECTED_UPDATE_PENDING", "CONNECTED", "CONNECTED_UPDATE_FAILED", "UNSUPPORTED", "ACTIVATED", "CONNECTED_UPDATE_SUCCESSFUL" ], "title": "SystemConnection", "type": "string" } }, "required": [ "state" ] }
- Fields
-
field state:
AssetPresenceWithSystemConnection[Required] Presence of an asset and the connection of the system in which it resides.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetLocationForCreate[source]
Model for information about the asset presence status of the system, used while create
Show JSON schema
{ "title": "AssetLocationForCreate", "description": "Model for information about the asset presence status of the system, used while create", "type": "object", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresence" } }, "$defs": { "AssetPresence": { "description": "Model for the presence of an asset.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" } }, "required": [ "assetPresence" ], "title": "AssetPresence", "type": "object" }, "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" } }, "required": [ "state" ] }
- Fields
-
field state:
AssetPresence[Required] Model for the presence of an asset.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetPresence[source]
Model for the presence of an asset.
Show JSON schema
{ "title": "AssetPresence", "description": "Model for the presence of an asset.", "type": "object", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" } }, "$defs": { "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" } }, "required": [ "assetPresence" ] }
- Fields
-
field asset_presence:
AssetPresenceStatus[Required] Gets or sets the status of an asset’s presence in a system.
- class nisystemlink.clients.assetmanagement.models.AssetPresenceStatus(value)[source]
Status of an asset’s presence in a system.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetPresenceWithSystemConnection[source]
Model for the presence of an asset and the connection of the system in which it resides.
Show JSON schema
{ "title": "AssetPresenceWithSystemConnection", "description": "Model for the presence of an asset and the connection of the system in which it resides.", "type": "object", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" }, "systemConnection": { "anyOf": [ { "$ref": "#/$defs/SystemConnection" }, { "type": "null" } ], "default": null } }, "$defs": { "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "SystemConnection": { "description": "Whether or not the minion is connected to the server and has updated the server with its data.\nTo maintain compatibility with previous versions of SystemLink, the values\n[APPROVED, UNSUPPORTED, ACTIVATED] are considered equivalent to DISCONNECTED and\n[CONNECTED_UPDATE_PENDING, CONNECTED_UPDATE_SUCCESSFUL, CONNECTED_UPDATE_FAILED] are equivalent to CONNECTED.", "enum": [ "APPROVED", "DISCONNECTED", "CONNECTED_UPDATE_PENDING", "CONNECTED", "CONNECTED_UPDATE_FAILED", "UNSUPPORTED", "ACTIVATED", "CONNECTED_UPDATE_SUCCESSFUL" ], "title": "SystemConnection", "type": "string" } }, "required": [ "assetPresence" ] }
- Fields
-
field asset_presence:
AssetPresenceStatus[Required] Gets or sets the status of an asset’s presence in a system.
-
field system_connection:
Optional[SystemConnection] = None Gets or sets whether or not the minion is connected to the server and has updated the server with its data.
- class nisystemlink.clients.assetmanagement.models.AssetType(value)[source]
All supported asset types.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetUtilizationHistoryItem[source]
Model representing an asset utilization history record.
Show JSON schema
{ "title": "AssetUtilizationHistoryItem", "description": "Model representing an asset utilization history record.", "type": "object", "properties": { "utilizationIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationidentifier" }, "assetIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assetidentifier" }, "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Category" }, "taskName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Taskname" }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Username" }, "startTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Starttimestamp" }, "endTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Endtimestamp" }, "heartbeatTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Heartbeattimestamp" } } }
- Fields
-
field asset_identifier:
Optional[str] = None String representing the unique identifier of an asset.
-
field category:
Optional[str] = None String representing the utilization task category.
-
field end_timestamp:
Optional[datetime] = None A date time value which can be used to specify the end of an utilization.
-
field heartbeat_timestamp:
Optional[datetime] = None A date time value which can be used to specify the heartbeat of an utilization.
-
field minion_id:
Optional[str] = None Identifier of the minion where the asset is located.
-
field start_timestamp:
Optional[datetime] = None A date time value which can be used to specify the start of an utilization.
-
field task_name:
Optional[str] = None String representing the name of the task.
-
field user_name:
Optional[str] = None String representing the name of the operator who utilized the asset.
-
field utilization_identifier:
Optional[str] = None String representing the unique identifier of an asset utilization history record.
- pydantic model nisystemlink.clients.assetmanagement.models.AssetUtilizationHistoryResponse[source]
Response model for asset utilization history query.
Show JSON schema
{ "title": "AssetUtilizationHistoryResponse", "description": "Response model for asset utilization history query.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "assetUtilizations": { "anyOf": [ { "items": { "$ref": "#/$defs/AssetUtilizationHistoryItem" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assetutilizations" } }, "$defs": { "AssetUtilizationHistoryItem": { "description": "Model representing an asset utilization history record.", "properties": { "utilizationIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationidentifier" }, "assetIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assetidentifier" }, "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Category" }, "taskName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Taskname" }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Username" }, "startTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Starttimestamp" }, "endTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Endtimestamp" }, "heartbeatTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Heartbeattimestamp" } }, "title": "AssetUtilizationHistoryItem", "type": "object" } } }
- Fields
-
field asset_utilizations:
Optional[List[AssetUtilizationHistoryItem]] = None Array of asset utilizations.
- class nisystemlink.clients.assetmanagement.models.CalibrationMode(value)[source]
Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.
- class nisystemlink.clients.assetmanagement.models.CalibrationStatus(value)[source]
Calibration category the asset belongs to based on the next due calibration date.
- pydantic model nisystemlink.clients.assetmanagement.models.CreateAssetRequest[source]
Model for an object describing the properties for creating an asset.
Show JSON schema
{ "title": "CreateAssetRequest", "description": "Model for an object describing the properties for creating an asset.", "type": "object", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "assetType": { "anyOf": [ { "$ref": "#/$defs/AssetType" }, { "type": "null" } ], "default": null }, "firmwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Firmwareversion" }, "hardwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hardwareversion" }, "visaResourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Visaresourcename" }, "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "supportsSelfCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselfcalibration" }, "supportsExternalCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsexternalcalibration" }, "customCalibrationInterval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Customcalibrationinterval" }, "selfCalibration": { "anyOf": [ { "$ref": "#/$defs/SelfCalibration" }, { "type": "null" } ], "default": null }, "isNIAsset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isniasset" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "location": { "$ref": "#/$defs/AssetLocationForCreate" }, "externalCalibration": { "anyOf": [ { "$ref": "#/$defs/ExternalCalibration" }, { "type": "null" } ], "default": null }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "discoveryType": { "anyOf": [ { "$ref": "#/$defs/AssetDiscoveryType" }, { "type": "null" } ], "default": null }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "supportsSelfTest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselftest" }, "supportsReset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsreset" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" } }, "$defs": { "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetDiscoveryType": { "description": "All discovery types.", "enum": [ "MANUAL", "AUTOMATIC" ], "title": "AssetDiscoveryType", "type": "string" }, "AssetLocationForCreate": { "description": "Model for information about the asset presence status of the system, used while create", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresence" } }, "required": [ "state" ], "title": "AssetLocationForCreate", "type": "object" }, "AssetPresence": { "description": "Model for the presence of an asset.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" } }, "required": [ "assetPresence" ], "title": "AssetPresence", "type": "object" }, "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "AssetType": { "description": "All supported asset types.", "enum": [ "GENERIC", "DEVICE_UNDER_TEST", "FIXTURE", "SYSTEM" ], "title": "AssetType", "type": "string" }, "CalibrationMode": { "description": "Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.", "enum": [ "AUTOMATIC", "MANUAL" ], "title": "CalibrationMode", "type": "string" }, "ExternalCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" }, "recommendedInterval": { "title": "Recommendedinterval", "type": "integer" }, "nextRecommendedDate": { "format": "date-time", "title": "Nextrecommendeddate", "type": "string" }, "nextCustomDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcustomduedate" }, "resolvedDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Resolvedduedate" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comments" }, "entryType": { "anyOf": [ { "$ref": "#/$defs/CalibrationMode" }, { "type": "null" } ], "default": null } }, "required": [ "date", "recommendedInterval", "nextRecommendedDate" ], "title": "ExternalCalibration", "type": "object" }, "SelfCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" } }, "required": [ "date" ], "title": "SelfCalibration", "type": "object" }, "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } }, "required": [ "location" ] }
- Fields
-
field bus_type:
Optional[AssetBusType] = None Gets or sets all supported bus types for an asset.
-
field custom_calibration_interval:
Optional[int] = None Gets or sets the interval represented in months used for computing calibration due date.
-
field discovery_type:
Optional[AssetDiscoveryType] = None Gets or sets the discovery type.
-
field external_calibration:
Optional[ExternalCalibration] = None Gets or sets the last external calibration of the asset.
-
field file_ids:
Optional[List[str]] = None Gets or sets all files linked to the asset.
-
field firmware_version:
Optional[str] = None Gets or sets firmware version of the asset.
-
field hardware_version:
Optional[str] = None Gets or sets hardware version of the asset.
-
field is_NI_asset:
Optional[bool] = None Gets or sets whether this asset is an NI asset (true) or a third-party asset (false).
-
field keywords:
Optional[List[str]] = None Gets or sets words or phrases associated with an asset.
-
field location:
AssetLocationForCreate[Required] Model for information about the asset location, presence and the connection status of the system
-
field model_name:
Optional[str] = None Gets or sets model name of the asset.
-
field model_number:
Optional[int] = None Gets or sets model number of the asset.
-
field name:
Optional[str] = None Gets or sets name of the asset.
-
field part_number:
Optional[str] = None Gets or sets part number of the asset.
-
field properties:
Optional[Dict[str,str]] = None Gets or sets key-value-pair metadata associated with an asset.
-
field self_calibration:
Optional[SelfCalibration] = None Gets or sets the last self-calibration of the asset.
-
field serial_number:
Optional[str] = None Gets or sets serial number of the asset.
-
field supports_external_calibration:
Optional[bool] = None Gets or sets whether the asset supports external calibration.
-
field supports_reset:
Optional[bool] = None Gets or sets whether the asset supports reset.
-
field supports_self_calibration:
Optional[bool] = None Gets or sets whether the asset supports self-calibration.
-
field supports_self_test:
Optional[bool] = None Gets or sets whether the asset supports self-test.
-
field temperature_sensors:
Optional[List[TemperatureSensor]] = None Gets or sets an array of temperature sensor information.
-
field vendor_name:
Optional[str] = None Gets or sets vendor name of the asset.
-
field vendor_number:
Optional[int] = None Gets or sets vendor number of the asset.
-
field visa_resource_name:
Optional[str] = None Gets or sets VISA resource name of the asset.
-
field workspace:
Optional[str] = None Gets or sets the ID of the workspace.
- pydantic model nisystemlink.clients.assetmanagement.models.CreateAssetsPartialSuccessResponse[source]
Model for create Assets Partial Success Response.
Show JSON schema
{ "title": "CreateAssetsPartialSuccessResponse", "description": "Model for create Assets Partial Success Response.", "type": "object", "properties": { "assets": { "anyOf": [ { "items": { "$ref": "#/$defs/Asset" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assets" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateAssetRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "Asset": { "description": "Model for an object describing an asset with all of its properties.", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "assetType": { "anyOf": [ { "$ref": "#/$defs/AssetType" }, { "type": "null" } ], "default": null }, "discoveryType": { "anyOf": [ { "$ref": "#/$defs/AssetDiscoveryType" }, { "type": "null" } ], "default": null }, "firmwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Firmwareversion" }, "hardwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hardwareversion" }, "visaResourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Visaresourcename" }, "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "supportsSelfCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselfcalibration" }, "supportsExternalCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsexternalcalibration" }, "customCalibrationInterval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Customcalibrationinterval" }, "selfCalibration": { "anyOf": [ { "$ref": "#/$defs/SelfCalibration" }, { "type": "null" } ], "default": null }, "isNIAsset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isniasset" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "location": { "anyOf": [ { "$ref": "#/$defs/AssetLocation" }, { "type": "null" } ], "default": null }, "calibrationStatus": { "anyOf": [ { "$ref": "#/$defs/CalibrationStatus" }, { "type": "null" } ], "default": null }, "isSystemController": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Issystemcontroller" }, "externalCalibration": { "anyOf": [ { "$ref": "#/$defs/ExternalCalibration" }, { "type": "null" } ], "default": null }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "lastUpdatedTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Lastupdatedtimestamp" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "supportsSelfTest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselftest" }, "supportsReset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsreset" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "outForCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Outforcalibration" } }, "title": "Asset", "type": "object" }, "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetDiscoveryType": { "description": "All discovery types.", "enum": [ "MANUAL", "AUTOMATIC" ], "title": "AssetDiscoveryType", "type": "string" }, "AssetLocation": { "description": "Model for information about the asset location, presence and the connection status of the system.", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresenceWithSystemConnection" } }, "required": [ "state" ], "title": "AssetLocation", "type": "object" }, "AssetLocationForCreate": { "description": "Model for information about the asset presence status of the system, used while create", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresence" } }, "required": [ "state" ], "title": "AssetLocationForCreate", "type": "object" }, "AssetPresence": { "description": "Model for the presence of an asset.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" } }, "required": [ "assetPresence" ], "title": "AssetPresence", "type": "object" }, "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "AssetPresenceWithSystemConnection": { "description": "Model for the presence of an asset and the connection of the system in which it resides.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" }, "systemConnection": { "anyOf": [ { "$ref": "#/$defs/SystemConnection" }, { "type": "null" } ], "default": null } }, "required": [ "assetPresence" ], "title": "AssetPresenceWithSystemConnection", "type": "object" }, "AssetType": { "description": "All supported asset types.", "enum": [ "GENERIC", "DEVICE_UNDER_TEST", "FIXTURE", "SYSTEM" ], "title": "AssetType", "type": "string" }, "CalibrationMode": { "description": "Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.", "enum": [ "AUTOMATIC", "MANUAL" ], "title": "CalibrationMode", "type": "string" }, "CalibrationStatus": { "description": "Calibration category the asset belongs to based on the next due calibration date.", "enum": [ "OK", "APPROACHING_RECOMMENDED_DUE_DATE", "PAST_RECOMMENDED_DUE_DATE", "OUT_FOR_CALIBRATION" ], "title": "CalibrationStatus", "type": "string" }, "CreateAssetRequest": { "description": "Model for an object describing the properties for creating an asset.", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "assetType": { "anyOf": [ { "$ref": "#/$defs/AssetType" }, { "type": "null" } ], "default": null }, "firmwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Firmwareversion" }, "hardwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hardwareversion" }, "visaResourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Visaresourcename" }, "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "supportsSelfCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselfcalibration" }, "supportsExternalCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsexternalcalibration" }, "customCalibrationInterval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Customcalibrationinterval" }, "selfCalibration": { "anyOf": [ { "$ref": "#/$defs/SelfCalibration" }, { "type": "null" } ], "default": null }, "isNIAsset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isniasset" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "location": { "$ref": "#/$defs/AssetLocationForCreate" }, "externalCalibration": { "anyOf": [ { "$ref": "#/$defs/ExternalCalibration" }, { "type": "null" } ], "default": null }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "discoveryType": { "anyOf": [ { "$ref": "#/$defs/AssetDiscoveryType" }, { "type": "null" } ], "default": null }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "supportsSelfTest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselftest" }, "supportsReset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsreset" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" } }, "required": [ "location" ], "title": "CreateAssetRequest", "type": "object" }, "ExternalCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" }, "recommendedInterval": { "title": "Recommendedinterval", "type": "integer" }, "nextRecommendedDate": { "format": "date-time", "title": "Nextrecommendeddate", "type": "string" }, "nextCustomDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcustomduedate" }, "resolvedDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Resolvedduedate" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comments" }, "entryType": { "anyOf": [ { "$ref": "#/$defs/CalibrationMode" }, { "type": "null" } ], "default": null } }, "required": [ "date", "recommendedInterval", "nextRecommendedDate" ], "title": "ExternalCalibration", "type": "object" }, "SelfCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" } }, "required": [ "date" ], "title": "SelfCalibration", "type": "object" }, "SystemConnection": { "description": "Whether or not the minion is connected to the server and has updated the server with its data.\nTo maintain compatibility with previous versions of SystemLink, the values\n[APPROVED, UNSUPPORTED, ACTIVATED] are considered equivalent to DISCONNECTED and\n[CONNECTED_UPDATE_PENDING, CONNECTED_UPDATE_SUCCESSFUL, CONNECTED_UPDATE_FAILED] are equivalent to CONNECTED.", "enum": [ "APPROVED", "DISCONNECTED", "CONNECTED_UPDATE_PENDING", "CONNECTED", "CONNECTED_UPDATE_FAILED", "UNSUPPORTED", "ACTIVATED", "CONNECTED_UPDATE_SUCCESSFUL" ], "title": "SystemConnection", "type": "string" }, "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } } }
-
field failed:
Optional[List[CreateAssetRequest]] = None Gets or sets array of assets create requests that failed.
-
field failed:
- pydantic model nisystemlink.clients.assetmanagement.models.DeleteAssetsResponse[source]
Model for delete Assets Response containing the ids of the assets which were deleted
Show JSON schema
{ "title": "DeleteAssetsResponse", "description": "Model for delete Assets Response containing the ids of the assets which were deleted", "type": "object", "properties": { "ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Ids" }, "failed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
-
field failed:
Optional[List[str]] = None Gets or sets array of asset identifiers that failed to delete.
-
field ids:
Optional[List[str]] = None Gets or sets array of asset identifiers which were deleted.
-
field failed:
- pydantic model nisystemlink.clients.assetmanagement.models.ExternalCalibration[source]
Show JSON schema
{ "title": "ExternalCalibration", "type": "object", "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" }, "recommendedInterval": { "title": "Recommendedinterval", "type": "integer" }, "nextRecommendedDate": { "format": "date-time", "title": "Nextrecommendeddate", "type": "string" }, "nextCustomDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcustomduedate" }, "resolvedDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Resolvedduedate" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comments" }, "entryType": { "anyOf": [ { "$ref": "#/$defs/CalibrationMode" }, { "type": "null" } ], "default": null } }, "$defs": { "CalibrationMode": { "description": "Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.", "enum": [ "AUTOMATIC", "MANUAL" ], "title": "CalibrationMode", "type": "string" }, "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } }, "required": [ "date", "recommendedInterval", "nextRecommendedDate" ] }
- Fields
- field comments: str | None = None
Gets or sets calibration comments provided by an operator.
- field date: datetime [Required]
Gets or sets ISO-8601 formatted timestamp specifying the last date the asset was externally calibrated.
- field entry_type: CalibrationMode | None = None
Gets or sets whether automatically discovered the calibration data for an asset or manually entered.
- field is_limited: bool | None = None
Gets or sets whether the last external calibration of the asset was a limited calibration.
- field next_custom_due_date: datetime | None = None
Gets or sets ISO-8601 formatted timestamp specifying the date for the next external calibration.
- field next_recommended_date: datetime [Required]
Gets or sets ISO-8601 formatted timestamp specifying the recommended date for the next external calibration.
- field recommended_interval: int [Required]
Gets or sets the manufacturer’s recommended calibration interval in months.
- field resolved_due_date: datetime | None = None
Gets ISO-8601 formatted timestamp specifying the resolved due date for external calibration.
- field temperature_sensors: List[TemperatureSensor] | None = None
Gets or sets an array of temperature sensor information.
- pydantic model nisystemlink.clients.assetmanagement.models.LinkFilesPartialSuccessResponse[source]
Model for a Link Files Partial Success Response.
Show JSON schema
{ "title": "LinkFilesPartialSuccessResponse", "description": "Model for a Link Files Partial Success Response.", "type": "object", "properties": { "succeeded": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Succeeded" }, "failed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
-
field failed:
Optional[List[str]] = None Gets or sets array of file IDs that failed to link to assets.
-
field succeeded:
Optional[List[str]] = None Gets or sets array of file IDs that were successfully linked to assets.
-
field failed:
- pydantic model nisystemlink.clients.assetmanagement.models.QueryAssetUtilizationHistoryRequest[source]
Model for object containing filters for asset utilization and assets.
Show JSON schema
{ "title": "QueryAssetUtilizationHistoryRequest", "description": "Model for object containing filters for asset utilization and assets.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "utilizationFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationfilter" }, "assetFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assetfilter" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/UtilizationOrderBy" }, { "type": "null" } ], "default": null }, "orderByDescending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Orderbydescending" }, "startTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Starttime" }, "endTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Endtime" } }, "$defs": { "UtilizationOrderBy": { "description": "Field by which asset utilization history records can be ordered/sorted.", "enum": [ "START_TIMESTAMP" ], "title": "UtilizationOrderBy", "type": "string" } } }
-
field asset_filter:
Optional[str] = None The filter criteria for assets. Consists of a string of queries composed using AND/OR operators. Valid properties include AssetIdentifier, SerialNumber, ModelName, VendorName, Location.MinionId, and many others.
-
field end_time:
Optional[datetime] = None End of the date range. Defaults to current time.
-
field order_by:
Optional[UtilizationOrderBy] = None The field to order results by. If not provided, default ordering is applied.
-
field order_by_descending:
Optional[bool] = None Whether to return the asset utilization history records in descending order.
-
field start_time:
Optional[datetime] = None Start of the date range. Defaults to 90 days ago.
-
field take:
Optional[int] = None The maximum number of asset utilization history records to return.
-
field utilization_filter:
Optional[str] = None The filter criteria for asset utilization. Consists of a string of queries composed using AND/OR operators. Valid properties: MinionId, Category, UserName, TaskName, StartTimestamp, EndTimestamp.
-
field asset_filter:
- pydantic model nisystemlink.clients.assetmanagement.models.QueryAssetsRequest[source]
Model for object containing filters to apply when retrieving assets.
Show JSON schema
{ "title": "QueryAssetsRequest", "description": "Model for object containing filters to apply when retrieving assets.", "type": "object", "properties": { "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/AssetField" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" }, "skip": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Skip" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/OrderBy" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "returnCount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Returncount" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "$defs": { "AssetField": { "description": "Model for an object describing an asset with all of its properties.", "enum": [ "MODEL_NAME", "MODEL_NUMBER", "SERIAL_NUMBER", "VENDOR_NAME", "VENDOR_NUMBER", "BUS_TYPE", "NAME", "ASSET_TYPE", "DISCOVERY_TYPE", "FIRMWARE_VERSION", "HARDWARE_VERSION", "VISA_RESOURCE_NAME", "TEMPERATURE_SENSORS", "SUPPORTS_SELF_CALIBRATION", "SUPPORTS_EXTERNAL_CALIBRATION", "CUSTOM_CALIBRATION_INTERVAL", "SELF_CALIBRATION", "IS_NI_ASSET", "ID", "LOCATION", "CALIBRATION_STATUS", "IS_SYSTEM_CONTROLLER", "EXTERNAL_CALIBRATION", "WORKSPACE", "PROPERTIES", "KEYWORDS", "LAST_UPDATE", "FILES_IDS", "SUPPORTS_SELF_RESET", "SUPPORTS_RESET", "PART_NUMBER", "OUT_FOR_CALIBRATION" ], "title": "AssetField", "type": "string" }, "OrderBy": { "description": "Field by which assets can be ordered/sorted. If OrderBy is not specified, no sorting will applied.", "enum": [ "LAST_UPDATED_TIMESTAMP" ], "title": "OrderBy", "type": "string" } } }
-
field descending:
Optional[bool] = None Whether to return the assets in the descending order. If OrderBy is not specified, this property is ignored.
-
field filter:
Optional[str] = None Gets or sets the filter criteria for assets. Consists of a string of queries composed using AND/OR operators.
-
field order_by:
Optional[OrderBy] = None Field by which assets can be ordered/sorted. If OrderBy is not specified, no sorting will applied.
-
field projection:
Optional[List[AssetField]] = None Gets or sets the projection to be used when retrieving the assets. If not specified, all properties will be returned.
-
field return_count:
Optional[bool] = None Gets or sets Whether to return the total number of assets which match the provided filter, disregarding the take value.
-
field skip:
Optional[int] = None Gets or sets the number of resources to skip in the result when paging.
-
field take:
Optional[int] = None Gets or sets how many resources to return in the result, or -1 to use a default defined by the service.
-
field descending:
- pydantic model nisystemlink.clients.assetmanagement.models.QueryAssetsResponse[source]
Model for assets Response containing the assets satisfying the query and the total count of matching assets.
Show JSON schema
{ "title": "QueryAssetsResponse", "description": "Model for assets Response containing the assets satisfying the query and the total count of matching assets.", "type": "object", "properties": { "assets": { "anyOf": [ { "items": { "$ref": "#/$defs/Asset" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assets" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "Asset": { "description": "Model for an object describing an asset with all of its properties.", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "assetType": { "anyOf": [ { "$ref": "#/$defs/AssetType" }, { "type": "null" } ], "default": null }, "discoveryType": { "anyOf": [ { "$ref": "#/$defs/AssetDiscoveryType" }, { "type": "null" } ], "default": null }, "firmwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Firmwareversion" }, "hardwareVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hardwareversion" }, "visaResourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Visaresourcename" }, "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "supportsSelfCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselfcalibration" }, "supportsExternalCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsexternalcalibration" }, "customCalibrationInterval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Customcalibrationinterval" }, "selfCalibration": { "anyOf": [ { "$ref": "#/$defs/SelfCalibration" }, { "type": "null" } ], "default": null }, "isNIAsset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isniasset" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "location": { "anyOf": [ { "$ref": "#/$defs/AssetLocation" }, { "type": "null" } ], "default": null }, "calibrationStatus": { "anyOf": [ { "$ref": "#/$defs/CalibrationStatus" }, { "type": "null" } ], "default": null }, "isSystemController": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Issystemcontroller" }, "externalCalibration": { "anyOf": [ { "$ref": "#/$defs/ExternalCalibration" }, { "type": "null" } ], "default": null }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "lastUpdatedTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Lastupdatedtimestamp" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "supportsSelfTest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsselftest" }, "supportsReset": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Supportsreset" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "outForCalibration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Outforcalibration" } }, "title": "Asset", "type": "object" }, "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetDiscoveryType": { "description": "All discovery types.", "enum": [ "MANUAL", "AUTOMATIC" ], "title": "AssetDiscoveryType", "type": "string" }, "AssetLocation": { "description": "Model for information about the asset location, presence and the connection status of the system.", "properties": { "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "physicalLocation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Physicallocation" }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent" }, "resourceUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceuri" }, "slotNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Slotnumber" }, "state": { "$ref": "#/$defs/AssetPresenceWithSystemConnection" } }, "required": [ "state" ], "title": "AssetLocation", "type": "object" }, "AssetPresenceStatus": { "description": "Status of an asset's presence in a system.", "enum": [ "INITIALIZING", "UNKNOWN", "NOT_PRESENT", "PRESENT" ], "title": "AssetPresenceStatus", "type": "string" }, "AssetPresenceWithSystemConnection": { "description": "Model for the presence of an asset and the connection of the system in which it resides.", "properties": { "assetPresence": { "$ref": "#/$defs/AssetPresenceStatus" }, "systemConnection": { "anyOf": [ { "$ref": "#/$defs/SystemConnection" }, { "type": "null" } ], "default": null } }, "required": [ "assetPresence" ], "title": "AssetPresenceWithSystemConnection", "type": "object" }, "AssetType": { "description": "All supported asset types.", "enum": [ "GENERIC", "DEVICE_UNDER_TEST", "FIXTURE", "SYSTEM" ], "title": "AssetType", "type": "string" }, "CalibrationMode": { "description": "Whether SystemLink automatically discovered the calibration data for an asset or if it was manually entered.", "enum": [ "AUTOMATIC", "MANUAL" ], "title": "CalibrationMode", "type": "string" }, "CalibrationStatus": { "description": "Calibration category the asset belongs to based on the next due calibration date.", "enum": [ "OK", "APPROACHING_RECOMMENDED_DUE_DATE", "PAST_RECOMMENDED_DUE_DATE", "OUT_FOR_CALIBRATION" ], "title": "CalibrationStatus", "type": "string" }, "ExternalCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" }, "recommendedInterval": { "title": "Recommendedinterval", "type": "integer" }, "nextRecommendedDate": { "format": "date-time", "title": "Nextrecommendeddate", "type": "string" }, "nextCustomDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Nextcustomduedate" }, "resolvedDueDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Resolvedduedate" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comments" }, "entryType": { "anyOf": [ { "$ref": "#/$defs/CalibrationMode" }, { "type": "null" } ], "default": null } }, "required": [ "date", "recommendedInterval", "nextRecommendedDate" ], "title": "ExternalCalibration", "type": "object" }, "SelfCalibration": { "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" } }, "required": [ "date" ], "title": "SelfCalibration", "type": "object" }, "SystemConnection": { "description": "Whether or not the minion is connected to the server and has updated the server with its data.\nTo maintain compatibility with previous versions of SystemLink, the values\n[APPROVED, UNSUPPORTED, ACTIVATED] are considered equivalent to DISCONNECTED and\n[CONNECTED_UPDATE_PENDING, CONNECTED_UPDATE_SUCCESSFUL, CONNECTED_UPDATE_FAILED] are equivalent to CONNECTED.", "enum": [ "APPROVED", "DISCONNECTED", "CONNECTED_UPDATE_PENDING", "CONNECTED", "CONNECTED_UPDATE_FAILED", "UNSUPPORTED", "ACTIVATED", "CONNECTED_UPDATE_SUCCESSFUL" ], "title": "SystemConnection", "type": "string" }, "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } } }
- Fields
-
field total_count:
Optional[int] = None Gets or sets the total number of Assets which match the query.
- pydantic model nisystemlink.clients.assetmanagement.models.SelfCalibration[source]
Show JSON schema
{ "title": "SelfCalibration", "type": "object", "properties": { "temperatureSensors": { "anyOf": [ { "items": { "$ref": "#/$defs/TemperatureSensor" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Temperaturesensors" }, "isLimited": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Islimited" }, "date": { "format": "date-time", "title": "Date", "type": "string" } }, "$defs": { "TemperatureSensor": { "description": "Temperature sensor information.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ], "title": "TemperatureSensor", "type": "object" } }, "required": [ "date" ] }
- Fields
- field date: datetime [Required]
Gets or sets ISO-8601 formatted timestamp specifying the last date the asset was self-calibrated.
- field is_limited: bool | None = None
Gets or sets whether the last self-calibration of the asset was a limited calibration.
- field temperature_sensors: List[TemperatureSensor] | None = None
Gets or sets an array of temperature sensor information.
- pydantic model nisystemlink.clients.assetmanagement.models.StartUtilizationPartialSuccessResponse[source]
Response model for start utilization operation with partial success support.
Show JSON schema
{ "title": "StartUtilizationPartialSuccessResponse", "description": "Response model for start utilization operation with partial success support.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "assetsWithStartedUtilization": { "anyOf": [ { "items": { "$ref": "#/$defs/AssetIdentification" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assetswithstartedutilization" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/AssetIdentification" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetIdentification": { "description": "Model for object containing properties which identify an asset.\n\nAn asset is uniquely identified by a combination of:\n\n* ``bus_type``\n* ``model_name`` or ``model_number``\n* ``vendor_name`` or ``vendor_number``\n* ``serial_number``", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null } }, "title": "AssetIdentification", "type": "object" } } }
-
field assets_with_started_utilization:
Optional[List[AssetIdentification]] = None Array containing the asset identification data for the assets that started being utilized.
-
field failed:
Optional[List[AssetIdentification]] = None Array containing the asset identification data for the assets that failed to start being utilized.
-
field assets_with_started_utilization:
- pydantic model nisystemlink.clients.assetmanagement.models.StartUtilizationRequest[source]
Request model for starting asset utilization tracking.
Show JSON schema
{ "title": "StartUtilizationRequest", "description": "Request model for starting asset utilization tracking.", "type": "object", "properties": { "utilizationIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationidentifier" }, "minionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Minionid" }, "assetIdentifications": { "anyOf": [ { "items": { "$ref": "#/$defs/AssetIdentification" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Assetidentifications" }, "utilizationCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationcategory" }, "taskName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Taskname" }, "userName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Username" }, "utilizationTimestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Utilizationtimestamp" } }, "$defs": { "AssetBusType": { "description": "All supported bus types for an asset.", "enum": [ "BUILT_IN_SYSTEM", "PCI_PXI", "USB", "GPIB", "VXI", "SERIAL", "TCP_IP", "CRIO", "SCXI", "CDAQ", "SWITCH_BLOCK", "SCC", "FIRE_WIRE", "ACCESSORY", "CAN", "SWITCH_BLOCK_DEVICE", "SLSC" ], "title": "AssetBusType", "type": "string" }, "AssetIdentification": { "description": "Model for object containing properties which identify an asset.\n\nAn asset is uniquely identified by a combination of:\n\n* ``bus_type``\n* ``model_name`` or ``model_number``\n* ``vendor_name`` or ``vendor_number``\n* ``serial_number``", "properties": { "modelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Modelname" }, "modelNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Modelnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "vendorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Vendorname" }, "vendorNumber": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Vendornumber" }, "busType": { "anyOf": [ { "$ref": "#/$defs/AssetBusType" }, { "type": "null" } ], "default": null } }, "title": "AssetIdentification", "type": "object" } } }
- Fields
-
field asset_identifications:
Optional[List[AssetIdentification]] = None Array of the identification information for the assets which are utilized. The maximum number of asset identifications allowed per request is 100.
-
field minion_id:
Optional[str] = None Identifier of the minion where the utilized assets are located.
-
field task_name:
Optional[str] = None String representing the name of the task.
-
field user_name:
Optional[str] = None String representing the name of the operator who utilized the asset.
-
field utilization_category:
Optional[str] = None String representing the utilization category.
-
field utilization_identifier:
Optional[str] = None String representing the unique identifier of an asset utilization history record.
-
field utilization_timestamp:
Optional[datetime] = None A date time value which can be used to specify the start of an utilization.
- pydantic model nisystemlink.clients.assetmanagement.models.TemperatureSensor[source]
Temperature sensor information.
Show JSON schema
{ "title": "TemperatureSensor", "description": "Temperature sensor information.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "reading": { "title": "Reading", "type": "number" } }, "required": [ "reading" ] }
- field name: str | None = None
Gets or sets sensor name.
- field reading: float [Required]
Gets or sets sensor reading.
- pydantic model nisystemlink.clients.assetmanagement.models.UpdateUtilizationPartialSuccessResponse[source]
Response model for update utilization operation with partial success support.
Show JSON schema
{ "title": "UpdateUtilizationPartialSuccessResponse", "description": "Response model for update utilization operation with partial success support.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "updatedUtilizationIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Updatedutilizationids" }, "failed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field failed:
Optional[List[str]] = None Array of utilization identifiers for the entries that failed to update.
-
field updated_utilization_ids:
Optional[List[str]] = None Array of utilization identifiers for the entries that were updated.