nisystemlink.clients.testmonitor
- class nisystemlink.clients.testmonitor.TestMonitorClient(configuration=None)[source]
- __init__(configuration=None)[source]
Initialize an instance.
- Parameters
configuration (
Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, theHttpConfigurationManageris used to obtain the configuration.- Raises
ApiException – if unable to communicate with the TestMonitor Service.
- create_results(results)[source]
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
/nitestmonitorservice of provided invalid arguments.
- get_results(continuation_token=None, take=None, return_count=None)[source]
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
- Returns
A list of results.
- Raises
ApiException – if unable to communicate with the
/nitestmonitorService or provided an invalid argument.
- query_results(query)[source]
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
- Returns
A paged list of results with a continuation token to get the next page.
- Raises
ApiException – if unable to communicate with the
/nitestmonitorService or provided invalid arguments.
- query_result_values(query)[source]
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
/nitestmonitorService or provided invalid arguments.
- update_results(results, replace=False)[source]
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
/nitestmonitorService or provided an invalid argument.
- delete_result(id)[source]
Deletes a single result by id.
- Parameters
id (str) – Unique ID of a result.
- Raises
ApiException – if unable to communicate with the
/nitestmonitorService or provided an invalid argument.- Return type
None
- delete_results(ids)[source]
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
/nitestmonitorService or provided an invalid argument.
- create_steps(steps, update_result_total_time=False)[source]
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)[source]
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
- 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)[source]
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)[source]
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 theworkspace. (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)[source]
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)[source]
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 andserver. (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)[source]
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
- 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)[source]
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
- 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[source]
Information about the available API operations.
Show JSON schema
{ "title": "ApiInfo", "description": "Information about the available API operations.", "type": "object", "properties": { "operations": { "$ref": "#/$defs/V2Operations" } }, "$defs": { "Operation": { "description": "Represents an operation that can be performed on a data frame.", "properties": { "available": { "title": "Available", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "available", "version" ], "title": "Operation", "type": "object" }, "V2Operations": { "description": "The operations available in the routes provided by the v2 HTTP API.", "properties": { "getProducts": { "$ref": "#/$defs/Operation" }, "queryProducts": { "$ref": "#/$defs/Operation" }, "createProducts": { "$ref": "#/$defs/Operation" }, "updateProducts": { "$ref": "#/$defs/Operation" }, "deleteProducts": { "$ref": "#/$defs/Operation" }, "deleteManyProducts": { "$ref": "#/$defs/Operation" }, "getResults": { "$ref": "#/$defs/Operation" }, "getResultsPropertyKeys": { "$ref": "#/$defs/Operation" }, "queryResults": { "$ref": "#/$defs/Operation" }, "createResults": { "$ref": "#/$defs/Operation" }, "updateResults": { "$ref": "#/$defs/Operation" }, "deleteResult": { "$ref": "#/$defs/Operation" }, "deleteManyResults": { "$ref": "#/$defs/Operation" }, "getSteps": { "$ref": "#/$defs/Operation" }, "querySteps": { "$ref": "#/$defs/Operation" }, "createSteps": { "$ref": "#/$defs/Operation" }, "updateSteps": { "$ref": "#/$defs/Operation" }, "deleteStep": { "$ref": "#/$defs/Operation" }, "deleteManySteps": { "$ref": "#/$defs/Operation" }, "queryPaths": { "$ref": "#/$defs/Operation" } }, "required": [ "getProducts", "queryProducts", "createProducts", "updateProducts", "deleteProducts", "deleteManyProducts", "getResults", "getResultsPropertyKeys", "queryResults", "createResults", "updateResults", "deleteResult", "deleteManyResults", "getSteps", "querySteps", "createSteps", "updateSteps", "deleteStep", "deleteManySteps", "queryPaths" ], "title": "V2Operations", "type": "object" } }, "required": [ "operations" ] }
- Fields
-
field operations:
V2Operations[Required]
- pydantic model nisystemlink.clients.testmonitor.models.CreateResultRequest[source]
Contains information about a result.
Show JSON schema
{ "title": "CreateResultRequest", "description": "Contains information about a result.", "type": "object", "properties": { "status": { "$ref": "#/$defs/Status" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "programName": { "title": "Programname", "type": "string" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "$defs": { "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } }, "required": [ "status", "programName" ] }
- Fields
-
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 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[source]
Show JSON schema
{ "title": "CreateResultsPartialSuccess", "type": "object", "properties": { "results": { "items": { "$ref": "#/$defs/Result" }, "title": "Results", "type": "array" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateResultRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "CreateResultRequest": { "description": "Contains information about a result.", "properties": { "status": { "$ref": "#/$defs/Status" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "programName": { "title": "Programname", "type": "string" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "required": [ "status", "programName" ], "title": "CreateResultRequest", "type": "object" }, "Result": { "description": "Contains information about a result.", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "statusTypeSummary": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "propertyNames": { "$ref": "#/$defs/StatusType" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Statustypesummary" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "title": "Result", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } }, "required": [ "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 error:
- pydantic model nisystemlink.clients.testmonitor.models.CreateStepRequest[source]
Show JSON schema
{ "$defs": { "CreateStepRequest": { "properties": { "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stepid" }, "resultId": { "title": "Resultid", "type": "string" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "name": { "title": "Name", "type": "string" }, "children": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Children" } }, "required": [ "stepId", "resultId", "name" ], "title": "CreateStepRequest", "type": "object" }, "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" } }, "$ref": "#/$defs/CreateStepRequest" }
-
field children:
Optional[List[CreateStepRequest]] = None Nested child steps.
-
field name:
str[Required] Step name.
-
field children:
- pydantic model nisystemlink.clients.testmonitor.models.CreateStepsPartialSuccess[source]
Show JSON schema
{ "title": "CreateStepsPartialSuccess", "type": "object", "properties": { "steps": { "items": { "$ref": "#/$defs/Step" }, "title": "Steps", "type": "array" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "CreateStepRequest": { "properties": { "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stepid" }, "resultId": { "title": "Resultid", "type": "string" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "name": { "title": "Name", "type": "string" }, "children": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Children" } }, "required": [ "stepId", "resultId", "name" ], "title": "CreateStepRequest", "type": "object" }, "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "Step": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stepid" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resultid" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path" }, "pathIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Pathids" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "hasChildren": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Haschildren" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "title": "Step", "type": "object" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" } }, "required": [ "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 error:
- pydantic model nisystemlink.clients.testmonitor.models.DeleteResultsPartialSuccess[source]
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": { "items": { "type": "string" }, "title": "Ids", "type": "array" }, "failed": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } }, "required": [ "ids" ] }
-
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.
-
field failed:
- pydantic model nisystemlink.clients.testmonitor.models.DeleteStepsPartialSuccess[source]
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": { "items": { "$ref": "#/$defs/StepIdResultIdPair" }, "title": "Steps", "type": "array" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/StepIdResultIdPair" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "StepIdResultIdPair": { "properties": { "stepId": { "title": "Stepid", "type": "string" }, "resultId": { "title": "Resultid", "type": "string" } }, "required": [ "stepId", "resultId" ], "title": "StepIdResultIdPair", "type": "object" } }, "required": [ "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.
-
field failed:
- pydantic model nisystemlink.clients.testmonitor.models.Measurement[source]
Show JSON schema
{ "title": "Measurement", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "additionalProperties": { "type": "string" } }
-
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
-
field comparisonType:
- pydantic model nisystemlink.clients.testmonitor.models.NamedValue[source]
Show JSON schema
{ "title": "NamedValue", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ] }
-
field name:
str[Required] The name of the value.
-
field value:
Any= None The value.
-
field name:
- pydantic model nisystemlink.clients.testmonitor.models.Operation[source]
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" ] }
-
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.
-
field available:
- pydantic model nisystemlink.clients.testmonitor.models.PagedResults[source]
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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "results": { "items": { "$ref": "#/$defs/Result" }, "title": "Results", "type": "array" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "Result": { "description": "Contains information about a result.", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "statusTypeSummary": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "propertyNames": { "$ref": "#/$defs/StatusType" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Statustypesummary" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "title": "Result", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } }, "required": [ "results" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of results that match the query.
- pydantic model nisystemlink.clients.testmonitor.models.PagedSteps[source]
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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "steps": { "items": { "$ref": "#/$defs/Step" }, "title": "Steps", "type": "array" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "Step": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stepid" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resultid" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path" }, "pathIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Pathids" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "hasChildren": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Haschildren" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "title": "Step", "type": "object" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" } }, "required": [ "steps" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of steps that match the query.
- pydantic model nisystemlink.clients.testmonitor.models.QueryResultValuesRequest[source]
Show JSON schema
{ "title": "QueryResultValuesRequest", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "field": { "anyOf": [ { "$ref": "#/$defs/ResultField" }, { "type": "null" } ], "default": null }, "startsWith": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Startswith" } }, "$defs": { "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" ], "title": "ResultField", "type": "string" } } }
- Fields
-
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[source]
Show JSON schema
{ "title": "QueryResultsRequest", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "productFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Productfilter" }, "productSubstitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productsubstitutions" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/ResultOrderByField" }, { "type": "null" } ], "default": null }, "orderByKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Orderbykey" }, "orderByComparisonType": { "anyOf": [ { "$ref": "#/$defs/ComparisonType" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/ResultProjection" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "returnCount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Returncount" } }, "$defs": { "ComparisonType": { "description": "The valid ways to order a result query.", "enum": [ "DEFAULT", "NUMERIC", "LEXICOGRAPHIC" ], "title": "ComparisonType", "type": "string" }, "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" ], "title": "ResultOrderByField", "type": "string" }, "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" ], "title": "ResultProjection", "type": "string" } } }
-
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.
-
field descending:
- pydantic model nisystemlink.clients.testmonitor.models.QueryStepValuesRequest[source]
Show JSON schema
{ "title": "QueryStepValuesRequest", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "field": { "$ref": "#/$defs/StepField" }, "startsWith": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Startswith" } }, "$defs": { "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" ], "title": "StepField", "type": "string" } }, "required": [ "field" ] }
- Fields
-
field starts_with:
Optional[str] = None Only return string parameters prefixed by this value (case sensitive).
- pydantic model nisystemlink.clients.testmonitor.models.QueryStepsRequest[source]
Show JSON schema
{ "title": "QueryStepsRequest", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/StepOrderBy" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "returnCount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Returncount" }, "resultFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resultfilter" }, "resultSubstitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Resultsubstitutions" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/StepProjection" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" } }, "$defs": { "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" ], "title": "StepOrderBy", "type": "string" }, "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" ], "title": "StepProjection", "type": "string" } } }
-
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.
-
field descending:
- pydantic model nisystemlink.clients.testmonitor.models.Result[source]
Contains information about a result.
Show JSON schema
{ "title": "Result", "description": "Contains information about a result.", "type": "object", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "statusTypeSummary": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "propertyNames": { "$ref": "#/$defs/StatusType" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Statustypesummary" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "$defs": { "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } } }
- Fields
-
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_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)[source]
The allowed field for which the values can be queried for.
- class nisystemlink.clients.testmonitor.models.ResultProjection(value)[source]
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[source]
Contains information about a status object.
Show JSON schema
{ "title": "Status", "description": "Contains information about a status object.", "type": "object", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "$defs": { "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } }, "required": [ "statusType" ] }
- Fields
-
field status_name:
Optional[str] = None The name of the status.
-
field status_type:
StatusType[Required] The type of status.
- class nisystemlink.clients.testmonitor.models.StatusType(value)[source]
The types of statuses that a result can have.
- pydantic model nisystemlink.clients.testmonitor.models.Step[source]
Show JSON schema
{ "title": "Step", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stepid" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resultid" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path" }, "pathIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Pathids" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "hasChildren": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Haschildren" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "$defs": { "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" } } }
- Fields
-
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 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[float] = 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[source]
Show JSON schema
{ "title": "StepData", "type": "object", "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "$defs": { "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" } } }
- Fields
-
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)[source]
The valid field values that can be queried.
This contains only limited fields available in a Step.
- pydantic model nisystemlink.clients.testmonitor.models.StepIdResultIdPair[source]
Show JSON schema
{ "title": "StepIdResultIdPair", "type": "object", "properties": { "stepId": { "title": "Stepid", "type": "string" }, "resultId": { "title": "Resultid", "type": "string" } }, "required": [ "stepId", "resultId" ] }
-
field result_id:
str[Required] The ID of the result associated with the step.
-
field step_id:
str[Required] The ID of the step.
-
field result_id:
- class nisystemlink.clients.testmonitor.models.StepOrderBy(value)[source]
The valid ways to order steps query response.
This contains only limited fields available in a Step.
- class nisystemlink.clients.testmonitor.models.StepProjection(value)[source]
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[source]
Contains information about a result.
Show JSON schema
{ "title": "UpdateResultRequest", "description": "Contains information about a result.", "type": "object", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "title": "Id", "type": "string" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "$defs": { "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" } }, "required": [ "id" ] }
- Fields
-
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 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[source]
Show JSON schema
{ "title": "UpdateResultsPartialSuccess", "type": "object", "properties": { "results": { "items": { "$ref": "#/$defs/Result" }, "title": "Results", "type": "array" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateResultRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "Result": { "description": "Contains information about a result.", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "statusTypeSummary": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "propertyNames": { "$ref": "#/$defs/StatusType" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Statustypesummary" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "title": "Result", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "UpdateResultRequest": { "description": "Contains information about a result.", "properties": { "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "programName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Programname" }, "id": { "title": "Id", "type": "string" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "hostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostname" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Serialnumber" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Operator" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "dataTableIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Datatableids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" } }, "required": [ "id" ], "title": "UpdateResultRequest", "type": "object" } }, "required": [ "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 error:
- pydantic model nisystemlink.clients.testmonitor.models.UpdateStepRequest[source]
Show JSON schema
{ "$defs": { "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" }, "UpdateStepRequest": { "properties": { "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stepid" }, "resultId": { "title": "Resultid", "type": "string" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "children": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Children" } }, "required": [ "stepId", "resultId" ], "title": "UpdateStepRequest", "type": "object" } }, "$ref": "#/$defs/UpdateStepRequest" }
-
field children:
Optional[List[UpdateStepRequest]] = None Nested child steps.
-
field name:
Optional[str] = None Step name.
-
field children:
- pydantic model nisystemlink.clients.testmonitor.models.UpdateStepsPartialSuccess[source]
Show JSON schema
{ "title": "UpdateStepsPartialSuccess", "type": "object", "properties": { "steps": { "items": { "$ref": "#/$defs/Step" }, "title": "Steps", "type": "array" }, "failed": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" }, "Measurement": { "additionalProperties": { "type": "string" }, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "measurement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Measurement" }, "lowLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Lowlimit" }, "highLimit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Highlimit" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" }, "comparisonType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Comparisontype" } }, "title": "Measurement", "type": "object" }, "NamedValue": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "default": null, "title": "Value" } }, "required": [ "name" ], "title": "NamedValue", "type": "object" }, "Status": { "description": "Contains information about a status object.", "properties": { "statusType": { "$ref": "#/$defs/StatusType" }, "statusName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusname" } }, "required": [ "statusType" ], "title": "Status", "type": "object" }, "StatusType": { "description": "The types of statuses that a result can have.", "enum": [ "LOOPING", "SKIPPED", "CUSTOM", "DONE", "PASSED", "FAILED", "RUNNING", "WAITING", "TERMINATED", "ERRORED", "TIMED_OUT" ], "title": "StatusType", "type": "string" }, "Step": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stepid" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resultid" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path" }, "pathIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Pathids" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "hasChildren": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Haschildren" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "title": "Step", "type": "object" }, "StepData": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "parameters": { "anyOf": [ { "items": { "$ref": "#/$defs/Measurement" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "StepData", "type": "object" }, "UpdateStepRequest": { "properties": { "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stepid" }, "resultId": { "title": "Resultid", "type": "string" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "data": { "anyOf": [ { "$ref": "#/$defs/StepData" }, { "type": "null" } ], "default": null }, "dataModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datamodel" }, "startedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Startedat" }, "status": { "anyOf": [ { "$ref": "#/$defs/Status" }, { "type": "null" } ], "default": null }, "stepType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Steptype" }, "totalTimeInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Totaltimeinseconds" }, "inputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Inputs" }, "outputs": { "anyOf": [ { "items": { "$ref": "#/$defs/NamedValue" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Outputs" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "children": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateStepRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Children" } }, "required": [ "stepId", "resultId" ], "title": "UpdateStepRequest", "type": "object" } }, "required": [ "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 error:
- pydantic model nisystemlink.clients.testmonitor.models.V2Operations[source]
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": "#/$defs/Operation" }, "queryProducts": { "$ref": "#/$defs/Operation" }, "createProducts": { "$ref": "#/$defs/Operation" }, "updateProducts": { "$ref": "#/$defs/Operation" }, "deleteProducts": { "$ref": "#/$defs/Operation" }, "deleteManyProducts": { "$ref": "#/$defs/Operation" }, "getResults": { "$ref": "#/$defs/Operation" }, "getResultsPropertyKeys": { "$ref": "#/$defs/Operation" }, "queryResults": { "$ref": "#/$defs/Operation" }, "createResults": { "$ref": "#/$defs/Operation" }, "updateResults": { "$ref": "#/$defs/Operation" }, "deleteResult": { "$ref": "#/$defs/Operation" }, "deleteManyResults": { "$ref": "#/$defs/Operation" }, "getSteps": { "$ref": "#/$defs/Operation" }, "querySteps": { "$ref": "#/$defs/Operation" }, "createSteps": { "$ref": "#/$defs/Operation" }, "updateSteps": { "$ref": "#/$defs/Operation" }, "deleteStep": { "$ref": "#/$defs/Operation" }, "deleteManySteps": { "$ref": "#/$defs/Operation" }, "queryPaths": { "$ref": "#/$defs/Operation" } }, "$defs": { "Operation": { "description": "Represents an operation that can be performed on a data frame.", "properties": { "available": { "title": "Available", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "available", "version" ], "title": "Operation", "type": "object" } }, "required": [ "getProducts", "queryProducts", "createProducts", "updateProducts", "deleteProducts", "deleteManyProducts", "getResults", "getResultsPropertyKeys", "queryResults", "createResults", "updateResults", "deleteResult", "deleteManyResults", "getSteps", "querySteps", "createSteps", "updateSteps", "deleteStep", "deleteManySteps", "queryPaths" ] }
- Fields
-
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.