nisystemlink.clients.test_plan
- class nisystemlink.clients.test_plan.TestPlanClient(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 WorkOrder Service.
- create_test_plans(test_plans)[source]
Create a new test plan.
- Parameters
test_plan – The test plans to create.
- Return type
nisystemlink.clients.test_plan.models.CreateTestPlansPartialSuccessResponse- Returns
The created test plan object.
- delete_test_plans(ids)[source]
Delete test plans by IDs.
- Parameters
test_plan_ids – A list of test plan IDs to delete.
- Return type
None- Returns
None
- query_test_plans(query_request)[source]
Query test plans.
- Parameters
query – The query to execute.
- Return type
- Returns
A PagedTestPlans object containing test plans that match the query.
- schedule_test_plans(schedule_request)[source]
Schedule a test plan.
- Parameters
schedule – The schedule to apply to the test plan.
- Return type
nisystemlink.clients.test_plan.models.ScheduleTestPlansResponse- Returns
A ScheduleTestPlansResponse object containing the scheduled test plan.
- update_test_plans(update_request)[source]
Update a test plan.
- Parameters
test_plan – The test plan to update.
- Return type
nisystemlink.clients.test_plan.models.UpdateTestPlansResponse- Returns
The updated test plan object.
- get_test_plan(test_plan_id)[source]
Retrieve a test plan by its ID.
- Parameters
test_plan_id (
str) – The ID of the test plan to retrieve.- Return type
- Returns
The TestPlan object corresponding to the given ID.
- create_test_plan_templates(test_plan_templates)[source]
Creates one or more test plan template and return errors for failed creations.
- Parameters
test_plan_templates (
List[nisystemlink.clients.test_plan.models.CreateTestPlanTemplateRequest]) – A list of test plan templates to attempt to create.- Return type
nisystemlink.clients.test_plan.models.CreateTestPlanTemplatePartialSuccessResponse
- Returns: A list of created test plan templates, test plan templates that failed to create, and errors for
failures.
- Raises: ApiException: if unable to communicate with the /niworkorder service of provided invalid
arguments.
- query_test_plan_templates(query_test_plan_templates)[source]
Queries one or more test plan templates and return errors for failed queries.
Returns: A list of test plan templates, based on the query and errors for the wrong query.
- Raises: ApiException: if unable to communicate with the /niworkorder service of provided invalid
arguments.
- delete_test_plan_templates(ids)[source]
Deletes one or more test plan templates and return errors for failed deletion.
- Return type
Optional[nisystemlink.clients.test_plan.models.DeleteTestPlanTemplatesPartialSuccessResponse]- Returns
A partial success if any test plan templates failed to delete, or None if all test plan templates were deleted successfully.
- Raises: ApiException: if unable to communicate with the /niworkorder service of provided invalid
arguments.
- pydantic model nisystemlink.clients.test_plan.models.CreateTestPlanRequest[source]
Represents the request body content for creating a test plan.
Show JSON schema
{ "title": "CreateTestPlanRequest", "description": "Represents the request body content for creating a test plan.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" } }, "$defs": { "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" } } }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the test plan.
-
field description:
Optional[str] = None A description of the test plan.
-
field dut_id:
Optional[str] = None The Device Under Test (DUT) ID.
-
field estimated_duration_in_seconds:
Optional[int] = None The estimated duration of the test plan in seconds.
-
field execution_actions:
Optional[List[AnnotatedAlias[Union[NotebookExecution,ManualExecution,JobExecution,NoneExecution]]]] = None List of execution actions for the test plan.
-
field file_ids_from_template:
Optional[List[str]] = None List of file IDs from the template.
-
field name:
Optional[str] = None The name of the test plan.
-
field part_number:
Optional[str] = None The part number associated with the test plan.
-
field properties:
Optional[Dict[str,str]] = None Additional properties for the test plan.
-
field state:
Optional[str] = None The state of the test plan.
-
field system_filter:
Optional[str] = None The system filter to apply.
-
field template_id:
Optional[str] = None The ID of the template to use for the test plan.
-
field test_program:
Optional[str] = None The test program associated with the test plan.
-
field work_order_id:
Optional[str] = None The work order ID associated with the test plan.
-
field workspace:
Optional[str] = None The workspace associated with the test plan.
- pydantic model nisystemlink.clients.test_plan.models.CreateTestPlanTemplatePartialSuccessResponse[source]
Show JSON schema
{ "title": "CreateTestPlanTemplatePartialSuccessResponse", "type": "object", "properties": { "createdTestPlanTemplates": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlanTemplate" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Createdtestplantemplates" }, "failedTestPlanTemplates": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateTestPlanTemplateRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failedtestplantemplates" }, "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" }, "CreateTestPlanTemplateRequest": { "description": "Contains information about a test plan template request.", "properties": { "name": { "title": "Name", "type": "string" }, "templateGroup": { "title": "Templategroup", "type": "string" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null } }, "required": [ "name", "templateGroup" ], "title": "CreateTestPlanTemplateRequest", "type": "object" }, "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "TestPlanTemplate": { "description": "Contains response information for test plan template.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templategroup" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" } }, "title": "TestPlanTemplate", "type": "object" } } }
-
field created_test_plan_templates:
Optional[List[TestPlanTemplate]] = None The list of test plan templates that were successfully created.
-
field error:
Optional[ApiError] = None Error messages for test plan templates that were not created.
If this is None, then all test plan templates were successfully created.
-
field failed_test_plan_templates:
Optional[List[CreateTestPlanTemplateRequest]] = None The list of test plan templates that were not created.
If this is None, then all test plan templates were successfully created.
-
field created_test_plan_templates:
- pydantic model nisystemlink.clients.test_plan.models.CreateTestPlanTemplateRequest[source]
Contains information about a test plan template request.
Show JSON schema
{ "title": "CreateTestPlanTemplateRequest", "description": "Contains information about a test plan template request.", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "templateGroup": { "title": "Templategroup", "type": "string" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null } }, "$defs": { "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" } }, "required": [ "name", "templateGroup" ] }
- Fields
-
field name:
str[Required] Name of the test plan template.
-
field template_group:
str[Required] The template group defined by the user.
- pydantic model nisystemlink.clients.test_plan.models.CreateTestPlansPartialSuccessResponse[source]
Represents the response from creating test plans, including successfully created, failed test plans, and any associated errors.
Show JSON schema
{ "title": "CreateTestPlansPartialSuccessResponse", "description": "Represents the response from creating test plans, including successfully created,\nfailed test plans, and any associated errors.", "type": "object", "properties": { "createdTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlan" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Createdtestplans" }, "failedTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateTestPlanRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failedtestplans" }, "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" }, "CreateTestPlanRequest": { "description": "Represents the request body content for creating a test plan.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" } }, "title": "CreateTestPlanRequest", "type": "object" }, "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this test plan.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "DashboardUrl", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "JobExecutionEvent": { "description": "A concrete execution event that represents an event triggered by a job.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "A concrete execution event that represents an event triggered manually.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "NotebookExecutionEvent": { "description": "Represents an execution event that was triggered by a notebook execution.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } }, "title": "NotebookExecutionEvent", "type": "object" }, "State": { "description": "The state of the test plan.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "TestPlan": { "description": "Contains information about a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Substate" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "workOrderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workordername" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "executionHistory": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionEvent", "MANUAL": "#/$defs/ManualExecutionEvent", "NOTEBOOK": "#/$defs/NotebookExecutionEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecutionEvent" }, { "$ref": "#/$defs/ManualExecutionEvent" }, { "$ref": "#/$defs/JobExecutionEvent" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionhistory" }, "dashboardUrl": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboardurl" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "TestPlan", "type": "object" } } }
-
field created_test_plans:
Optional[List[TestPlan]] = None List of test plans that were successfully created.
-
field failed_test_plans:
Optional[List[CreateTestPlanRequest]] = None List of test plans that failed to be created, with their request body content.
-
field created_test_plans:
- pydantic model nisystemlink.clients.test_plan.models.Dashboard[source]
Represents a dashboard reference.
Show JSON schema
{ "title": "Dashboard", "description": "Represents a dashboard reference.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } } }
-
field id:
Optional[str] = None ID of the dashboard
-
field variables:
Optional[Dict[str,str]] = None Variables for the dashboard
-
field id:
- pydantic model nisystemlink.clients.test_plan.models.DashboardUrl[source]
Definition and URL of the dashboard reference associated with this test plan.
Show JSON schema
{ "title": "DashboardUrl", "description": "Definition and URL of the dashboard reference associated with this test plan.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } } }
- Fields
-
field url:
Optional[str] = None URL of the dashboard reference associated with this test plan.
- pydantic model nisystemlink.clients.test_plan.models.DeleteTestPlanTemplatesPartialSuccessResponse[source]
The result of deleting multiple test plan templates when one or more test plan templates could not be deleted.
Show JSON schema
{ "title": "DeleteTestPlanTemplatesPartialSuccessResponse", "description": "The result of deleting multiple test plan templates\nwhen one or more test plan templates could not be deleted.", "type": "object", "properties": { "deletedTestPlanTemplateIds": { "items": { "type": "string" }, "title": "Deletedtestplantemplateids", "type": "array" }, "failedTestPlanTemplateIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failedtestplantemplateids" }, "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": [ "deletedTestPlanTemplateIds" ] }
-
field deleted_test_plan_template_ids:
List[str] [Required] The IDs of the test plan template that could not be deleted.
-
field error:
Optional[ApiError] = None The error that occurred when deleting the test plan template.
-
field failed_test_plan_template_ids:
Optional[List[str]] = None The IDs of the test plan template that could not be deleted.
-
field deleted_test_plan_template_ids:
- pydantic model nisystemlink.clients.test_plan.models.Job[source]
Represents a job to be executed, including its functions, arguments, and metadata.
Show JSON schema
{ "title": "Job", "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "type": "object", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ] }
-
field arguments:
List[List[Any]] [Required] List of argument lists for each function.
-
field functions:
List[str] [Required] List of function names to execute.
-
field metadata:
Dict[str,Any] [Required] Additional metadata for the job.
-
field arguments:
- pydantic model nisystemlink.clients.test_plan.models.JobExecution[source]
Defines the execution of one or more jobs.
Show JSON schema
{ "title": "JobExecution", "description": "Defines the execution of one or more jobs.", "type": "object", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "$defs": { "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" } }, "required": [ "action" ] }
-
field action:
str[Required] User defined action to perform in workflow (user defined).
-
field systemId:
Optional[str] = None Optional system ID where jobs will run.
-
field type:
Literal['JOB'] = 'JOB' Type of execution, default is ‘JOB’.
-
field action:
- pydantic model nisystemlink.clients.test_plan.models.JobExecutionEvent[source]
A concrete execution event that represents an event triggered by a job.
Show JSON schema
{ "title": "JobExecutionEvent", "description": "A concrete execution event that represents an event triggered by a job.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } } }
-
field job_ids:
Optional[List[str]] = None Includes the type identifier and a list of job IDs.
-
field type:
Literal['JOB'] = 'JOB' Represents an execution event triggered by a job.
-
field job_ids:
- pydantic model nisystemlink.clients.test_plan.models.ManualExecution[source]
Represents a manual execution definition.
Show JSON schema
{ "title": "ManualExecution", "description": "Represents a manual execution definition.", "type": "object", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ] }
-
field action:
str[Required] User defined action to perform in workflow (user defined).
-
field type:
Literal['MANUAL'] = 'MANUAL' Type of execution, default is ‘MANUAL’.
-
field action:
- pydantic model nisystemlink.clients.test_plan.models.ManualExecutionEvent[source]
A concrete execution event that represents an event triggered manually.
Show JSON schema
{ "title": "ManualExecutionEvent", "description": "A concrete execution event that represents an event triggered manually.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } } }
- Fields
-
field type:
Literal['MANUAL'] = 'MANUAL' Represents an execution event triggered manually. Includes only the type identifier.
- pydantic model nisystemlink.clients.test_plan.models.NoneExecution[source]
Represents a definition where no execution is specified.
Show JSON schema
{ "title": "NoneExecution", "description": "Represents a definition where no execution is specified.", "type": "object", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ] }
-
field action:
str[Required] User defined action to perform in workflow (user defined).
-
field type:
Literal['NONE'] = 'NONE' Type of execution, default is ‘NONE’.
-
field action:
- pydantic model nisystemlink.clients.test_plan.models.NotebookExecution[source]
Defines the execution of a notebook.
Show JSON schema
{ "title": "NotebookExecution", "description": "Defines the execution of a notebook.", "type": "object", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ] }
- Fields
-
field action:
str[Required] User defined action to perform in workflow (user defined).
-
field notebookId:
str[Required] ID of the notebook to execute.
-
field parameters:
Optional[Dict[str,str]] = None Dictionary of parameters that will be passed to the notebook when the execution is run.
-
field type:
Literal['NOTEBOOK'] = 'NOTEBOOK' Type of execution, default is ‘NOTEBOOK’.
- pydantic model nisystemlink.clients.test_plan.models.NotebookExecutionEvent[source]
Represents an execution event that was triggered by a notebook execution.
Show JSON schema
{ "title": "NotebookExecutionEvent", "description": "Represents an execution event that was triggered by a notebook execution.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } } }
- Fields
-
field execution_id:
Optional[str] = None Includes the type identifier and the execution ID.
-
field type:
Literal['NOTEBOOK'] = 'NOTEBOOK' Represents an execution event triggered by a notebook.
- pydantic model nisystemlink.clients.test_plan.models.PagedTestPlanTemplates[source]
The response containing the list of products, total count of products and the continuation token if applicable.
Show JSON schema
{ "title": "PagedTestPlanTemplates", "description": "The response containing the list of products, total count of products and the continuation\ntoken if applicable.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "testPlanTemplates": { "items": { "$ref": "#/$defs/TestPlanTemplate" }, "title": "Testplantemplates", "type": "array" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "TestPlanTemplate": { "description": "Contains response information for test plan template.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templategroup" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" } }, "title": "TestPlanTemplate", "type": "object" } }, "required": [ "testPlanTemplates" ] }
- Fields
-
field test_plan_templates:
List[TestPlanTemplate] [Required] A list of all the products in this page.
-
field total_count:
Optional[int] = None The total number of products that match the query.
- pydantic model nisystemlink.clients.test_plan.models.PagedTestPlans[source]
The response containing the list of products, total count of products and the continuation token if applicable.
Show JSON schema
{ "title": "PagedTestPlans", "description": "The response containing the list of products, total count of products and the continuation\ntoken if applicable.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "testPlans": { "items": { "$ref": "#/$defs/TestPlan" }, "title": "Testplans", "type": "array" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this test plan.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "DashboardUrl", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "JobExecutionEvent": { "description": "A concrete execution event that represents an event triggered by a job.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "A concrete execution event that represents an event triggered manually.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "NotebookExecutionEvent": { "description": "Represents an execution event that was triggered by a notebook execution.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } }, "title": "NotebookExecutionEvent", "type": "object" }, "State": { "description": "The state of the test plan.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "TestPlan": { "description": "Contains information about a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Substate" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "workOrderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workordername" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "executionHistory": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionEvent", "MANUAL": "#/$defs/ManualExecutionEvent", "NOTEBOOK": "#/$defs/NotebookExecutionEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecutionEvent" }, { "$ref": "#/$defs/ManualExecutionEvent" }, { "$ref": "#/$defs/JobExecutionEvent" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionhistory" }, "dashboardUrl": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboardurl" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "TestPlan", "type": "object" } }, "required": [ "testPlans" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of products that match the query.
- pydantic model nisystemlink.clients.test_plan.models.QueryTestPlanTemplatesRequest[source]
Request information for the query test plan templates API.
Show JSON schema
{ "title": "QueryTestPlanTemplatesRequest", "description": "Request information for the query test plan templates API.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/TestPlanTemplateOrderBy" }, { "type": "null" } ], "default": null }, "substitutions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlanTemplateField" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" } }, "$defs": { "TestPlanTemplateField": { "description": "Model for an object describing an test plan template with all of its properties.", "enum": [ "ID", "NAME", "TEMPLATE_GROUP", "PRODUCT_FAMILIES", "PART_NUMBERS", "SUMMARY", "DESCRIPTION", "TEST_PROGRAM", "ESTIMATED_DURATION_IN_SECONDS", "SYSTEM_FILTER", "EXECUTION_ACTIONS", "FILE_IDS", "WORKSPACE", "PROPERTIES", "DASHBOARD", "CREATED_BY", "UPDATED_BY", "CREATED_AT", "UPDATED_AT" ], "title": "TestPlanTemplateField", "type": "string" }, "TestPlanTemplateOrderBy": { "description": "An enumeration by which test plan templates can be ordered/sorted.", "enum": [ "ID", "NAME", "TEMPLATE_GROUP", "CREATED_AT", "UPDATED_AT" ], "title": "TestPlanTemplateOrderBy", "type": "string" } } }
-
field descending:
Optional[bool] = None Whether to return the test plan templates in the descending order. By default, test plan templates are sorted in the ascending order.
-
field filter:
Optional[str] = None The test plan template query filter in dynamic LINQ format.
id: String representing the ID of a test plan template. Field supports only equals ‘=’ and not equal ‘!=’ operators for filtering. productFamilies: Array of strings representing the product families to which the test plan template belongs. partNumbers: Array of strings representing the part numbers of the products to which the test plan template belongs. fileIds: The array of file IDs associated with the test plan template. name: String representing the name of a test plan template. summary: String representing the summary of a test plan template. description: String representing description of the test plan created from this template. templateGroup: String representing the template group defined by the user. testProgram: String representing the test program name of the test plan created from this template. systemFilter: String representing the LINQ filter used to filter the potential list of systems capable of executing test plans created from this template. workspace: String representing the workspace where the test plan template belongs. createdBy: String representing the user who created the test plan template. updatedBy: String representing the user who updated the test plan template. createdAt: ISO-8601 formatted timestamp indicating when the test plan template was created. updatedAt: ISO-8601 formatted timestamp indicating when the test plan template was most recently updated. properties: Collection of key-value pairs related to a test plan created from this template. Example: properties.Any(key == “Location” & value == “Austin”)
See [Dynamic Linq](https://github.com/ni/systemlink-OpenAPI-documents/wiki/Dynamic-Linq-Query-Language) documentation for more details.
“@0”, “@1” etc. can be used in conjunction with the substitutions parameter to keep this query string more simple and reusable.
-
field order_by:
Optional[TestPlanTemplateOrderBy] = None Field by which test plan templates can be ordered/sorted.
-
field projection:
Optional[List[TestPlanTemplateField]] = None Gets or sets the projection to be used when retrieving the assets. If not specified, all properties will be returned.
-
field substitutions:
Optional[List[str]] = None Makes substitutions in the query filter expression using non-negative integers. These integers use the @ symbol as a prefix. The filter expression replaces each substitution with the element at the corresponding index in this list. The index is zero-based.
-
field take:
Optional[int] = None The maximum number of test plan templates to return.
-
field descending:
- pydantic model nisystemlink.clients.test_plan.models.QueryTestPlansRequest[source]
Represents the request body for querying test plans. Allows filtering, sorting, and pagination of test plan results.
Show JSON schema
{ "title": "QueryTestPlansRequest", "description": "Represents the request body for querying test plans.\nAllows filtering, sorting, and pagination of test plan results.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/OrderBy" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "returnCount": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Returncount" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlanField" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" } }, "$defs": { "OrderBy": { "description": "The state of the test plan.", "enum": [ "ID", "UPDATE_AT" ], "title": "OrderBy", "type": "string" }, "TestPlanField": { "description": "Model for an object describing an test plan with all of its properties.", "enum": [ "ID", "TEMPLATE_ID", "NAME", "STATE", "SUBSTATE", "DESCRIPTION", "ASSIGNED_TO", "WORK_ORDER_ID", "WORK_ORDER_NAME", "WORKSPACE", "CREATED_BY", "UPDATED_BY", "CREATED_AT", "UPDATED_AT", "PROPERTIES", "PART_NUMBER", "DUT_ID", "TEST_PROGRAM", "SYSTEM_ID", "FIXTURE_IDS", "SYSTEM_FILTER", "PLANNED_START_DATE_TIME", "ESTIMATED_END_DATE_TIME", "ESTIMATED_DURATION_IN_SECONDS", "FILE_IDS_FROM_TEMPLATE", "EXECUTION_ACTIONS", "EXECUTION_HISTORY", "DASHBOARD_URL", "DASHBOARD", "WORKFLOW" ], "title": "TestPlanField", "type": "string" } } }
-
field descending:
Optional[bool] = None Whether to sort the test plans in descending order.
-
field filter:
Optional[str] = None A string expression to filter the test plans returned by the query.
-
field projection:
Optional[List[TestPlanField]] = None Gets or sets the projection to be used when retrieving the assets. If not specified, all properties will be returned.
-
field return_count:
Optional[bool] = None Whether to include the total count of matching test plans in the response.
-
field take:
Optional[int] = None The maximum number of test plans to return in the response.
-
field descending:
- pydantic model nisystemlink.clients.test_plan.models.ScheduleTestPlanRequest[source]
Represents the request body content for scheduling a test plan.
Show JSON schema
{ "title": "ScheduleTestPlanRequest", "description": "Represents the request body content for scheduling a test plan.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" } }, "required": [ "id" ] }
- Fields
-
field assigned_to:
Optional[str] = None (Optional) User or entity to whom the test plan is assigned.
-
field dut_id:
Optional[str] = None (Optional) Identifier for the Device Under Test (DUT).
-
field estimated_duration_in_seconds:
Optional[int] = None (Optional) Estimated duration of the test plan execution in seconds.
-
field estimated_end_date_time:
Optional[datetime] = None (Optional) Estimated end date and time for the test plan execution (ISO 8601 format).
-
field fixture_ids:
Optional[List[str]] = None (Optional) List of fixture identifiers associated with the test plan.
-
field id:
str[Required] Unique identifier for the test plan to be scheduled.
-
field planned_start_date_time:
Optional[datetime] = None (Optional) Planned start date and time for the test plan execution (ISO 8601 format).
-
field system_id:
Optional[str] = None (Optional) Identifier for the system where the test plan will run.
- pydantic model nisystemlink.clients.test_plan.models.ScheduleTestPlansRequest[source]
Represents the request body for scheduling multiple test plans.
Show JSON schema
{ "title": "ScheduleTestPlansRequest", "description": "Represents the request body for scheduling multiple test plans.", "type": "object", "properties": { "testPlans": { "items": { "$ref": "#/$defs/ScheduleTestPlanRequest" }, "title": "Testplans", "type": "array" }, "replace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Replace" } }, "$defs": { "ScheduleTestPlanRequest": { "description": "Represents the request body content for scheduling a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" } }, "required": [ "id" ], "title": "ScheduleTestPlanRequest", "type": "object" } }, "required": [ "testPlans" ] }
- Fields
-
field replace:
Optional[bool] = None (Optional) If true, replaces existing scheduled test plans.
-
field test_plans:
List[ScheduleTestPlanRequest] [Required] List of test plan scheduling content objects.
- pydantic model nisystemlink.clients.test_plan.models.ScheduleTestPlansResponse[source]
Represents the response returned after attempting to schedule one or more test plans.
Show JSON schema
{ "title": "ScheduleTestPlansResponse", "description": "Represents the response returned after attempting to schedule one or more test plans.", "type": "object", "properties": { "scheduledTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlan" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Scheduledtestplans" }, "failedTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/ScheduleTestPlanRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failedtestplans" }, "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" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this test plan.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "DashboardUrl", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "JobExecutionEvent": { "description": "A concrete execution event that represents an event triggered by a job.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "A concrete execution event that represents an event triggered manually.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "NotebookExecutionEvent": { "description": "Represents an execution event that was triggered by a notebook execution.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ScheduleTestPlanRequest": { "description": "Represents the request body content for scheduling a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" } }, "required": [ "id" ], "title": "ScheduleTestPlanRequest", "type": "object" }, "State": { "description": "The state of the test plan.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "TestPlan": { "description": "Contains information about a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Substate" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "workOrderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workordername" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "executionHistory": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionEvent", "MANUAL": "#/$defs/ManualExecutionEvent", "NOTEBOOK": "#/$defs/NotebookExecutionEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecutionEvent" }, { "$ref": "#/$defs/ManualExecutionEvent" }, { "$ref": "#/$defs/JobExecutionEvent" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionhistory" }, "dashboardUrl": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboardurl" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "TestPlan", "type": "object" } } }
-
field failed_test_plans:
Optional[List[ScheduleTestPlanRequest]] = None (Optional) List of test plan requests that failed to schedule.
-
field failed_test_plans:
- pydantic model nisystemlink.clients.test_plan.models.TestPlan[source]
Contains information about a test plan.
Show JSON schema
{ "title": "TestPlan", "description": "Contains information about a test plan.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Substate" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "workOrderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workordername" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "executionHistory": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionEvent", "MANUAL": "#/$defs/ManualExecutionEvent", "NOTEBOOK": "#/$defs/NotebookExecutionEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecutionEvent" }, { "$ref": "#/$defs/ManualExecutionEvent" }, { "$ref": "#/$defs/JobExecutionEvent" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionhistory" }, "dashboardUrl": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboardurl" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null } }, "$defs": { "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this test plan.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "DashboardUrl", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "JobExecutionEvent": { "description": "A concrete execution event that represents an event triggered by a job.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "A concrete execution event that represents an event triggered manually.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "NotebookExecutionEvent": { "description": "Represents an execution event that was triggered by a notebook execution.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } }, "title": "NotebookExecutionEvent", "type": "object" }, "State": { "description": "The state of the test plan.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" } }, "required": [ "id" ] }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the test plan.
-
field created_At:
Optional[datetime] = None The date and time when the test plan was created.
-
field created_by:
Optional[str] = None The user who created the test plan.
-
field dashboard:
Optional[DashboardUrl] = None The dashboard data related to the test plan.
-
field dashboard_url:
Optional[Dict[str,str]] = None The URLs for dashboards related to the test plan.
-
field description:
Optional[str] = None The description of the test plan.
-
field dut_id:
Optional[str] = None The identifier of the device under test (DUT).
-
field estimated_duration_in_seconds:
Optional[float] = None The estimated duration of the test plan in seconds.
-
field estimated_end_date_time:
Optional[datetime] = None The estimated end date and time for the test plan.
-
field execution_actions:
Optional[List[AnnotatedAlias[Union[NotebookExecution,ManualExecution,JobExecution,NoneExecution]]]] = None The execution actions defined for the test plan.
-
field execution_history:
Optional[List[AnnotatedAlias[Union[NotebookExecutionEvent,ManualExecutionEvent,JobExecutionEvent]]]] = None The execution history of the test plan.
-
field file_ids_from_template:
Optional[List[str]] = None The list of file identifiers inherited from the template.
-
field fixture_ids:
Optional[List[str]] = None The list of fixture identifiers associated with the test plan.
-
field id:
str[Required] The unique identifier of the test plan.
-
field name:
Optional[str] = None The name of the test plan.
-
field part_number:
Optional[str] = None The part number associated with the test plan.
-
field planned_start_date_time:
Optional[datetime] = None The planned start date and time for the test plan.
-
field properties:
Optional[Dict[str,str]] = None Additional properties associated with the test plan.
-
field substate:
Optional[str] = None The substate of the test plan, if any.
-
field system_filter:
Optional[str] = None The filter used to select systems for the test plan.
-
field system_id:
Optional[str] = None The identifier of the system used for the test plan.
-
field template_id:
Optional[str] = None The identifier of the template used to create the test plan.
-
field test_program:
Optional[str] = None The test program associated with the test plan.
-
field updated_at:
Optional[datetime] = None The date and time when the test plan was last updated.
-
field updated_by:
Optional[str] = None The user who last updated the test plan.
-
field work_order_id:
Optional[str] = None The identifier of the associated work order.
-
field work_order_name:
Optional[str] = None The name of the associated work order.
-
field workspace:
Optional[str] = None The workspace to which the test plan belongs.
- class nisystemlink.clients.test_plan.models.TestPlanField(value)[source]
Model for an object describing an test plan with all of its properties.
- pydantic model nisystemlink.clients.test_plan.models.TestPlanTemplate[source]
Contains response information for test plan template.
Show JSON schema
{ "title": "TestPlanTemplate", "description": "Contains response information for test plan template.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templategroup" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" } }, "$defs": { "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" } } }
- Fields
-
field created_at:
Optional[datetime] = None ISO-8601 formatted timestamp indicating when the test plan template was created.
-
field created_by:
Optional[str] = None ID of the user who created the test plan template.
-
field id:
Optional[str] = None The globally unique id of the test plan template.
-
field name:
Optional[str] = None Name of the test plan template.
-
field updated_at:
Optional[datetime] = None ISO-8601 formatted timestamp indicating when the test plan template was most recently updated.
-
field updated_by:
Optional[str] = None ID of the user who most recently updated the test plan template.
- pydantic model nisystemlink.clients.test_plan.models.TestPlanTemplateBase[source]
Contains information about a test plan template.
Show JSON schema
{ "title": "TestPlanTemplateBase", "description": "Contains information about a test plan template.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "templateGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templategroup" }, "productFamilies": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Productfamilies" }, "partNumbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Partnumbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "fileIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileids" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null } }, "$defs": { "Dashboard": { "description": "Represents a dashboard reference.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" } }, "title": "Dashboard", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" } } }
- Fields
-
field description:
Optional[str] = None Description of the test plan created from this template.
-
field estimated_duration_in_seconds:
Optional[int] = None The estimated time in seconds for executing the test plan created from this template.
-
field execution_actions:
Optional[List[AnnotatedAlias[Union[NotebookExecution,ManualExecution,JobExecution,NoneExecution]]]] = None Defines the executions that will be used for test plan actions created from this template.
-
field file_ids:
Optional[List[str]] = None Array of file IDs associated with the test plan template.
-
field name:
Optional[str] = None Name of the test plan template.
-
field part_numbers:
Optional[List[str]] = None Array of part numbers of the products to which the test plan template belongs.
-
field product_families:
Optional[List[str]] = None Array of product families to which the test plan template belongs.
-
field properties:
Optional[Dict[str,str]] = None Properties of the test plan created from this template as key-value pairs.
-
field summary:
Optional[str] = None Summary of the test plan template.
-
field system_filter:
Optional[str] = None The LINQ filter string is used to filter the potential list of systems capable of executing test plans created from this template.
-
field template_group:
Optional[str] = None The template group defined by the user.
-
field test_program:
Optional[str] = None Test program name of the test plan created from this template.
-
field workspace:
Optional[str] = None ID of the workspace where the test plan template belongs. Default workspace will be taken if the value is not given.
- class nisystemlink.clients.test_plan.models.TestPlanTemplateField(value)[source]
Model for an object describing an test plan template with all of its properties.
- class nisystemlink.clients.test_plan.models.TestPlanTemplateOrderBy(value)[source]
An enumeration by which test plan templates can be ordered/sorted.
- pydantic model nisystemlink.clients.test_plan.models.UpdateTestPlanRequest[source]
Represents the content for updating a single test plan.
Show JSON schema
{ "title": "UpdateTestPlanRequest", "description": "Represents the content for updating a single test plan.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" } }, "required": [ "id" ] }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the test plan.
-
field description:
Optional[str] = None The new description for the test plan.
-
field dut_id:
Optional[str] = None The device under test (DUT) identifier.
-
field file_ids_from_template:
Optional[List[str]] = None List of file IDs from the template to associate with the test plan.
-
field id:
str[Required] The unique identifier of the test plan to update.
-
field name:
Optional[str] = None The new name for the test plan.
-
field part_number:
Optional[str] = None The part number associated with the test plan.
-
field properties:
Optional[Dict[str,str]] = None Additional properties for the test plan as key-value pairs.
-
field state:
Optional[str] = None The new state of the test plan.
-
field test_program:
Optional[str] = None The test program associated with the test plan.
-
field work_order_id:
Optional[str] = None The work order identifier associated with the test plan.
-
field workspace:
Optional[str] = None The workspace to which the test plan belongs.
- pydantic model nisystemlink.clients.test_plan.models.UpdateTestPlansRequest[source]
Represents the request body for updating multiple test plans.
Show JSON schema
{ "title": "UpdateTestPlansRequest", "description": "Represents the request body for updating multiple test plans.", "type": "object", "properties": { "testPlans": { "items": { "$ref": "#/$defs/UpdateTestPlanRequest" }, "title": "Testplans", "type": "array" }, "replace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Replace" } }, "$defs": { "UpdateTestPlanRequest": { "description": "Represents the content for updating a single test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" } }, "required": [ "id" ], "title": "UpdateTestPlanRequest", "type": "object" } }, "required": [ "testPlans" ] }
- Fields
-
field replace:
Optional[bool] = None Whether to replace the existing test plans or update them.
-
field test_plans:
List[UpdateTestPlanRequest] [Required] A list of test plans to update.
- pydantic model nisystemlink.clients.test_plan.models.UpdateTestPlansResponse[source]
Represents the response after attempting to update test plans.
Show JSON schema
{ "title": "UpdateTestPlansResponse", "description": "Represents the response after attempting to update test plans.", "type": "object", "properties": { "updatedTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/TestPlan" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Updatedtestplans" }, "failedTestPlans": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateTestPlanRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failedtestplans" }, "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" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this test plan.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Variables" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "DashboardUrl", "type": "object" }, "Job": { "description": "Represents a job to be executed, including its functions, arguments, and metadata.", "properties": { "functions": { "items": { "type": "string" }, "title": "Functions", "type": "array" }, "arguments": { "items": { "items": {}, "type": "array" }, "title": "Arguments", "type": "array" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" } }, "required": [ "functions", "arguments", "metadata" ], "title": "Job", "type": "object" }, "JobExecution": { "description": "Defines the execution of one or more jobs.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Job" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobs" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" } }, "required": [ "action" ], "title": "JobExecution", "type": "object" }, "JobExecutionEvent": { "description": "A concrete execution event that represents an event triggered by a job.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "jobIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Jobids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Represents a manual execution definition.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "A concrete execution event that represents an event triggered manually.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Represents a definition where no execution is specified.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines the execution of a notebook.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "notebookId": { "title": "Notebookid", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "action", "notebookId" ], "title": "NotebookExecution", "type": "object" }, "NotebookExecutionEvent": { "description": "Represents an execution event that was triggered by a notebook execution.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggeredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredat" }, "triggeredBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggeredby" }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "executionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Executionid" } }, "title": "NotebookExecutionEvent", "type": "object" }, "State": { "description": "The state of the test plan.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "TestPlan": { "description": "Contains information about a test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Templateid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Substate" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "workOrderName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workordername" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "updatedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedby" }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdat" }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updatedat" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "systemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemid" }, "fixtureIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fixtureids" }, "systemFilter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Systemfilter" }, "plannedStartDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Plannedstartdatetime" }, "estimatedEndDateTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Estimatedenddatetime" }, "estimatedDurationInSeconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Estimateddurationinseconds" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" }, "executionActions": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecution", "MANUAL": "#/$defs/ManualExecution", "NONE": "#/$defs/NoneExecution", "NOTEBOOK": "#/$defs/NotebookExecution" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecution" }, { "$ref": "#/$defs/ManualExecution" }, { "$ref": "#/$defs/JobExecution" }, { "$ref": "#/$defs/NoneExecution" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionactions" }, "executionHistory": { "anyOf": [ { "items": { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionEvent", "MANUAL": "#/$defs/ManualExecutionEvent", "NOTEBOOK": "#/$defs/NotebookExecutionEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NotebookExecutionEvent" }, { "$ref": "#/$defs/ManualExecutionEvent" }, { "$ref": "#/$defs/JobExecutionEvent" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executionhistory" }, "dashboardUrl": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboardurl" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "TestPlan", "type": "object" }, "UpdateTestPlanRequest": { "description": "Represents the content for updating a single test plan.", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "dutId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dutid" }, "partNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Partnumber" }, "assignedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assignedto" }, "testProgram": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Testprogram" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "workOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workorderid" }, "fileIdsFromTemplate": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Fileidsfromtemplate" } }, "required": [ "id" ], "title": "UpdateTestPlanRequest", "type": "object" } } }
-
field failed_test_plans:
Optional[List[UpdateTestPlanRequest]] = None List of test plans that failed to update.
-
field failed_test_plans: