nisystemlink.clients.testmonitor

class nisystemlink.clients.testmonitor.TestMonitorClient(configuration=None)

__init__(configuration=None)

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, the HttpConfigurationManager is used to obtain the configuration.

Raises

ApiException – if unable to communicate with the TestMonitor Service.

create_results(results)

Creates one or more results and returns errors for failed creations.

Parameters

results (List[nisystemlink.clients.testmonitor.models.CreateResultRequest]) – A list of results to attempt to create.

Return type

nisystemlink.clients.testmonitor.models.CreateResultsPartialSuccess

Returns: A list of created results, results that failed to create, and errors for

failures.

Raises

ApiException – if unable to communicate with the /nitestmonitor service of provided invalid arguments.

get_results(continuation_token=None, take=None, return_count=None)

Reads a list of results.

Parameters

• continuation_token (Optional[str]) – The token used to paginate results.

• take (Optional[int]) – The number of results to get in this request.

• return_count (Optional[bool]) – Whether or not to return the total number of results available.

Return type

nisystemlink.clients.testmonitor.models.PagedResults

Returns

A list of results.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided an invalid argument.

query_results(query)

Queries for results that match the filter.

Parameters

query (nisystemlink.clients.testmonitor.models.QueryResultsRequest) – The query contains a DynamicLINQ query string in addition to other details about how to filter and return the list of results.

Return type

nisystemlink.clients.testmonitor.models.PagedResults

Returns

A paged list of results with a continuation token to get the next page.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided invalid arguments.

query_result_values(query)

Queries for results that match the query and returns a list of the requested field.

Parameters

query (nisystemlink.clients.testmonitor.models.QueryResultValuesRequest) – The query for the fields.

Return type

List[str]

Returns

A list of the values of the queried field.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided invalid arguments.

update_results(results, replace=False)

Updates a list of results with optional field replacement.

Parameters

• results – A list of results to update. Results are matched for update by id.

• replace –

  Replace the existing fields instead of merging them. Defaults to False. If this is True, then keywords and properties for the result will be

  replaced by what is in the results provided in this request.

  If this is False, then the keywords and properties in this request will

  merge with what is already present in the server resource.

Return type

nisystemlink.clients.testmonitor.models.UpdateResultsPartialSuccess

Returns: A list of updates results, results that failed to update, and errors for

failures.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided an invalid argument.

delete_result(id)

Deletes a single result by id.

Parameters

id (str) – Unique ID of a result.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided an invalid argument.

Return type

None

delete_results(ids)

Deletes multiple results.

Parameters

ids (List[str]) – List of unique IDs of results.

Return type

Optional[nisystemlink.clients.testmonitor.models.DeleteResultsPartialSuccess]

Returns

A partial success if any results failed to delete, or None if all results were deleted successfully.

Raises

ApiException – if unable to communicate with the /nitestmonitor Service or provided an invalid argument.

create_steps(steps, update_result_total_time=False)

Creates one or more steps.

Parameters

• steps (List[nisystemlink.clients.testmonitor.models.CreateStepRequest]) – A list of steps to create.

• update_result_total_time (bool) – Determine test result total time from the step total times. Defaults to False.

Return type

nisystemlink.clients.testmonitor.models.CreateStepsPartialSuccess

Returns

A list of steps that were successfully created and ones that failed to be created.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

query_steps(query)

Queries for steps that match the filters.

Parameters

query (nisystemlink.clients.testmonitor.models.QueryStepsRequest) – The query contains a product ID as well as a filter for steps under that product.

Return type

nisystemlink.clients.testmonitor.models.PagedSteps

Returns

A list of steps that match the filter.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

query_step_values(query)

Queries values for a step field.

Parameters

query (nisystemlink.clients.testmonitor.models.QueryStepValuesRequest) – The query parameters.

Return type

List[str]

Returns

A list of values for the specified step field.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

delete_steps(steps)

Deletes one or more steps by global ID.

Parameters

• steps (List[nisystemlink.clients.testmonitor.models.StepIdResultIdPair]) – A list of step IDs and result IDs. Note that these are the global IDs and not the

• workspace. (step_id that is local to a product and) –

Return type

Optional[nisystemlink.clients.testmonitor.models.DeleteStepsPartialSuccess]

Returns

None if all deletes succeed otherwise a list of which IDs failed and which succeeded.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there

• invalid arguments. –

delete_step(result_id, step_id, update_result_total_time=False)

Deletes a single step.

Parameters

• result_id (str) – The resultId of the step to delete.

• step_id (str) – The stepId of the step to delete.

• update_result_total_time (Optional[bool]) – Determine test result total time from the step total times. Defaults to False.

Return type

None

Returns

None

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

update_steps(steps, update_result_total_time=False, replace_keywords=False, replace_properties=False)

Updates one or more steps.

Update requires that the version field matches the version being updated from.

Parameters

• steps (List[nisystemlink.clients.testmonitor.models.UpdateStepRequest]) – a list of steps that are to be updated. Must include the global ID and

• server. (each step being updated must match the version currently on the) –

• update_result_total_time (bool) – Determine test result total time from the step total times. Defaults to False.

• replace_keywords (bool) – Replace with existing keywords instead of merging them. Defaults to False.

• replace_properties (bool) – Replace with existing properties instead of merging them. Defaults to False.

Return type

nisystemlink.clients.testmonitor.models.UpdateStepsPartialSuccess

Returns

A list of steps that were successfully updated and a list of ones that were not along with error messages for updates that failed.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

get_steps(continuation_token=None, take=None, return_count=None)

Reads a list of steps.

Parameters

• continuation_token (Optional[str]) – The token used to paginate steps.

• take (Optional[int]) – The number of steps to get in this request.

• return_count (Optional[bool]) – Whether or not to return the total number of steps available.

Return type

nisystemlink.clients.testmonitor.models.PagedSteps

Returns

A list of steps.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments.. –

get_step(result_id, step_id)

Gets a single step.

Parameters

• result_id (str) – The resultId of the step to get.

• step_id (str) – The stepId of the step to get.

Return type

nisystemlink.clients.testmonitor.models.Step

Returns

The step.

Raises

• ApiException – if unable to communicate with the /nitestmonitor service or if there are

• invalid arguments. –

pydantic model nisystemlink.clients.testmonitor.models.ApiInfo

Information about the available API operations.

Show JSON schema

{
   "title": "ApiInfo",
   "description": "Information about the available API operations.",
   "type": "object",
   "properties": {
      "operations": {
         "$ref": "#/definitions/V2Operations"
      }
   },
   "required": [
      "operations"
   ],
   "definitions": {
      "Operation": {
         "title": "Operation",
         "description": "Represents an operation that can be performed on a data frame.",
         "type": "object",
         "properties": {
            "available": {
               "title": "Available",
               "type": "boolean"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "available",
            "version"
         ]
      },
      "V2Operations": {
         "title": "V2Operations",
         "description": "The operations available in the routes provided by the v2 HTTP API.",
         "type": "object",
         "properties": {
            "getProducts": {
               "$ref": "#/definitions/Operation"
            },
            "queryProducts": {
               "$ref": "#/definitions/Operation"
            },
            "createProducts": {
               "$ref": "#/definitions/Operation"
            },
            "updateProducts": {
               "$ref": "#/definitions/Operation"
            },
            "deleteProducts": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManyProducts": {
               "$ref": "#/definitions/Operation"
            },
            "getResults": {
               "$ref": "#/definitions/Operation"
            },
            "getResultsPropertyKeys": {
               "$ref": "#/definitions/Operation"
            },
            "queryResults": {
               "$ref": "#/definitions/Operation"
            },
            "createResults": {
               "$ref": "#/definitions/Operation"
            },
            "updateResults": {
               "$ref": "#/definitions/Operation"
            },
            "deleteResult": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManyResults": {
               "$ref": "#/definitions/Operation"
            },
            "getSteps": {
               "$ref": "#/definitions/Operation"
            },
            "querySteps": {
               "$ref": "#/definitions/Operation"
            },
            "createSteps": {
               "$ref": "#/definitions/Operation"
            },
            "updateSteps": {
               "$ref": "#/definitions/Operation"
            },
            "deleteStep": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManySteps": {
               "$ref": "#/definitions/Operation"
            },
            "queryPaths": {
               "$ref": "#/definitions/Operation"
            }
         },
         "required": [
            "getProducts",
            "queryProducts",
            "createProducts",
            "updateProducts",
            "deleteProducts",
            "deleteManyProducts",
            "getResults",
            "getResultsPropertyKeys",
            "queryResults",
            "createResults",
            "updateResults",
            "deleteResult",
            "deleteManyResults",
            "getSteps",
            "querySteps",
            "createSteps",
            "updateSteps",
            "deleteStep",
            "deleteManySteps",
            "queryPaths"
         ]
      }
   }
}

Fields

• operations

field operations: V2Operations [Required]

pydantic model nisystemlink.clients.testmonitor.models.CreateResultRequest

Contains information about a result.

Show JSON schema

{
   "title": "CreateResultRequest",
   "description": "Contains information about a result.",
   "type": "object",
   "properties": {
      "status": {
         "$ref": "#/definitions/Status"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "programName": {
         "title": "Programname",
         "type": "string"
      },
      "systemId": {
         "title": "Systemid",
         "type": "string"
      },
      "hostName": {
         "title": "Hostname",
         "type": "string"
      },
      "partNumber": {
         "title": "Partnumber",
         "type": "string"
      },
      "serialNumber": {
         "title": "Serialnumber",
         "type": "string"
      },
      "totalTimeInSeconds": {
         "title": "Totaltimeinseconds",
         "type": "number"
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "operator": {
         "title": "Operator",
         "type": "string"
      },
      "fileIds": {
         "title": "Fileids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "dataTableIds": {
         "title": "Datatableids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "required": [
      "status",
      "programName"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      }
   }
}

Fields

• data_table_ids

• file_ids

• host_name

• keywords

• operator

• part_number

• program_name

• properties

• serial_number

• started_at

• status

• system_id

• total_time_in_seconds

• workspace

field data_table_ids: Optional[List[str]] = None

A list of data table ids that are attached to this result.

field file_ids: Optional[List[str]] = None

A list of file ids that are attached to this result.

field host_name: Optional[str] = None

The name of the host that generated this result.

field keywords: Optional[List[str]] = None

A list of keywords that categorize this result.

field operator: Optional[str] = None

The operator that ran the result.

field part_number: Optional[str] = None

The part number is the unique identifier of a product within a single org.

field program_name: str [Required]

The name of the program that generated this result.

field properties: Optional[Dict[str, Optional[str]]] = None

A list of custom properties for this result.

field serial_number: Optional[str] = None

The serial number of the system that generated this result.

field started_at: Optional[datetime] = None

The time that the result started.

field status: Status [Required]

The status of the result.

field system_id: Optional[str] = None

The id of the system that generated this result.

field total_time_in_seconds: Optional[float] = None

The total time that the result took to run in seconds.

field workspace: Optional[str] = None

The id of the workspace that this product belongs to.

pydantic model nisystemlink.clients.testmonitor.models.CreateResultsPartialSuccess

Show JSON schema

{
   "title": "CreateResultsPartialSuccess",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "results": {
         "title": "Results",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Result"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CreateResultRequest"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "results"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "Result": {
         "title": "Result",
         "description": "Contains information about a result.",
         "type": "object",
         "properties": {
            "status": {
               "$ref": "#/definitions/Status"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "programName": {
               "title": "Programname",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "systemId": {
               "title": "Systemid",
               "type": "string"
            },
            "hostName": {
               "title": "Hostname",
               "type": "string"
            },
            "partNumber": {
               "title": "Partnumber",
               "type": "string"
            },
            "serialNumber": {
               "title": "Serialnumber",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "operator": {
               "title": "Operator",
               "type": "string"
            },
            "fileIds": {
               "title": "Fileids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "dataTableIds": {
               "title": "Datatableids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "statusTypeSummary": {
               "title": "Statustypesummary",
               "type": "object",
               "additionalProperties": {
                  "type": "integer"
               }
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         }
      },
      "CreateResultRequest": {
         "title": "CreateResultRequest",
         "description": "Contains information about a result.",
         "type": "object",
         "properties": {
            "status": {
               "$ref": "#/definitions/Status"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "programName": {
               "title": "Programname",
               "type": "string"
            },
            "systemId": {
               "title": "Systemid",
               "type": "string"
            },
            "hostName": {
               "title": "Hostname",
               "type": "string"
            },
            "partNumber": {
               "title": "Partnumber",
               "type": "string"
            },
            "serialNumber": {
               "title": "Serialnumber",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "operator": {
               "title": "Operator",
               "type": "string"
            },
            "fileIds": {
               "title": "Fileids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "dataTableIds": {
               "title": "Datatableids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         },
         "required": [
            "status",
            "programName"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• results

field error: Optional[ApiError] = None

Error messages for results that were not created. If this is None, then all results were successfully created.

field failed: Optional[List[CreateResultRequest]] = None

The list of results that were not created. If this is None, then all results were successfully created.

field results: List[Result] [Required]

The list of results that were successfully created.

pydantic model nisystemlink.clients.testmonitor.models.CreateStepRequest

Show JSON schema

{
   "$ref": "#/definitions/CreateStepRequest",
   "definitions": {
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      },
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "CreateStepRequest": {
         "title": "CreateStepRequest",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "children": {
               "title": "Children",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CreateStepRequest"
               }
            }
         },
         "required": [
            "stepId",
            "resultId",
            "name"
         ]
      }
   }
}

Fields

• children

• name

field children: Optional[List[CreateStepRequest]] = None

Nested child steps.

field name: str [Required]

Step name.

pydantic model nisystemlink.clients.testmonitor.models.CreateStepsPartialSuccess

Show JSON schema

{
   "title": "CreateStepsPartialSuccess",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "steps": {
         "title": "Steps",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Step"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CreateStepRequest"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "steps"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      },
      "Step": {
         "title": "Step",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "path": {
               "title": "Path",
               "type": "string"
            },
            "pathIds": {
               "title": "Pathids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "integer"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "hasChildren": {
               "title": "Haschildren",
               "type": "boolean"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         }
      },
      "CreateStepRequest": {
         "title": "CreateStepRequest",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "children": {
               "title": "Children",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CreateStepRequest"
               }
            }
         },
         "required": [
            "stepId",
            "resultId",
            "name"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• steps

field error: Optional[ApiError] = None

Error messages for steps that were not created.

If this is None, then all steps were successfully created.

field failed: Optional[List[CreateStepRequest]] = None

The list of step requests that failed.

If this is None, then all steps were successfully created.

field steps: List[Step] [Required]

The list of steps that were successfully created.

pydantic model nisystemlink.clients.testmonitor.models.DeleteResultsPartialSuccess

The result of deleting multiple results when one or more results could not be deleted.

Show JSON schema

{
   "title": "DeleteResultsPartialSuccess",
   "description": "The result of deleting multiple results when one or more results could not be deleted.",
   "type": "object",
   "properties": {
      "ids": {
         "title": "Ids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "ids"
   ],
   "definitions": {
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• ids

field error: Optional[ApiError] = None

The error that occurred when deleting the results.

field failed: Optional[List[str]] = None

The IDs of the results that could not be deleted.

field ids: List[str] [Required]

The IDs of the results that were successfully deleted.

pydantic model nisystemlink.clients.testmonitor.models.DeleteStepsPartialSuccess

The result of deleting multiple steps when one or more steps could not be deleted.

Show JSON schema

{
   "title": "DeleteStepsPartialSuccess",
   "description": "The result of deleting multiple steps when one or more steps could not be deleted.",
   "type": "object",
   "properties": {
      "steps": {
         "title": "Steps",
         "type": "array",
         "items": {
            "$ref": "#/definitions/StepIdResultIdPair"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "$ref": "#/definitions/StepIdResultIdPair"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "steps"
   ],
   "definitions": {
      "StepIdResultIdPair": {
         "title": "StepIdResultIdPair",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            }
         },
         "required": [
            "stepId",
            "resultId"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• steps

field error: Optional[ApiError] = None

The error that occurred when deleting the steps.

field failed: Optional[List[StepIdResultIdPair]] = None

The step_id and result_id pairs of the steps that could not be deleted.

field steps: List[StepIdResultIdPair] [Required]

The step_id and result_id pairs of the steps that were successfully deleted.

pydantic model nisystemlink.clients.testmonitor.models.Measurement

Show JSON schema

{
   "title": "Measurement",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "status": {
         "title": "Status",
         "type": "string"
      },
      "measurement": {
         "title": "Measurement",
         "type": "string"
      },
      "lowLimit": {
         "title": "Lowlimit",
         "type": "string"
      },
      "highLimit": {
         "title": "Highlimit",
         "type": "string"
      },
      "units": {
         "title": "Units",
         "type": "string"
      },
      "comparisonType": {
         "title": "Comparisontype",
         "type": "string"
      }
   }
}

Fields

• comparisonType

• highLimit

• lowLimit

• measurement

• name

• status

• units

field comparisonType: Optional[str] = None

field highLimit: Optional[str] = None

field lowLimit: Optional[str] = None

field measurement: Optional[str] = None

field name: Optional[str] = None

field status: Optional[str] = None

field units: Optional[str] = None

pydantic model nisystemlink.clients.testmonitor.models.NamedValue

Show JSON schema

{
   "title": "NamedValue",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "value": {
         "title": "Value"
      }
   },
   "required": [
      "name"
   ]
}

Fields

• name

• value

field name: str [Required]

The name of the value.

field value: Any = None

The value.

pydantic model nisystemlink.clients.testmonitor.models.Operation

Represents an operation that can be performed on a data frame.

Show JSON schema

{
   "title": "Operation",
   "description": "Represents an operation that can be performed on a data frame.",
   "type": "object",
   "properties": {
      "available": {
         "title": "Available",
         "type": "boolean"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      }
   },
   "required": [
      "available",
      "version"
   ]
}

Fields

• available

• version

field available: bool [Required]

Whether or not the operation is available to the caller (e.g. due to permissions).

field version: int [Required]

The version of the available operation.

pydantic model nisystemlink.clients.testmonitor.models.PagedResults

The response for a Results query containing matched results.

Show JSON schema

{
   "title": "PagedResults",
   "description": "The response for a Results query containing matched results.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "results": {
         "title": "Results",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Result"
         }
      },
      "totalCount": {
         "title": "Totalcount",
         "type": "integer"
      }
   },
   "required": [
      "results"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "Result": {
         "title": "Result",
         "description": "Contains information about a result.",
         "type": "object",
         "properties": {
            "status": {
               "$ref": "#/definitions/Status"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "programName": {
               "title": "Programname",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "systemId": {
               "title": "Systemid",
               "type": "string"
            },
            "hostName": {
               "title": "Hostname",
               "type": "string"
            },
            "partNumber": {
               "title": "Partnumber",
               "type": "string"
            },
            "serialNumber": {
               "title": "Serialnumber",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "operator": {
               "title": "Operator",
               "type": "string"
            },
            "fileIds": {
               "title": "Fileids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "dataTableIds": {
               "title": "Datatableids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "statusTypeSummary": {
               "title": "Statustypesummary",
               "type": "object",
               "additionalProperties": {
                  "type": "integer"
               }
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         }
      }
   }
}

Fields

• results

• total_count

field results: List[Result] [Required]

A list of all the results in this page.

field total_count: Optional[int] = None

The total number of results that match the query.

pydantic model nisystemlink.clients.testmonitor.models.PagedSteps

The response for a Steps query containing matched steps.

Show JSON schema

{
   "title": "PagedSteps",
   "description": "The response for a Steps query containing matched steps.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "steps": {
         "title": "Steps",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Step"
         }
      },
      "totalCount": {
         "title": "Totalcount",
         "type": "integer"
      }
   },
   "required": [
      "steps"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      },
      "Step": {
         "title": "Step",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "path": {
               "title": "Path",
               "type": "string"
            },
            "pathIds": {
               "title": "Pathids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "integer"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "hasChildren": {
               "title": "Haschildren",
               "type": "boolean"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         }
      }
   }
}

Fields

• steps

• total_count

field steps: List[Step] [Required]

A list of all the steps in this page.

field total_count: Optional[int] = None

The total number of steps that match the query.

pydantic model nisystemlink.clients.testmonitor.models.QueryResultValuesRequest

Show JSON schema

{
   "title": "QueryResultValuesRequest",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "substitutions": {
         "title": "Substitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "field": {
         "$ref": "#/definitions/ResultField"
      },
      "startsWith": {
         "title": "Startswith",
         "type": "string"
      }
   },
   "definitions": {
      "ResultField": {
         "title": "ResultField",
         "description": "The allowed field for which the values can be queried for.",
         "enum": [
            "ID",
            "STARTED_AT",
            "UPDATED_AT",
            "PROGRAM_NAME",
            "SYSTEM_ID",
            "HOST_NAME",
            "OPERATOR",
            "SERIAL_NUMBER",
            "PART_NUMBER",
            "PRODUCT",
            "TOTAL_TIME_IN_SECONDS"
         ],
         "type": "string"
      }
   }
}

Fields

• field

• starts_with

field field: Optional[ResultField] = None

The result field to return for this query.

field starts_with: Optional[str] = None

Only return string parameters prefixed by this value (case sensitive).

pydantic model nisystemlink.clients.testmonitor.models.QueryResultsRequest

Show JSON schema

{
   "title": "QueryResultsRequest",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "productFilter": {
         "title": "Productfilter",
         "type": "string"
      },
      "productSubstitutions": {
         "title": "Productsubstitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "substitutions": {
         "title": "Substitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "orderBy": {
         "$ref": "#/definitions/ResultOrderByField"
      },
      "orderByKey": {
         "title": "Orderbykey",
         "type": "string"
      },
      "orderByComparisonType": {
         "$ref": "#/definitions/ComparisonType"
      },
      "descending": {
         "title": "Descending",
         "type": "boolean"
      },
      "projection": {
         "type": "array",
         "items": {
            "$ref": "#/definitions/ResultProjection"
         }
      },
      "take": {
         "title": "Take",
         "type": "integer"
      },
      "returnCount": {
         "title": "Returncount",
         "type": "boolean"
      }
   },
   "definitions": {
      "ResultOrderByField": {
         "title": "ResultOrderByField",
         "description": "The fields by which results can be ordered.",
         "enum": [
            "ID",
            "STARTED_AT",
            "UPDATED_AT",
            "PROGRAM_NAME",
            "SYSTEM_ID",
            "HOST_NAME",
            "OPERATOR",
            "SERIAL_NUMBER",
            "PART_NUMBER",
            "PRODUCT",
            "TOTAL_TIME_IN_SECONDS",
            "PROPERTIES"
         ],
         "type": "string"
      },
      "ComparisonType": {
         "title": "ComparisonType",
         "description": "The valid ways to order a result query.",
         "enum": [
            "DEFAULT",
            "NUMERIC",
            "LEXICOGRAPHIC"
         ],
         "type": "string"
      },
      "ResultProjection": {
         "title": "ResultProjection",
         "description": "The allowed projections for query.\n\nWhen using projection, only the fields specified by the projection element will be included in\nthe response.",
         "enum": [
            "ID",
            "STATUS",
            "STARTED_AT",
            "UPDATED_AT",
            "PROGRAM_NAME",
            "SYSTEM_ID",
            "HOST_NAME",
            "OPERATOR",
            "SERIAL_NUMBER",
            "PART_NUMBER",
            "TOTAL_TIME_IN_SECONDS",
            "KEYWORDS",
            "PROPERTIES",
            "FILE_IDS",
            "DATA_TABLE_IDS",
            "STATUS_TYPE_SUMMARY",
            "WORKSPACE"
         ],
         "type": "string"
      }
   }
}

Fields

• descending

• order_by

• order_by_comparison_type

• order_by_key

• projection

• return_count

• take

field descending: Optional[bool] = None

Specifies whether to return the results in descending order. By default, this value is false and results are sorted in ascending order.

field order_by: Optional[ResultOrderByField] = None

Specifies the fields to use to sort the results. By default, results are sorted by id

field order_by_comparison_type: Optional[ComparisonType] = None

An enumeration of comparison types that can be used for ordered queries. For non-DEFAULT comparisons, values that cannot be converted will be considered the smallest value.

field order_by_key: Optional[str] = None

Specifies the property to use to sort the results when ordering by PROPERTIES. Results that do not contain the orderByKey will be considered the smallest value.

field projection: Optional[List[ResultProjection]] = None

Specifies the fields to include in the returned results. Fields you do not specify are excluded. Returns all fields if no value is specified.

field return_count: Optional[bool] = None

If true, the response will include a count of all results matching the filter. By default, this value is False and count is not returned. Note that returning the count may incur performance penalties as the service may have to do a complete walk of the database to compute count.

field take: Optional[int] = None

Maximum number of results to return in the current API response. Uses the default if the specified value is negative. The default value is 1000 results.

pydantic model nisystemlink.clients.testmonitor.models.QueryStepValuesRequest

Show JSON schema

{
   "title": "QueryStepValuesRequest",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "substitutions": {
         "title": "Substitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "field": {
         "$ref": "#/definitions/StepField"
      },
      "startsWith": {
         "title": "Startswith",
         "type": "string"
      }
   },
   "required": [
      "field"
   ],
   "definitions": {
      "StepField": {
         "title": "StepField",
         "description": "The valid field values that can be queried.\n\nThis contains only limited fields available in a Step.",
         "enum": [
            "NAME",
            "STEP_TYPE",
            "STEP_ID",
            "PARENT_ID",
            "RESULT_ID",
            "PATH",
            "TOTAL_TIME_IN_SECONDS",
            "STARTED_AT",
            "UPDATED_AT",
            "DATA_MODEL"
         ],
         "type": "string"
      }
   }
}

Fields

• field

• starts_with

field field: StepField [Required]

The step field to return for this query.

field starts_with: Optional[str] = None

Only return string parameters prefixed by this value (case sensitive).

pydantic model nisystemlink.clients.testmonitor.models.QueryStepsRequest

Show JSON schema

{
   "title": "QueryStepsRequest",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "substitutions": {
         "title": "Substitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "orderBy": {
         "$ref": "#/definitions/StepOrderBy"
      },
      "descending": {
         "title": "Descending",
         "type": "boolean"
      },
      "take": {
         "title": "Take",
         "type": "integer"
      },
      "returnCount": {
         "title": "Returncount",
         "type": "boolean"
      },
      "resultFilter": {
         "title": "Resultfilter",
         "type": "string"
      },
      "resultSubstitutions": {
         "title": "Resultsubstitutions",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "projection": {
         "type": "array",
         "items": {
            "$ref": "#/definitions/StepProjection"
         }
      }
   },
   "definitions": {
      "StepOrderBy": {
         "title": "StepOrderBy",
         "description": "The valid ways to order steps query response.\n\nThis contains only limited fields available in a Step.",
         "enum": [
            "NAME",
            "STEP_TYPE",
            "STEP_ID",
            "PARENT_ID",
            "RESULT_ID",
            "PATH",
            "TOTAL_TIME_IN_SECONDS",
            "STARTED_AT",
            "UPDATED_AT",
            "DATA_MODEL"
         ],
         "type": "string"
      },
      "StepProjection": {
         "title": "StepProjection",
         "description": "An enumeration of all fields in a Step.\n\nThis enumeration is used to specify the fields to project in a step query.",
         "enum": [
            "NAME",
            "STEP_TYPE",
            "STEP_ID",
            "PARENT_ID",
            "RESULT_ID",
            "PATH",
            "PATH_IDS",
            "STATUS",
            "TOTAL_TIME_IN_SECONDS",
            "STARTED_AT",
            "UPDATED_AT",
            "INPUTS",
            "OUTPUTS",
            "DATA_MODEL",
            "DATA",
            "HAS_CHILDREN",
            "WORKSPACE",
            "KEYWORDS",
            "PROPERTIES"
         ],
         "type": "string"
      }
   }
}

Fields

• descending

• order_by

• projection

• result_filter

• result_substitutions

• return_count

• take

field descending: Optional[bool] = None

Specifies whether to return the steps in descending order.

field order_by: Optional[StepOrderBy] = None

Specifies the fields to use to sort the steps.

field projection: Optional[List[StepProjection]] = None

Specifies the step fields to project. When a field value is given here, the corresponding field will be present in all returned steps, and all unspecified fields will be excluded. If no projection is specified, all step fields will be returned.

field result_filter: Optional[str] = None

The result query filter in Dynamic Linq format.

field result_substitutions: Optional[List[str]] = None

String substitutions into the result_filter.

field return_count: Optional[bool] = None

If true, the response will include a count of all steps matching the filter.

By default, this value is False and count is not returned. Note that returning the count may incur performance penalties as the service may have to do a complete walk of the database to compute count.

field take: Optional[int] = None

Maximum number of steps to return in the current API response.

pydantic model nisystemlink.clients.testmonitor.models.Result

Contains information about a result.

Show JSON schema

{
   "title": "Result",
   "description": "Contains information about a result.",
   "type": "object",
   "properties": {
      "status": {
         "$ref": "#/definitions/Status"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "programName": {
         "title": "Programname",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "systemId": {
         "title": "Systemid",
         "type": "string"
      },
      "hostName": {
         "title": "Hostname",
         "type": "string"
      },
      "partNumber": {
         "title": "Partnumber",
         "type": "string"
      },
      "serialNumber": {
         "title": "Serialnumber",
         "type": "string"
      },
      "totalTimeInSeconds": {
         "title": "Totaltimeinseconds",
         "type": "number"
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "operator": {
         "title": "Operator",
         "type": "string"
      },
      "fileIds": {
         "title": "Fileids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "dataTableIds": {
         "title": "Datatableids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "statusTypeSummary": {
         "title": "Statustypesummary",
         "type": "object",
         "additionalProperties": {
            "type": "integer"
         }
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      }
   }
}

Fields

• data_table_ids

• file_ids

• host_name

• id

• keywords

• operator

• part_number

• program_name

• properties

• serial_number

• started_at

• status

• status_type_summary

• system_id

• total_time_in_seconds

• updated_at

• workspace

field data_table_ids: Optional[List[str]] = None

A list of data table ids that are attached to this result.

field file_ids: Optional[List[str]] = None

A list of file ids that are attached to this result.

field host_name: Optional[str] = None

The name of the host that generated this result.

field id: Optional[str] = None

The globally unique id of the result.

field keywords: Optional[List[str]] = None

A list of keywords that categorize this result.

field operator: Optional[str] = None

The operator that ran the result.

field part_number: Optional[str] = None

The part number is the unique identifier of a product within a single org.

field program_name: Optional[str] = None

The name of the program that generated this result.

field properties: Optional[Dict[str, Optional[str]]] = None

A list of custom properties for this result.

field serial_number: Optional[str] = None

The serial number of the system that generated this result.

field started_at: Optional[datetime] = None

The time that the result started.

field status: Optional[Status] = None

The status of the result.

field status_type_summary: Optional[Dict[StatusType, int]] = None

A summary of the status types in the result.

field system_id: Optional[str] = None

The id of the system that generated this result.

field total_time_in_seconds: Optional[float] = None

The total time that the result took to run in seconds.

field updated_at: Optional[datetime] = None

The last time that this result was updated.

field workspace: Optional[str] = None

The id of the workspace that this product belongs to.

class nisystemlink.clients.testmonitor.models.ResultField(value)

The allowed field for which the values can be queried for.

class nisystemlink.clients.testmonitor.models.ResultProjection(value)

The allowed projections for query.

When using projection, only the fields specified by the projection element will be included in the response.

pydantic model nisystemlink.clients.testmonitor.models.Status

Contains information about a status object.

Show JSON schema

{
   "title": "Status",
   "description": "Contains information about a status object.",
   "type": "object",
   "properties": {
      "statusType": {
         "$ref": "#/definitions/StatusType"
      },
      "statusName": {
         "title": "Statusname",
         "type": "string"
      }
   },
   "required": [
      "statusType"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      }
   }
}

Fields

• status_name

• status_type

field status_name: Optional[str] = None

The name of the status.

field status_type: StatusType [Required]

The type of status.

static DONE()

Return type

nisystemlink.clients.testmonitor.models.Status

static ERRORED()

Return type

nisystemlink.clients.testmonitor.models.Status

static FAILED()

Return type

nisystemlink.clients.testmonitor.models.Status

static LOOPING()

Return type

nisystemlink.clients.testmonitor.models.Status

static PASSED()

Return type

nisystemlink.clients.testmonitor.models.Status

static RUNNING()

Return type

nisystemlink.clients.testmonitor.models.Status

static SKIPPED()

Return type

nisystemlink.clients.testmonitor.models.Status

static TERMINATED()

Return type

nisystemlink.clients.testmonitor.models.Status

static TIMED_OUT()

Return type

nisystemlink.clients.testmonitor.models.Status

static WAITING()

Return type

nisystemlink.clients.testmonitor.models.Status

class nisystemlink.clients.testmonitor.models.StatusType(value)

The types of statuses that a result can have.

pydantic model nisystemlink.clients.testmonitor.models.Step

Show JSON schema

{
   "title": "Step",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "stepType": {
         "title": "Steptype",
         "type": "string"
      },
      "stepId": {
         "title": "Stepid",
         "type": "string"
      },
      "parentId": {
         "title": "Parentid",
         "type": "string"
      },
      "resultId": {
         "title": "Resultid",
         "type": "string"
      },
      "path": {
         "title": "Path",
         "type": "string"
      },
      "pathIds": {
         "title": "Pathids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "status": {
         "$ref": "#/definitions/Status"
      },
      "totalTimeInSeconds": {
         "title": "Totaltimeinseconds",
         "type": "integer"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "inputs": {
         "title": "Inputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/NamedValue"
         }
      },
      "outputs": {
         "title": "Outputs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/NamedValue"
         }
      },
      "dataModel": {
         "title": "Datamodel",
         "type": "string"
      },
      "data": {
         "$ref": "#/definitions/StepData"
      },
      "hasChildren": {
         "title": "Haschildren",
         "type": "boolean"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      }
   },
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      }
   }
}

Fields

• data

• data_model

• has_children

• inputs

• keywords

• name

• outputs

• parent_id

• path

• path_ids

• properties

• result_id

• started_at

• status

• step_id

• step_type

• total_time_in_seconds

• updated_at

• workspace

field data: Optional[StepData] = None

Data returned by the test step.

field data_model: Optional[str] = None

Custom string defining the model of the data object.

field has_children: Optional[bool] = None

Indicates if the step has child steps.

field inputs: Optional[List[NamedValue]] = None

Inputs and their values passed to the test.

field keywords: Optional[List[str]] = None

Words or phrases associated with the test step.

field name: Optional[str] = None

The name of the step.

field outputs: Optional[List[NamedValue]] = None

Outputs and their values logged by the test.

field parent_id: Optional[str] = None

The ID of the parent step.

field path: Optional[str] = None

The path of the step.

field path_ids: Optional[List[str]] = None

The IDs of the steps in the path.

field properties: Optional[Dict[str, str]] = None

Test step properties.

field result_id: Optional[str] = None

The ID of the result associated with the step.

field started_at: Optional[datetime] = None

The ISO-8601 formatted timestamp indicating when the step started.

field status: Optional[Status] = None

The status of the step.

field step_id: Optional[str] = None

The ID of the step.

field step_type: Optional[str] = None

The type of the step.

field total_time_in_seconds: Optional[int] = None

The total time in seconds the step took to execute.

field updated_at: Optional[datetime] = None

The ISO-8601 formatted timestamp indicating when the step was last updated.

field workspace: Optional[str] = None

The workspace the test step belongs to.

pydantic model nisystemlink.clients.testmonitor.models.StepData

Show JSON schema

{
   "title": "StepData",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "text": {
         "title": "Text",
         "type": "string"
      },
      "parameters": {
         "title": "Parameters",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Measurement"
         }
      }
   },
   "definitions": {
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      }
   }
}

Fields

• parameters

• text

field parameters: Optional[List[Measurement]] = None

List of properties objects.

field text: Optional[str] = None

Text string describing the output data.

class nisystemlink.clients.testmonitor.models.StepField(value)

The valid field values that can be queried.

This contains only limited fields available in a Step.

pydantic model nisystemlink.clients.testmonitor.models.StepIdResultIdPair

Show JSON schema

{
   "title": "StepIdResultIdPair",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "stepId": {
         "title": "Stepid",
         "type": "string"
      },
      "resultId": {
         "title": "Resultid",
         "type": "string"
      }
   },
   "required": [
      "stepId",
      "resultId"
   ]
}

Fields

• result_id

• step_id

field result_id: str [Required]

The ID of the result associated with the step.

field step_id: str [Required]

The ID of the step.

class nisystemlink.clients.testmonitor.models.StepOrderBy(value)

The valid ways to order steps query response.

This contains only limited fields available in a Step.

class nisystemlink.clients.testmonitor.models.StepProjection(value)

An enumeration of all fields in a Step.

This enumeration is used to specify the fields to project in a step query.

pydantic model nisystemlink.clients.testmonitor.models.UpdateResultRequest

Contains information about a result.

Show JSON schema

{
   "title": "UpdateResultRequest",
   "description": "Contains information about a result.",
   "type": "object",
   "properties": {
      "status": {
         "$ref": "#/definitions/Status"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "programName": {
         "title": "Programname",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "systemId": {
         "title": "Systemid",
         "type": "string"
      },
      "hostName": {
         "title": "Hostname",
         "type": "string"
      },
      "partNumber": {
         "title": "Partnumber",
         "type": "string"
      },
      "serialNumber": {
         "title": "Serialnumber",
         "type": "string"
      },
      "totalTimeInSeconds": {
         "title": "Totaltimeinseconds",
         "type": "number"
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "operator": {
         "title": "Operator",
         "type": "string"
      },
      "fileIds": {
         "title": "Fileids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "dataTableIds": {
         "title": "Datatableids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "required": [
      "id"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      }
   }
}

Fields

• data_table_ids

• file_ids

• host_name

• id

• keywords

• operator

• part_number

• program_name

• properties

• serial_number

• started_at

• status

• system_id

• total_time_in_seconds

• workspace

field data_table_ids: Optional[List[str]] = None

A list of data table ids that are attached to this result.

field file_ids: Optional[List[str]] = None

A list of file ids that are attached to this result.

field host_name: Optional[str] = None

The name of the host that generated this result.

field id: str [Required]

The globally unique id of the result.

field keywords: Optional[List[str]] = None

A list of keywords that categorize this result.

field operator: Optional[str] = None

The operator that ran the result.

field part_number: Optional[str] = None

The part number is the unique identifier of a product within a single org.

field program_name: Optional[str] = None

The name of the program that generated this result.

field properties: Optional[Dict[str, Optional[str]]] = None

A list of custom properties for this result.

field serial_number: Optional[str] = None

The serial number of the system that generated this result.

field started_at: Optional[datetime] = None

The time that the result started.

field status: Optional[Status] = None

The status of the result.

field system_id: Optional[str] = None

The id of the system that generated this result.

field total_time_in_seconds: Optional[float] = None

The total time that the result took to run in seconds.

field workspace: Optional[str] = None

The id of the workspace that this product belongs to.

pydantic model nisystemlink.clients.testmonitor.models.UpdateResultsPartialSuccess

Show JSON schema

{
   "title": "UpdateResultsPartialSuccess",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "results": {
         "title": "Results",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Result"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "$ref": "#/definitions/UpdateResultRequest"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "results"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "Result": {
         "title": "Result",
         "description": "Contains information about a result.",
         "type": "object",
         "properties": {
            "status": {
               "$ref": "#/definitions/Status"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "programName": {
               "title": "Programname",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "systemId": {
               "title": "Systemid",
               "type": "string"
            },
            "hostName": {
               "title": "Hostname",
               "type": "string"
            },
            "partNumber": {
               "title": "Partnumber",
               "type": "string"
            },
            "serialNumber": {
               "title": "Serialnumber",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "operator": {
               "title": "Operator",
               "type": "string"
            },
            "fileIds": {
               "title": "Fileids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "dataTableIds": {
               "title": "Datatableids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "statusTypeSummary": {
               "title": "Statustypesummary",
               "type": "object",
               "additionalProperties": {
                  "type": "integer"
               }
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         }
      },
      "UpdateResultRequest": {
         "title": "UpdateResultRequest",
         "description": "Contains information about a result.",
         "type": "object",
         "properties": {
            "status": {
               "$ref": "#/definitions/Status"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "programName": {
               "title": "Programname",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "systemId": {
               "title": "Systemid",
               "type": "string"
            },
            "hostName": {
               "title": "Hostname",
               "type": "string"
            },
            "partNumber": {
               "title": "Partnumber",
               "type": "string"
            },
            "serialNumber": {
               "title": "Serialnumber",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "operator": {
               "title": "Operator",
               "type": "string"
            },
            "fileIds": {
               "title": "Fileids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "dataTableIds": {
               "title": "Datatableids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         },
         "required": [
            "id"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• results

field error: Optional[ApiError] = None

Error messages for results that were not created. If this is None, then all results were successfully created.

field failed: Optional[List[UpdateResultRequest]] = None

The list of results that were not created. If this is None, then all results were successfully created.

field results: List[Result] [Required]

The list of results that were successfully created.

pydantic model nisystemlink.clients.testmonitor.models.UpdateStepRequest

Show JSON schema

{
   "$ref": "#/definitions/UpdateStepRequest",
   "definitions": {
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      },
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "UpdateStepRequest": {
         "title": "UpdateStepRequest",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "children": {
               "title": "Children",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/UpdateStepRequest"
               }
            }
         },
         "required": [
            "stepId",
            "resultId"
         ]
      }
   }
}

Fields

• children

• name

field children: Optional[List[UpdateStepRequest]] = None

Nested child steps.

field name: Optional[str] = None

Step name.

pydantic model nisystemlink.clients.testmonitor.models.UpdateStepsPartialSuccess

Show JSON schema

{
   "title": "UpdateStepsPartialSuccess",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "steps": {
         "title": "Steps",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Step"
         }
      },
      "failed": {
         "title": "Failed",
         "type": "array",
         "items": {
            "$ref": "#/definitions/UpdateStepRequest"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "required": [
      "steps"
   ],
   "definitions": {
      "StatusType": {
         "title": "StatusType",
         "description": "The types of statuses that a result can have.",
         "enum": [
            "LOOPING",
            "SKIPPED",
            "CUSTOM",
            "DONE",
            "PASSED",
            "FAILED",
            "RUNNING",
            "WAITING",
            "TERMINATED",
            "ERRORED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "Contains information about a status object.",
         "type": "object",
         "properties": {
            "statusType": {
               "$ref": "#/definitions/StatusType"
            },
            "statusName": {
               "title": "Statusname",
               "type": "string"
            }
         },
         "required": [
            "statusType"
         ]
      },
      "NamedValue": {
         "title": "NamedValue",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value"
            }
         },
         "required": [
            "name"
         ]
      },
      "Measurement": {
         "title": "Measurement",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "status": {
               "title": "Status",
               "type": "string"
            },
            "measurement": {
               "title": "Measurement",
               "type": "string"
            },
            "lowLimit": {
               "title": "Lowlimit",
               "type": "string"
            },
            "highLimit": {
               "title": "Highlimit",
               "type": "string"
            },
            "units": {
               "title": "Units",
               "type": "string"
            },
            "comparisonType": {
               "title": "Comparisontype",
               "type": "string"
            }
         }
      },
      "StepData": {
         "title": "StepData",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Measurement"
               }
            }
         }
      },
      "Step": {
         "title": "Step",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "path": {
               "title": "Path",
               "type": "string"
            },
            "pathIds": {
               "title": "Pathids",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "integer"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "hasChildren": {
               "title": "Haschildren",
               "type": "boolean"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         }
      },
      "UpdateStepRequest": {
         "title": "UpdateStepRequest",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "stepId": {
               "title": "Stepid",
               "type": "string"
            },
            "resultId": {
               "title": "Resultid",
               "type": "string"
            },
            "parentId": {
               "title": "Parentid",
               "type": "string"
            },
            "data": {
               "$ref": "#/definitions/StepData"
            },
            "dataModel": {
               "title": "Datamodel",
               "type": "string"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "stepType": {
               "title": "Steptype",
               "type": "string"
            },
            "totalTimeInSeconds": {
               "title": "Totaltimeinseconds",
               "type": "number"
            },
            "inputs": {
               "title": "Inputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "outputs": {
               "title": "Outputs",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/NamedValue"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "children": {
               "title": "Children",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/UpdateStepRequest"
               }
            }
         },
         "required": [
            "stepId",
            "resultId"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed

• steps

field error: Optional[ApiError] = None

Error messages for steps that were not updated.

If this is None, then all steps were successfully updated.

field failed: Optional[List[UpdateStepRequest]] = None

The list of steps that were not updated.

If this is None, then all steps were successfully updated.

field steps: List[Step] [Required]

The list of steps that were successfully updated.

pydantic model nisystemlink.clients.testmonitor.models.V2Operations

The operations available in the routes provided by the v2 HTTP API.

Show JSON schema

{
   "title": "V2Operations",
   "description": "The operations available in the routes provided by the v2 HTTP API.",
   "type": "object",
   "properties": {
      "getProducts": {
         "$ref": "#/definitions/Operation"
      },
      "queryProducts": {
         "$ref": "#/definitions/Operation"
      },
      "createProducts": {
         "$ref": "#/definitions/Operation"
      },
      "updateProducts": {
         "$ref": "#/definitions/Operation"
      },
      "deleteProducts": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManyProducts": {
         "$ref": "#/definitions/Operation"
      },
      "getResults": {
         "$ref": "#/definitions/Operation"
      },
      "getResultsPropertyKeys": {
         "$ref": "#/definitions/Operation"
      },
      "queryResults": {
         "$ref": "#/definitions/Operation"
      },
      "createResults": {
         "$ref": "#/definitions/Operation"
      },
      "updateResults": {
         "$ref": "#/definitions/Operation"
      },
      "deleteResult": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManyResults": {
         "$ref": "#/definitions/Operation"
      },
      "getSteps": {
         "$ref": "#/definitions/Operation"
      },
      "querySteps": {
         "$ref": "#/definitions/Operation"
      },
      "createSteps": {
         "$ref": "#/definitions/Operation"
      },
      "updateSteps": {
         "$ref": "#/definitions/Operation"
      },
      "deleteStep": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManySteps": {
         "$ref": "#/definitions/Operation"
      },
      "queryPaths": {
         "$ref": "#/definitions/Operation"
      }
   },
   "required": [
      "getProducts",
      "queryProducts",
      "createProducts",
      "updateProducts",
      "deleteProducts",
      "deleteManyProducts",
      "getResults",
      "getResultsPropertyKeys",
      "queryResults",
      "createResults",
      "updateResults",
      "deleteResult",
      "deleteManyResults",
      "getSteps",
      "querySteps",
      "createSteps",
      "updateSteps",
      "deleteStep",
      "deleteManySteps",
      "queryPaths"
   ],
   "definitions": {
      "Operation": {
         "title": "Operation",
         "description": "Represents an operation that can be performed on a data frame.",
         "type": "object",
         "properties": {
            "available": {
               "title": "Available",
               "type": "boolean"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "available",
            "version"
         ]
      }
   }
}

Fields

• create_products

• create_results

• create_steps

• delete_many_products

• delete_many_results

• delete_many_steps

• delete_products

• delete_result

• delete_step

• get_products

• get_results

• get_results_property_keys

• get_steps

• query_paths

• query_products

• query_results

• query_steps

• update_products

• update_results

• update_steps

field create_products: Operation [Required]

The ability to create one or more products.

field create_results: Operation [Required]

The ability to create results.

field create_steps: Operation [Required]

The ability to create steps.

field delete_many_products: Operation [Required]

The ability to delete a list of products.

field delete_many_results: Operation [Required]

The ability to delete multiple results.

field delete_many_steps: Operation [Required]

The ability to delete multiple steps.

field delete_products: Operation [Required]

The ability to delete a single products.

field delete_result: Operation [Required]

The ability to delete a single results.

field delete_step: Operation [Required]

The ability to delete a single step.

field get_products: Operation [Required]

The ability to get a list of products.

field get_results: Operation [Required]

The ability to get a list of results.

field get_results_property_keys: Operation [Required]

The ability to get custom property keys.

field get_steps: Operation [Required]

The ability to get a list of steps.

field query_paths: Operation [Required]

The ability to query step paths.

field query_products: Operation [Required]

The ability to query products based on their properties.

field query_results: Operation [Required]

“The ability to to query results based on their properties.

field query_steps: Operation [Required]

The ability to query steps based on their properties.

field update_products: Operation [Required]

The ability to update the properties of one or more products.

field update_results: Operation [Required]

The ability to update results.

field update_steps: Operation [Required]

The ability to update steps.