nisystemlink.clients.work_item
- class nisystemlink.clients.work_item.WorkItemClient(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 WorkItem Service.
- create_work_items(work_items)[source]
Creates one or more work items.
- Parameters
work_items (
List[nisystemlink.clients.work_item.models.CreateWorkItemRequest]) – A list of work items to create.- Return type
nisystemlink.clients.work_item.models.CreateWorkItemsPartialSuccessResponse- Returns
A list of created work items, work items that failed to create, and errors for failures.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- query_work_items(query_work_items)[source]
Queries one or more work items.
- Parameters
query_work_items (
nisystemlink.clients.work_item.models.QueryWorkItemsRequest) – The query request for work items.- Return type
- Returns
A list of work items based on the query.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- get_work_item(work_item_id)[source]
Retrieves a work item by its ID.
- Parameters
work_item_id (
str) – The ID of the work item to retrieve.- Return type
- Returns
The work item corresponding to the given ID.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- update_work_items(update_work_items)[source]
Updates one or more work items.
- Parameters
update_work_items (
nisystemlink.clients.work_item.models.UpdateWorkItemsRequest) – The update request containing work items to update.- Return type
nisystemlink.clients.work_item.models.UpdateWorkItemsPartialSuccessResponse- Returns
A list of updated work items, work items that failed to update, and errors for failures.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- schedule_work_items(schedule_work_items)[source]
Schedule work items.
- Parameters
schedule_work_items (
nisystemlink.clients.work_item.models.ScheduleWorkItemsRequest) – The schedule request for work item.- Return type
nisystemlink.clients.work_item.models.ScheduleWorkItemsPartialSuccessResponse- Returns
A list of scheduled work items, work items that failed to schedule, and errors for failures.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- delete_work_items(ids)[source]
Deletes one or more work items by IDs.
- Parameters
ids (
List[str]) – A list of work item IDs to delete.- Return type
Optional[nisystemlink.clients.work_item.models.DeleteWorkItemsPartialSuccessResponse]- Returns
A partial success if any work items failed to delete, or None if all work items were deleted successfully.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- execute_work_item(work_item_id, action)[source]
Executes the specified action for the work item.
- Parameters
work_item_id (
str) – The ID of the work item the action will be performed on.action (
str) – The action to execute on the work item.
- Return type
nisystemlink.clients.work_item.models.ExecuteWorkItemResponse- Returns
The response containing the execution result.
- Raises
WorkItemExecuteApiException – if the API returns an error response with an execute-specific body. The
resultproperty may contain partial results (e.g. cancelled job IDs).ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- create_work_item_templates(work_item_templates)[source]
Creates one or more work item templates.
- Parameters
work_item_templates (
List[nisystemlink.clients.work_item.models.CreateWorkItemTemplateRequest]) – A list of work item templates to create.- Return type
nisystemlink.clients.work_item.models.CreateWorkItemTemplatesPartialSuccessResponse- Returns
A list of created work item templates, templates that failed to create, and errors for failures.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- query_work_item_templates(query_work_item_templates)[source]
Queries one or more work item templates.
- Parameters
query_work_item_templates (
nisystemlink.clients.work_item.models.QueryWorkItemTemplatesRequest) – The query request for work item templates.- Return type
nisystemlink.clients.work_item.models.PagedWorkItemTemplates- Returns
A list of work item templates based on the query.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- update_work_item_templates(update_work_item_templates)[source]
Updates one or more work item templates.
- Parameters
update_work_item_templates (
nisystemlink.clients.work_item.models.UpdateWorkItemTemplatesRequest) – The update request containing work item templates to update.- Return type
nisystemlink.clients.work_item.models.UpdateWorkItemTemplatesPartialSuccessResponse- Returns
A list of updated work item templates, templates that failed to update, and errors for failures.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- delete_work_item_templates(ids)[source]
Deletes one or more work item templates.
- Parameters
ids (
List[str]) – A list of work item template IDs to delete.- Return type
Optional[nisystemlink.clients.work_item.models.DeleteWorkItemTemplatesPartialSuccessResponse]- Returns
A partial success if any work item templates failed to delete, or None if all work item templates were deleted successfully.
- Raises
ApiException – if unable to communicate with the /niworkitem service or provided invalid arguments.
- pydantic model nisystemlink.clients.work_item.models.CreateWorkItemRequest[source]
Represents the request body content for creating a work item.
Show JSON schema
{ "title": "CreateWorkItemRequest", "description": "Represents the request body content for creating a work item.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" } } }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the work item.
-
field description:
Optional[str] = None A description of the work item.
-
field execution_actions:
Optional[List[Annotated[NotebookExecution|ManualExecution|JobExecution|NoneExecution]]] = None The execution actions defined for the work item.
-
field file_ids_from_template:
Optional[List[str]] = None The list of file IDs inherited from the template.
-
field name:
Optional[str] = None The name of the work item.
-
field parent_id:
Optional[str] = None The ID of the parent work item.
-
field part_number:
Optional[str] = None The part number associated with the work item.
-
field properties:
Optional[Dict[str,str]] = None Additional properties for the work item.
-
field requested_by:
Optional[str] = None The user or group who requested the work item.
-
field resources:
Optional[ResourcesDefinition] = None Resources reserved for the work item.
-
field state:
Optional[str] = None The state of the work item.
-
field template_id:
Optional[str] = None The ID of the template used to create the work item.
-
field test_program:
Optional[str] = None The test program associated with the work item.
-
field timeline:
Optional[TimelineDefinition] = None Timeline properties for the work item.
-
field type:
Optional[str] = None The type of the work item.
-
field workflow_id:
Optional[str] = None The ID of the workflow associated with the work item.
-
field workspace:
Optional[str] = None The workspace to which the work item belongs.
- pydantic model nisystemlink.clients.work_item.models.CreateWorkItemTemplateRequest[source]
Represents the request body content for creating a work item template.
Show JSON schema
{ "title": "CreateWorkItemTemplateRequest", "description": "Represents the request body content for creating a work item template.", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "template_group": { "title": "Template Group", "type": "string" }, "type": { "title": "Type", "type": "string" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" } }, "required": [ "name", "template_group", "type" ] }
- Fields
-
field name:
str[Required] The name of the work item template.
-
field template_group:
str[Required] The template group defined by the user.
-
field type:
str[Required] The type of work item created from this template.
- pydantic model nisystemlink.clients.work_item.models.CreateWorkItemTemplatesPartialSuccessResponse[source]
Response for creating work item templates with partial success.
Show JSON schema
{ "title": "CreateWorkItemTemplatesPartialSuccessResponse", "description": "Response for creating work item templates with partial success.", "type": "object", "properties": { "created_work_item_templates": { "items": { "$ref": "#/$defs/WorkItemTemplate" }, "title": "Created Work Item Templates", "type": "array" }, "failed_work_item_templates": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateWorkItemTemplateRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Work Item Templates" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "CreateWorkItemTemplateRequest": { "description": "Represents the request body content for creating a work item template.", "properties": { "name": { "title": "Name", "type": "string" }, "template_group": { "title": "Template Group", "type": "string" }, "type": { "title": "Type", "type": "string" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "required": [ "name", "template_group", "type" ], "title": "CreateWorkItemTemplateRequest", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" }, "WorkItemTemplate": { "description": "Contains response information for work item template.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "title": "WorkItemTemplate", "type": "object" } }, "required": [ "created_work_item_templates" ] }
-
field created_work_item_templates:
List[WorkItemTemplate] [Required] List of successfully created work item templates.
-
field error:
Optional[ApiError] = None The error that occurred when creating the work item templates.
-
field failed_work_item_templates:
Optional[List[CreateWorkItemTemplateRequest]] = None List of work item template requests that failed during creation.
-
field created_work_item_templates:
- pydantic model nisystemlink.clients.work_item.models.CreateWorkItemsPartialSuccessResponse[source]
Response for creating work items with partial success.
Show JSON schema
{ "title": "CreateWorkItemsPartialSuccessResponse", "description": "Response for creating work items with partial success.", "type": "object", "properties": { "created_work_items": { "items": { "$ref": "#/$defs/WorkItem" }, "title": "Created Work Items", "type": "array" }, "failed_work_items": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateWorkItemRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Work Items" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "CreateWorkItemRequest": { "description": "Represents the request body content for creating a work item.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "title": "CreateWorkItemRequest", "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 work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "An event tracking a job execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "An event tracking a manual execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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": "An event tracking a notebook execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" }, "WorkItem": { "description": "Contains information about a work item.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "execution_history": { "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": "Execution History" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "title": "WorkItem", "type": "object" } }, "required": [ "created_work_items" ] }
-
field failed_work_items:
Optional[List[CreateWorkItemRequest]] = None List of work item requests that failed during creation.
-
field failed_work_items:
- pydantic model nisystemlink.clients.work_item.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.work_item.models.DashboardUrl[source]
Definition and URL of the dashboard reference associated with this work item.
Show JSON schema
{ "title": "DashboardUrl", "description": "Definition and URL of the dashboard reference associated with this work item.", "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 work item.
- pydantic model nisystemlink.clients.work_item.models.DeleteWorkItemTemplatesPartialSuccessResponse[source]
Response for deleting work item templates with partial success.
Show JSON schema
{ "title": "DeleteWorkItemTemplatesPartialSuccessResponse", "description": "Response for deleting work item templates with partial success.", "type": "object", "properties": { "deleted_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Deleted Ids" }, "failed_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Ids" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field deleted_ids:
Optional[List[str]] = None List of work item template IDs that were successfully deleted.
-
field error:
Optional[ApiError] = None The error that occurred when deleting the work item templates.
-
field failed_ids:
Optional[List[str]] = None List of work item template IDs that failed to delete.
- pydantic model nisystemlink.clients.work_item.models.DeleteWorkItemsPartialSuccessResponse[source]
Response for deleting work items with partial success.
Show JSON schema
{ "title": "DeleteWorkItemsPartialSuccessResponse", "description": "Response for deleting work items with partial success.", "type": "object", "properties": { "deleted_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Deleted Ids" }, "failed_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Ids" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field deleted_ids:
Optional[List[str]] = None List of work item IDs that were successfully deleted.
-
field failed_ids:
Optional[List[str]] = None List of work item IDs that failed to delete.
- pydantic model nisystemlink.clients.work_item.models.ExecuteWorkItemResponse[source]
Response for executing a work item action.
Show JSON schema
{ "title": "ExecuteWorkItemResponse", "description": "Response for executing a work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "result": { "anyOf": [ { "discriminator": { "mapping": { "JOB": "#/$defs/JobExecutionResult", "MANUAL": "#/$defs/ManualExecutionResult", "NONE": "#/$defs/NoneExecutionResult", "NOTEBOOK": "#/$defs/NotebookExecutionResult", "SCHEDULE": "#/$defs/ScheduleExecutionResult", "UNSCHEDULE": "#/$defs/UnscheduleExecutionResult" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/NoneExecutionResult" }, { "$ref": "#/$defs/ManualExecutionResult" }, { "$ref": "#/$defs/NotebookExecutionResult" }, { "$ref": "#/$defs/JobExecutionResult" }, { "$ref": "#/$defs/ScheduleExecutionResult" }, { "$ref": "#/$defs/UnscheduleExecutionResult" } ] }, { "type": "null" } ], "default": null, "title": "Result" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "JobExecutionResult": { "description": "Result of executing a job work item action.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionResult", "type": "object" }, "ManualExecutionResult": { "description": "Result of executing a manual work item action.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionResult", "type": "object" }, "NoneExecutionResult": { "description": "Result of executing a work item action with no execution implementation.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "title": "NoneExecutionResult", "type": "object" }, "NotebookExecutionResult": { "description": "Result of executing a notebook work item action.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionResult", "type": "object" }, "ScheduleExecutionResult": { "description": "Result of executing a schedule work item action.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "SCHEDULE", "default": "SCHEDULE", "title": "Type", "type": "string" } }, "title": "ScheduleExecutionResult", "type": "object" }, "UnscheduleExecutionResult": { "description": "Result of executing an unschedule work item action.", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "UNSCHEDULE", "default": "UNSCHEDULE", "title": "Type", "type": "string" } }, "title": "UnscheduleExecutionResult", "type": "object" } } }
-
field result:
Optional[Annotated[NoneExecutionResult|ManualExecutionResult|NotebookExecutionResult|JobExecutionResult|ScheduleExecutionResult|UnscheduleExecutionResult]] = None Result of the action execution.
-
field result:
- pydantic model nisystemlink.clients.work_item.models.ExecutionEventBase[source]
Base class for execution events containing common attributes.
Show JSON schema
{ "title": "ExecutionEventBase", "description": "Base class for execution events containing common attributes.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" } } }
- Fields
-
field action:
Optional[str] = None The action the execution was triggered for.
-
field new_substate:
Optional[str] = None The substate of the work item resulting from execution.
-
field previous_substate:
Optional[str] = None The substate of the work item at the time of execution.
-
field triggered_at:
Optional[datetime] = None The time the execution was triggered.
-
field triggered_by:
Optional[str] = None The user who triggered the execution.
- pydantic model nisystemlink.clients.work_item.models.ExecutionResultBase[source]
Base class for execution results containing common attributes.
Show JSON schema
{ "title": "ExecutionResultBase", "description": "Base class for execution results containing common attributes.", "type": "object", "properties": { "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
- pydantic model nisystemlink.clients.work_item.models.Job[source]
Defines a job to be executed by a work item job execution.
Show JSON schema
{ "title": "Job", "description": "Defines a job to be executed by a work item job execution.", "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.work_item.models.JobExecution[source]
Defines a job execution for a work item.
Show JSON schema
{ "title": "JobExecution", "description": "Defines a job execution for a work item.", "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": "Defines a job to be executed by a work item job execution.", "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.
-
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.work_item.models.JobExecutionEvent[source]
An event tracking a job execution triggered from a work item.
Show JSON schema
{ "title": "JobExecutionEvent", "description": "An event tracking a job execution triggered from a work item.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" } } }
-
field job_ids:
Optional[List[str]] = None The list of job IDs.
-
field type:
Literal['JOB'] = 'JOB' Type of execution, default is ‘JOB’.
-
field job_ids:
- pydantic model nisystemlink.clients.work_item.models.JobExecutionResult[source]
Result of executing a job work item action.
Show JSON schema
{ "title": "JobExecutionResult", "description": "Result of executing a job work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
-
field job_ids:
Optional[List[str]] = None The list of job IDs.
-
field type:
Literal['JOB'] = 'JOB' Type of execution.
-
field job_ids:
- pydantic model nisystemlink.clients.work_item.models.ManualExecution[source]
Defines a manual execution for a work item.
Show JSON schema
{ "title": "ManualExecution", "description": "Defines a manual execution for a work item.", "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.
-
field type:
Literal['MANUAL'] = 'MANUAL' Type of execution, default is ‘MANUAL’.
-
field action:
- pydantic model nisystemlink.clients.work_item.models.ManualExecutionEvent[source]
An event tracking a manual execution triggered from a work item.
Show JSON schema
{ "title": "ManualExecutionEvent", "description": "An event tracking a manual execution triggered from a work item.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" } } }
- Fields
-
field type:
Literal['MANUAL'] = 'MANUAL' Type of execution, default is ‘MANUAL’.
- pydantic model nisystemlink.clients.work_item.models.ManualExecutionResult[source]
Result of executing a manual work item action.
Show JSON schema
{ "title": "ManualExecutionResult", "description": "Result of executing a manual work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field type:
Literal['MANUAL'] = 'MANUAL' Type of execution.
- pydantic model nisystemlink.clients.work_item.models.NoneExecution[source]
Defines an unimplemented execution for a work item.
Show JSON schema
{ "title": "NoneExecution", "description": "Defines an unimplemented execution for a work item.", "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.
-
field type:
Literal['NONE'] = 'NONE' Type of execution, default is ‘NONE’.
-
field action:
- pydantic model nisystemlink.clients.work_item.models.NoneExecutionResult[source]
Result of executing a work item action with no execution implementation.
Show JSON schema
{ "title": "NoneExecutionResult", "description": "Result of executing a work item action with no execution implementation.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field type:
Literal['NONE'] = 'NONE' Type of execution.
- pydantic model nisystemlink.clients.work_item.models.NotebookExecution[source]
Defines a notebook execution for a work item.
Show JSON schema
{ "title": "NotebookExecution", "description": "Defines a notebook execution for a work item.", "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.
-
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.work_item.models.NotebookExecutionEvent[source]
An event tracking a notebook execution triggered from a work item.
Show JSON schema
{ "title": "NotebookExecutionEvent", "description": "An event tracking a notebook execution triggered from a work item.", "type": "object", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" } } }
- Fields
-
field execution_id:
Optional[str] = None The ID of the triggered execution.
-
field type:
Literal['NOTEBOOK'] = 'NOTEBOOK' Type of execution, default is ‘NOTEBOOK’.
- pydantic model nisystemlink.clients.work_item.models.NotebookExecutionResult[source]
Result of executing a notebook work item action.
Show JSON schema
{ "title": "NotebookExecutionResult", "description": "Result of executing a notebook work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field execution_id:
Optional[str] = None The notebook execution ID.
-
field type:
Literal['NOTEBOOK'] = 'NOTEBOOK' Type of execution.
- pydantic model nisystemlink.clients.work_item.models.PagedWorkItemTemplates[source]
The response containing the list of work item templates, total count and continuation token.
Show JSON schema
{ "title": "PagedWorkItemTemplates", "description": "The response containing the list of work item templates, total count and continuation token.", "type": "object", "properties": { "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "work_item_templates": { "items": { "$ref": "#/$defs/WorkItemTemplate" }, "title": "Work Item Templates", "type": "array" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Total Count" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" }, "WorkItemTemplate": { "description": "Contains response information for work item template.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "title": "WorkItemTemplate", "type": "object" } }, "required": [ "work_item_templates" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of work item templates that match the query.
-
field work_item_templates:
List[WorkItemTemplate] [Required] A list of all the work item templates in this page.
- pydantic model nisystemlink.clients.work_item.models.PagedWorkItems[source]
The response containing the list of work items, total count and continuation token.
Show JSON schema
{ "title": "PagedWorkItems", "description": "The response containing the list of work items, total count and continuation token.", "type": "object", "properties": { "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "work_items": { "items": { "$ref": "#/$defs/WorkItem" }, "title": "Work Items", "type": "array" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Total Count" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "An event tracking a job execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "An event tracking a manual execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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": "An event tracking a notebook execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" }, "WorkItem": { "description": "Contains information about a work item.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "execution_history": { "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": "Execution History" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "title": "WorkItem", "type": "object" } }, "required": [ "work_items" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of work items that match the query.
- pydantic model nisystemlink.clients.work_item.models.QueryWorkItemTemplatesRequest[source]
Represents the request body content for querying work item templates. Allows filtering, sorting, and pagination of work item template results.
Show JSON schema
{ "title": "QueryWorkItemTemplatesRequest", "description": "Represents the request body content for querying work item templates.\nAllows filtering, sorting, and pagination of work item template results.", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "order_by": { "anyOf": [ { "$ref": "#/$defs/WorkItemTemplateOrderBy" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/WorkItemTemplateField" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" } }, "$defs": { "WorkItemTemplateField": { "description": "Enumeration of work item template fields that can be projected in query results.", "enum": [ "ID", "PRODUCT_FAMILIES", "PART_NUMBERS", "NAME", "SUMMARY", "DESCRIPTION", "TEMPLATE_GROUP", "TEST_PROGRAM", "TYPE", "TIMELINE", "TIMELINE_ESTIMATED_DURATION_IN_SECONDS", "RESOURCES", "RESOURCES_SYSTEMS", "RESOURCES_ASSETS", "RESOURCES_DUTS", "RESOURCES_FIXTURES", "RESOURCES_ASSETS_FILTER", "RESOURCES_DUTS_FILTER", "RESOURCES_FIXTURES_FILTER", "RESOURCES_SYSTEMS_FILTER", "WORKSPACE", "CREATED_BY", "UPDATED_BY", "EXECUTION_ACTIONS", "FILE_IDS", "CREATED_AT", "UPDATED_AT", "PROPERTIES", "DASHBOARD", "WORKFLOW_ID" ], "title": "WorkItemTemplateField", "type": "string" }, "WorkItemTemplateOrderBy": { "description": "Enumeration of fields by which work item templates can be ordered.", "enum": [ "ID", "NAME", "TEMPLATE_GROUP", "CREATED_AT", "UPDATED_AT" ], "title": "WorkItemTemplateOrderBy", "type": "string" } } }
-
field continuation_token:
Optional[str] = None A token which allows the user to resume a query at the next item in the matching results.
When querying, a token will be returned if a query may be continued. To obtain the next page of results, pass the token to the service on a subsequent request.
-
field descending:
Optional[bool] = None Whether to return the work item templates in descending order.
-
field filter:
Optional[str] = None A string expression to filter the work item templates returned by the query.
“@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[WorkItemTemplateOrderBy] = None The field name to use for sorting the work item templates.
-
field projection:
Optional[List[WorkItemTemplateField]] = None Gets or sets the projection to be used when retrieving the work item templates. If not specified, all properties will be returned.
-
field substitutions:
Optional[List[UnionType[bool,int,str,None]]] = None Makes substitutions in the query filter expression.
Substitutions for the query expression are indicated by non-negative integers that are prefixed with the @ symbol. Each substitution in the given expression will be replaced by the element at the corresponding index (zero-based) in this list.
-
field take:
Optional[int] = None The maximum number of work item templates to return in the response.
-
field continuation_token:
- pydantic model nisystemlink.clients.work_item.models.QueryWorkItemsRequest[source]
Represents the request body content for querying work items. Allows filtering, sorting, and pagination of work item results.
Show JSON schema
{ "title": "QueryWorkItemsRequest", "description": "Represents the request body content for querying work items.\nAllows filtering, sorting, and pagination of work item results.", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Take" }, "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "order_by": { "anyOf": [ { "$ref": "#/$defs/WorkItemOrderBy" }, { "type": "null" } ], "default": null }, "descending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Descending" }, "return_count": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Return Count" }, "projection": { "anyOf": [ { "items": { "$ref": "#/$defs/WorkItemField" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Projection" } }, "$defs": { "WorkItemField": { "description": "Enumeration of work item fields that can be projected in query results.", "enum": [ "ID", "NAME", "TYPE", "STATE", "SUBSTATE", "DESCRIPTION", "PARENT_ID", "TEMPLATE_ID", "ASSIGNED_TO", "REQUESTED_BY", "TEST_PROGRAM", "PART_NUMBER", "TIMELINE", "TIMELINE_EARLIEST_START_DATE_TIME", "TIMELINE_DUE_DATE_TIME", "TIMELINE_ESTIMATED_DURATION_IN_SECONDS", "SCHEDULE", "SCHEDULE_PLANNED_START_DATE_TIME", "SCHEDULE_PLANNED_END_DATE_TIME", "SCHEDULE_PLANNED_DURATION_IN_SECONDS", "RESOURCES", "RESOURCES_SYSTEMS", "RESOURCES_ASSETS", "RESOURCES_DUTS", "RESOURCES_FIXTURES", "RESOURCES_SYSTEMS_SELECTIONS", "RESOURCES_SYSTEMS_SELECTIONS_ID", "RESOURCES_SYSTEMS_SELECTIONS_TARGET_LOCATION_ID", "RESOURCES_ASSETS_SELECTIONS", "RESOURCES_ASSETS_SELECTIONS_ID", "RESOURCES_ASSETS_SELECTIONS_TARGET_LOCATION_ID", "RESOURCES_ASSETS_SELECTIONS_TARGET_SYSTEM_ID", "RESOURCES_ASSETS_SELECTIONS_TARGET_PARENT_ID", "RESOURCES_DUTS_SELECTIONS", "RESOURCES_DUTS_SELECTIONS_ID", "RESOURCES_DUTS_SELECTIONS_TARGET_LOCATION_ID", "RESOURCES_DUTS_SELECTIONS_TARGET_PARENT_ID", "RESOURCES_DUTS_SELECTIONS_TARGET_SYSTEM_ID", "RESOURCES_FIXTURES_SELECTIONS", "RESOURCES_FIXTURES_SELECTIONS_ID", "RESOURCES_FIXTURES_SELECTIONS_TARGET_LOCATION_ID", "RESOURCES_FIXTURES_SELECTIONS_TARGET_PARENT_ID", "RESOURCES_FIXTURES_SELECTIONS_TARGET_SYSTEM_ID", "RESOURCES_ASSETS_FILTER", "RESOURCES_DUTS_FILTER", "RESOURCES_FIXTURES_FILTER", "RESOURCES_SYSTEMS_FILTER", "FILE_IDS_FROM_TEMPLATE", "PROPERTIES", "DASHBOARD", "CREATED_BY", "CREATED_AT", "UPDATED_BY", "UPDATED_AT", "WORKSPACE", "WORKFLOW_ID" ], "title": "WorkItemField", "type": "string" }, "WorkItemOrderBy": { "description": "Enumeration of fields by which work items can be ordered.", "enum": [ "ID", "UPDATED_AT" ], "title": "WorkItemOrderBy", "type": "string" } } }
-
field continuation_token:
Optional[str] = None A token which allows the user to resume a query at the next item in the matching results.
When querying, a token will be returned if a query may be continued. To obtain the next page of results, pass the token to the service on a subsequent request.
-
field descending:
Optional[bool] = None Whether to sort the work items in descending order.
-
field filter:
Optional[str] = None A string expression to filter the work items returned by the query.
“@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[WorkItemOrderBy] = None The field name to use for sorting the work items.
-
field projection:
Optional[List[WorkItemField]] = None Gets or sets the projection to be used when retrieving the work items. If not specified, all properties will be returned.
-
field return_count:
Optional[bool] = None Whether to include the total count of matching work items in the response.
-
field substitutions:
Optional[List[UnionType[bool,int,str,None]]] = None Makes substitutions in the query filter expression.
Substitutions for the query expression are indicated by non-negative integers that are prefixed with the @ symbol. Each substitution in the given expression will be replaced by the element at the corresponding index (zero-based) in this list.
-
field take:
Optional[int] = None The maximum number of work items to return in the response.
-
field continuation_token:
- pydantic model nisystemlink.clients.work_item.models.ResourceDefinition[source]
Resource reserved for the work item.
Show JSON schema
{ "title": "ResourceDefinition", "description": "Resource reserved for the work item.", "type": "object", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "$defs": { "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" } } }
- Fields
-
field filter:
Optional[str] = None The filter used to select the resources for the work item.
-
field selections:
Optional[List[ResourceSelectionDefinition]] = None Resource selections for the work item.
- pydantic model nisystemlink.clients.work_item.models.ResourceSelectionDefinition[source]
Selection metadata associated with the resource.
Show JSON schema
{ "title": "ResourceSelectionDefinition", "description": "Selection metadata associated with the resource.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } } }
-
field id:
Optional[str] = None The ID of the resource reserved for the work item.
-
field target_location_id:
Optional[str] = None The ID of the location where the resource is to be moved.
-
field target_parent_id:
Optional[str] = None The ID of the parent to which the resource is to be connected.
-
field target_system_id:
Optional[str] = None The ID of the system where the resource is to be moved.
-
field id:
- pydantic model nisystemlink.clients.work_item.models.ResourcesDefinition[source]
Resources reserved for the work item.
Show JSON schema
{ "title": "ResourcesDefinition", "description": "Resources reserved for the work item.", "type": "object", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "$defs": { "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } } }
-
field assets:
Optional[ResourceDefinition] = None Asset reservations for the work item.
-
field duts:
Optional[ResourceDefinition] = None DUT reservations for the work item.
-
field fixtures:
Optional[ResourceDefinition] = None Fixture reservations for the work item.
-
field systems:
Optional[SystemResourceDefinition] = None System reservations for the work item.
-
field assets:
- pydantic model nisystemlink.clients.work_item.models.ScheduleDefinition[source]
Scheduling properties for the work item.
Show JSON schema
{ "title": "ScheduleDefinition", "description": "Scheduling properties for the work item.", "type": "object", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } } }
-
field planned_duration_in_seconds:
Optional[int] = None The planned duration of the work item in seconds.
-
field planned_end_date_time:
Optional[datetime] = None The planned end date and time for the work item.
-
field planned_start_date_time:
Optional[datetime] = None The planned start date and time for the work item.
-
field planned_duration_in_seconds:
- pydantic model nisystemlink.clients.work_item.models.ScheduleExecutionResult[source]
Result of executing a schedule work item action.
Show JSON schema
{ "title": "ScheduleExecutionResult", "description": "Result of executing a schedule work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "SCHEDULE", "default": "SCHEDULE", "title": "Type", "type": "string" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field type:
Literal['SCHEDULE'] = 'SCHEDULE' Type of execution.
- pydantic model nisystemlink.clients.work_item.models.ScheduleResourceDefinition[source]
Resource reserved for scheduling the work item.
Show JSON schema
{ "title": "ScheduleResourceDefinition", "description": "Resource reserved for scheduling the work item.", "type": "object", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "$defs": { "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" } } }
- Fields
-
field selections:
Optional[List[ResourceSelectionDefinition]] = None Resource selections for the work item.
- pydantic model nisystemlink.clients.work_item.models.ScheduleResourcesDefinition[source]
Resources reserved for scheduling the work item.
Show JSON schema
{ "title": "ScheduleResourcesDefinition", "description": "Resources reserved for scheduling the work item.", "type": "object", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/ScheduleSystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "$defs": { "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ScheduleResourceDefinition": { "description": "Resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleResourceDefinition", "type": "object" }, "ScheduleSystemResourceDefinition": { "description": "System resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleSystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } } }
-
field assets:
Optional[ScheduleResourceDefinition] = None Asset reservations for the work item.
-
field duts:
Optional[ScheduleResourceDefinition] = None DUT reservations for the work item.
-
field fixtures:
Optional[ScheduleResourceDefinition] = None Fixture reservations for the work item.
-
field systems:
Optional[ScheduleSystemResourceDefinition] = None System reservations for the work item.
-
field assets:
- pydantic model nisystemlink.clients.work_item.models.ScheduleSystemResourceDefinition[source]
System resource reserved for scheduling the work item.
Show JSON schema
{ "title": "ScheduleSystemResourceDefinition", "description": "System resource reserved for scheduling the work item.", "type": "object", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "$defs": { "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } } }
- Fields
-
field selections:
Optional[List[SystemResourceSelectionDefinition]] = None System resource selections for the work item.
- pydantic model nisystemlink.clients.work_item.models.ScheduleWorkItemRequest[source]
Represents the request body content for scheduling a single work item.
Show JSON schema
{ "title": "ScheduleWorkItemRequest", "description": "Represents the request body content for scheduling a single work item.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourcesDefinition" }, { "type": "null" } ], "default": null } }, "$defs": { "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "ScheduleResourceDefinition": { "description": "Resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleResourceDefinition", "type": "object" }, "ScheduleResourcesDefinition": { "description": "Resources reserved for scheduling the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/ScheduleSystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ScheduleResourcesDefinition", "type": "object" }, "ScheduleSystemResourceDefinition": { "description": "System resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleSystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } }, "required": [ "id" ] }
- Fields
-
field assigned_to:
Optional[str] = None The ID of the user to whom the work item is assigned.
-
field id:
str[Required] The ID of the work item to be scheduled.
-
field resources:
Optional[ScheduleResourcesDefinition] = None Resources reserved for scheduling the work item.
-
field schedule:
Optional[ScheduleDefinition] = None Scheduling properties for the work item.
- pydantic model nisystemlink.clients.work_item.models.ScheduleWorkItemsPartialSuccessResponse[source]
Response for scheduling one or more work items.
Show JSON schema
{ "title": "ScheduleWorkItemsPartialSuccessResponse", "description": "Response for scheduling one or more work items.", "type": "object", "properties": { "scheduled_work_items": { "anyOf": [ { "items": { "$ref": "#/$defs/WorkItem" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Scheduled Work Items" }, "failed_work_items": { "anyOf": [ { "items": { "$ref": "#/$defs/ScheduleWorkItemRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Work Items" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "An event tracking a job execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "An event tracking a manual execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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": "An event tracking a notebook execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "ScheduleResourceDefinition": { "description": "Resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleResourceDefinition", "type": "object" }, "ScheduleResourcesDefinition": { "description": "Resources reserved for scheduling the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/ScheduleSystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ScheduleResourcesDefinition", "type": "object" }, "ScheduleSystemResourceDefinition": { "description": "System resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleSystemResourceDefinition", "type": "object" }, "ScheduleWorkItemRequest": { "description": "Represents the request body content for scheduling a single work item.", "properties": { "id": { "title": "Id", "type": "string" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourcesDefinition" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "ScheduleWorkItemRequest", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" }, "WorkItem": { "description": "Contains information about a work item.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "execution_history": { "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": "Execution History" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "title": "WorkItem", "type": "object" } } }
-
field failed_work_items:
Optional[List[ScheduleWorkItemRequest]] = None List of work item requests that failed to schedule.
-
field failed_work_items:
- pydantic model nisystemlink.clients.work_item.models.ScheduleWorkItemsRequest[source]
Represents the request body content for scheduling multiple work items.
Show JSON schema
{ "title": "ScheduleWorkItemsRequest", "description": "Represents the request body content for scheduling multiple work items.", "type": "object", "properties": { "work_items": { "items": { "$ref": "#/$defs/ScheduleWorkItemRequest" }, "title": "Work Items", "type": "array" }, "replace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Replace" } }, "$defs": { "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "ScheduleResourceDefinition": { "description": "Resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleResourceDefinition", "type": "object" }, "ScheduleResourcesDefinition": { "description": "Resources reserved for scheduling the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/ScheduleSystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ScheduleResourcesDefinition", "type": "object" }, "ScheduleSystemResourceDefinition": { "description": "System resource reserved for scheduling the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" } }, "title": "ScheduleSystemResourceDefinition", "type": "object" }, "ScheduleWorkItemRequest": { "description": "Represents the request body content for scheduling a single work item.", "properties": { "id": { "title": "Id", "type": "string" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ScheduleResourcesDefinition" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "ScheduleWorkItemRequest", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } }, "required": [ "work_items" ] }
- Fields
-
field replace:
Optional[bool] = None When true, existing array fields are replaced instead of merged.
-
field work_items:
List[ScheduleWorkItemRequest] [Required] List of work items to be scheduled.
- pydantic model nisystemlink.clients.work_item.models.SystemResourceDefinition[source]
System resource reserved for the work item.
Show JSON schema
{ "title": "SystemResourceDefinition", "description": "System resource reserved for the work item.", "type": "object", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "$defs": { "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" } } }
- Fields
-
field filter:
Optional[str] = None The filter used to select the systems for the work item.
-
field selections:
Optional[List[SystemResourceSelectionDefinition]] = None System resource selections for the work item.
- pydantic model nisystemlink.clients.work_item.models.SystemResourceSelectionDefinition[source]
Selection metadata associated with the system resource.
Show JSON schema
{ "title": "SystemResourceSelectionDefinition", "description": "Selection metadata associated with the system resource.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } } }
- Fields
-
field id:
Optional[str] = None The ID of the system reserved for the work item.
-
field target_location_id:
Optional[str] = None The ID of the location where the system is to be moved.
- pydantic model nisystemlink.clients.work_item.models.TemplateResourceDefinition[source]
Resource reserved for the work item created from a template.
Show JSON schema
{ "title": "TemplateResourceDefinition", "description": "Resource reserved for the work item created from a template.", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } } }
- Fields
-
field filter:
Optional[str] = None The filter used to select the resources for the work item.
- pydantic model nisystemlink.clients.work_item.models.TemplateResourcesDefinition[source]
Resources reserved for the work item created from a template.
Show JSON schema
{ "title": "TemplateResourcesDefinition", "description": "Resources reserved for the work item created from a template.", "type": "object", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "$defs": { "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" } } }
-
field assets:
Optional[TemplateResourceDefinition] = None Asset reservations for the work item.
-
field duts:
Optional[TemplateResourceDefinition] = None DUT reservations for the work item.
-
field fixtures:
Optional[TemplateResourceDefinition] = None Fixture reservations for the work item.
-
field systems:
Optional[TemplateResourceDefinition] = None System reservations for the work item.
-
field assets:
- pydantic model nisystemlink.clients.work_item.models.TemplateTimelineDefinition[source]
Timeline properties for the work item created from a template.
Show JSON schema
{ "title": "TemplateTimelineDefinition", "description": "Timeline properties for the work item created from a template.", "type": "object", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } } }
-
field estimated_duration_in_seconds:
Optional[int] = None The estimated duration of the work item in seconds.
-
field estimated_duration_in_seconds:
- pydantic model nisystemlink.clients.work_item.models.TimelineDefinition[source]
Timeline properties for the work item.
Show JSON schema
{ "title": "TimelineDefinition", "description": "Timeline properties for the work item.", "type": "object", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } } }
-
field due_date_time:
Optional[datetime] = None The due date and time for the work item.
-
field earliest_start_date_time:
Optional[datetime] = None The earliest start date and time for the work item.
-
field estimated_duration_in_seconds:
Optional[int] = None The estimated duration of the work item in seconds.
-
field due_date_time:
- pydantic model nisystemlink.clients.work_item.models.UnscheduleExecutionResult[source]
Result of executing an unschedule work item action.
Show JSON schema
{ "title": "UnscheduleExecutionResult", "description": "Result of executing an unschedule work item action.", "type": "object", "properties": { "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "UNSCHEDULE", "default": "UNSCHEDULE", "title": "Type", "type": "string" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" } } }
- Fields
-
field type:
Literal['UNSCHEDULE'] = 'UNSCHEDULE' Type of execution.
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemRequest[source]
Represents the request body content for updating a single work item.
Show JSON schema
{ "title": "UpdateWorkItemRequest", "description": "Represents the request body content for updating a single work item.", "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" } }, "required": [ "id" ] }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the work item.
-
field description:
Optional[str] = None The new description for the work item.
-
field execution_actions:
Optional[List[Annotated[NotebookExecution|ManualExecution|JobExecution|NoneExecution]]] = None The execution actions defined for the work item.
-
field file_ids_from_template:
Optional[List[str]] = None The array of file IDs associated with the work item template.
-
field id:
str[Required] The ID of the work item to update.
-
field name:
Optional[str] = None The new name for the work item.
-
field parent_id:
Optional[str] = None The ID of the parent work item.
-
field part_number:
Optional[str] = None The part number associated with the work item.
-
field properties:
Optional[Dict[str,str]] = None Additional properties for the work item.
-
field requested_by:
Optional[str] = None The user or group who requested the work item.
-
field resources:
Optional[ResourcesDefinition] = None Resources reserved for the work item.
-
field state:
Optional[str] = None The new state of the work item.
-
field test_program:
Optional[str] = None The test program associated with the work item.
-
field timeline:
Optional[TimelineDefinition] = None Timeline properties for the work item.
-
field workspace:
Optional[str] = None The workspace to which the work item belongs.
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemTemplateRequest[source]
Represents the request body content for updating a single work item template.
Show JSON schema
{ "title": "UpdateWorkItemTemplateRequest", "description": "Represents the request body content for updating a single work item template.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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/DashboardUrl" }, { "type": "null" } ], "default": null }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "$defs": { "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" } }, "required": [ "id" ] }
- Fields
-
field dashboard:
Optional[DashboardUrl] = None The dashboard data related to the work item created from this template.
-
field description:
Optional[str] = None The description of the work item created from this template.
-
field execution_actions:
Optional[List[Annotated[NotebookExecution|ManualExecution|JobExecution|NoneExecution]]] = None The execution actions defined for the work item.
-
field file_ids:
Optional[List[str]] = None The array of file IDs associated with the work item template.
-
field id:
str[Required] The ID of the work item template.
-
field name:
Optional[str] = None The name of the work item template.
-
field part_numbers:
Optional[List[str]] = None The array of part numbers of the products linked to the work item template.
-
field product_families:
Optional[List[str]] = None The array of product families to which the work item template belongs.
-
field properties:
Optional[Dict[str,str]] = None Additional properties associated with the work item created from this template.
-
field resources:
Optional[TemplateResourcesDefinition] = None Resources selection criteria for the work item created from this template.
-
field summary:
Optional[str] = None The summary of the work item template.
-
field template_group:
Optional[str] = None The template group defined by the user.
-
field test_program:
Optional[str] = None The test program associated with the work item created from this template.
-
field timeline:
Optional[TemplateTimelineDefinition] = None Timeline properties for the work item created from this template.
-
field workflow_id:
Optional[str] = None The ID of the workflow associated with the work item created from this template.
-
field workspace:
Optional[str] = None The workspace to which the work item template belongs.
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemTemplatesPartialSuccessResponse[source]
Response for updating work item templates with partial success.
Show JSON schema
{ "title": "UpdateWorkItemTemplatesPartialSuccessResponse", "description": "Response for updating work item templates with partial success.", "type": "object", "properties": { "updated_work_item_templates": { "items": { "$ref": "#/$defs/WorkItemTemplate" }, "title": "Updated Work Item Templates", "type": "array" }, "failed_work_item_templates": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateWorkItemTemplateRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Work Item Templates" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "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 work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" }, "UpdateWorkItemTemplateRequest": { "description": "Represents the request body content for updating a single work item template.", "properties": { "id": { "title": "Id", "type": "string" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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/DashboardUrl" }, { "type": "null" } ], "default": null }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "required": [ "id" ], "title": "UpdateWorkItemTemplateRequest", "type": "object" }, "WorkItemTemplate": { "description": "Contains response information for work item template.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "title": "WorkItemTemplate", "type": "object" } }, "required": [ "updated_work_item_templates" ] }
-
field error:
Optional[ApiError] = None The error that occurred when updating the work item templates.
-
field failed_work_item_templates:
Optional[List[UpdateWorkItemTemplateRequest]] = None List of work item template requests that failed to update.
-
field updated_work_item_templates:
List[WorkItemTemplate] [Required] List of successfully updated work item templates.
-
field error:
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemTemplatesRequest[source]
Represents the request body content for updating multiple work item templates.
Show JSON schema
{ "title": "UpdateWorkItemTemplatesRequest", "description": "Represents the request body content for updating multiple work item templates.", "type": "object", "properties": { "work_item_templates": { "items": { "$ref": "#/$defs/UpdateWorkItemTemplateRequest" }, "title": "Work Item Templates", "type": "array" }, "replace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Replace" } }, "$defs": { "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" }, "UpdateWorkItemTemplateRequest": { "description": "Represents the request body content for updating a single work item template.", "properties": { "id": { "title": "Id", "type": "string" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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/DashboardUrl" }, { "type": "null" } ], "default": null }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "required": [ "id" ], "title": "UpdateWorkItemTemplateRequest", "type": "object" } }, "required": [ "work_item_templates" ] }
- Fields
-
field replace:
Optional[bool] = None When true, existing key-value pair fields are replaced instead of merged.
-
field work_item_templates:
List[UpdateWorkItemTemplateRequest] [Required] List of work item templates to update.
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemsPartialSuccessResponse[source]
Response for updating work items with partial success.
Show JSON schema
{ "title": "UpdateWorkItemsPartialSuccessResponse", "description": "Response for updating work items with partial success.", "type": "object", "properties": { "updated_work_items": { "anyOf": [ { "items": { "$ref": "#/$defs/WorkItem" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Updated Work Items" }, "failed_work_items": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateWorkItemRequest" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Failed Work Items" }, "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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "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 work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "An event tracking a job execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "An event tracking a manual execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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": "An event tracking a notebook execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" }, "UpdateWorkItemRequest": { "description": "Represents the request body content for updating a single work item.", "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "UpdateWorkItemRequest", "type": "object" }, "WorkItem": { "description": "Contains information about a work item.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "execution_history": { "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": "Execution History" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "title": "WorkItem", "type": "object" } } }
-
field failed_work_items:
Optional[List[UpdateWorkItemRequest]] = None List of work item requests that failed to update.
-
field failed_work_items:
- pydantic model nisystemlink.clients.work_item.models.UpdateWorkItemsRequest[source]
Represents the request body content for updating multiple work items.
Show JSON schema
{ "title": "UpdateWorkItemsRequest", "description": "Represents the request body content for updating multiple work items.", "type": "object", "properties": { "work_items": { "items": { "$ref": "#/$defs/UpdateWorkItemRequest" }, "title": "Work Items", "type": "array" }, "replace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Replace" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" }, "UpdateWorkItemRequest": { "description": "Represents the request body content for updating a single work item.", "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/Dashboard" }, { "type": "null" } ], "default": null } }, "required": [ "id" ], "title": "UpdateWorkItemRequest", "type": "object" } }, "required": [ "work_items" ] }
- Fields
-
field replace:
Optional[bool] = None When true, existing array and key-value pair fields are replaced instead of merged.
-
field work_items:
List[UpdateWorkItemRequest] [Required] List of work items to update.
- pydantic model nisystemlink.clients.work_item.models.WorkItem[source]
Contains information about a work item.
Show JSON schema
{ "title": "WorkItem", "description": "Contains information about a work item.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "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" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Id" }, "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assigned To" }, "requested_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Requested By" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "part_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Part Number" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TimelineDefinition" }, { "type": "null" } ], "default": null }, "schedule": { "anyOf": [ { "$ref": "#/$defs/ScheduleDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/ResourcesDefinition" }, { "type": "null" } ], "default": null }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "file_ids_from_template": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids From Template" }, "dashboard": { "anyOf": [ { "$ref": "#/$defs/DashboardUrl" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "execution_history": { "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": "Execution History" }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "$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" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "DashboardUrl": { "description": "Definition and URL of the dashboard reference associated with this work item.", "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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "An event tracking a job execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "JOB", "default": "JOB", "title": "Type", "type": "string" }, "job_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Job Ids" } }, "title": "JobExecutionEvent", "type": "object" }, "ManualExecution": { "description": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "ManualExecutionEvent": { "description": "An event tracking a manual execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "title": "ManualExecutionEvent", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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": "An event tracking a notebook execution triggered from a work item.", "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Action" }, "triggered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered At" }, "triggered_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Triggered By" }, "previous_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "previous_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Substate" }, "new_state": { "anyOf": [ { "$ref": "#/$defs/State" }, { "type": "null" } ], "default": null }, "new_substate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New Substate" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "type": { "const": "NOTEBOOK", "default": "NOTEBOOK", "title": "Type", "type": "string" }, "execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Execution Id" } }, "title": "NotebookExecutionEvent", "type": "object" }, "ResourceDefinition": { "description": "Resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/ResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "ResourceDefinition", "type": "object" }, "ResourceSelectionDefinition": { "description": "Selection metadata associated with the resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" }, "target_system_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target System Id" }, "target_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Parent Id" } }, "title": "ResourceSelectionDefinition", "type": "object" }, "ResourcesDefinition": { "description": "Resources reserved for the work item.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/ResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/SystemResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "ResourcesDefinition", "type": "object" }, "ScheduleDefinition": { "description": "Scheduling properties for the work item.", "properties": { "planned_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned Start Date Time" }, "planned_end_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Planned End Date Time" }, "planned_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Planned Duration In Seconds" } }, "title": "ScheduleDefinition", "type": "object" }, "State": { "description": "The state of the work item.", "enum": [ "NEW", "DEFINED", "REVIEWED", "SCHEDULED", "IN_PROGRESS", "PENDING_APPROVAL", "CLOSED", "CANCELED" ], "title": "State", "type": "string" }, "SystemResourceDefinition": { "description": "System resource reserved for the work item.", "properties": { "selections": { "anyOf": [ { "items": { "$ref": "#/$defs/SystemResourceSelectionDefinition" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Selections" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "SystemResourceDefinition", "type": "object" }, "SystemResourceSelectionDefinition": { "description": "Selection metadata associated with the system resource.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "target_location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Target Location Id" } }, "title": "SystemResourceSelectionDefinition", "type": "object" }, "TimelineDefinition": { "description": "Timeline properties for the work item.", "properties": { "earliest_start_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Earliest Start Date Time" }, "due_date_time": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Due Date Time" }, "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TimelineDefinition", "type": "object" } } }
- Fields
-
field assigned_to:
Optional[str] = None The user or group assigned to the work item.
-
field created_at:
Optional[datetime] = None The date and time when the work item was created.
-
field created_by:
Optional[str] = None The user who created the work item.
-
field dashboard:
Optional[DashboardUrl] = None The dashboard data related to the work item.
-
field description:
Optional[str] = None The description of the work item.
-
field execution_actions:
Optional[List[Annotated[NotebookExecution|ManualExecution|JobExecution|NoneExecution]]] = None The execution actions defined for the work item.
-
field execution_history:
Optional[List[Annotated[NotebookExecutionEvent|ManualExecutionEvent|JobExecutionEvent]]] = None The execution history of the work item.
-
field file_ids_from_template:
Optional[List[str]] = None The list of file IDs inherited from the template.
-
field id:
Optional[str] = None The ID of the work item.
-
field name:
Optional[str] = None The name of the work item.
-
field parent_id:
Optional[str] = None The ID of the parent work item.
-
field part_number:
Optional[str] = None The part number associated with the work item.
-
field properties:
Optional[Dict[str,str]] = None Additional properties associated with the work item.
-
field requested_by:
Optional[str] = None The user or group who requested the work item.
-
field resources:
Optional[ResourcesDefinition] = None Resources reserved for the work item.
-
field schedule:
Optional[ScheduleDefinition] = None Scheduling properties for the work item.
-
field substate:
Optional[str] = None The substate of the work item, if any.
-
field template_id:
Optional[str] = None The ID of the template used to create the work item.
-
field test_program:
Optional[str] = None The test program associated with the work item.
-
field timeline:
Optional[TimelineDefinition] = None Timeline properties for the work item.
-
field type:
Optional[str] = None The type of the work item.
-
field updated_at:
Optional[datetime] = None The date and time when the work item was last updated.
-
field updated_by:
Optional[str] = None The user who last updated the work item.
-
field workflow_id:
Optional[str] = None The ID of the workflow associated with the work item.
-
field workspace:
Optional[str] = None The workspace to which the work item belongs.
- class nisystemlink.clients.work_item.models.WorkItemField(value)[source]
Enumeration of work item fields that can be projected in query results.
- class nisystemlink.clients.work_item.models.WorkItemOrderBy(value)[source]
Enumeration of fields by which work items can be ordered.
- pydantic model nisystemlink.clients.work_item.models.WorkItemTemplate[source]
Contains response information for work item template.
Show JSON schema
{ "title": "WorkItemTemplate", "description": "Contains response information for work item template.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" } } }
- Fields
-
field created_at:
Optional[datetime] = None The date and time when the work item template was created.
-
field created_by:
Optional[str] = None The user who created the work item template.
-
field id:
Optional[str] = None The ID of the work item template.
-
field name:
Optional[str] = None The name of the work item template.
-
field updated_at:
Optional[datetime] = None The date and time when the work item template was last updated.
-
field updated_by:
Optional[str] = None The user who last updated the work item template.
- pydantic model nisystemlink.clients.work_item.models.WorkItemTemplateBase[source]
Contains information about a work item template.
Show JSON schema
{ "title": "WorkItemTemplateBase", "description": "Contains information about a work item template.", "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "template_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Template Group" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Product Families" }, "part_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Part Numbers" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "test_program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Test Program" }, "timeline": { "anyOf": [ { "$ref": "#/$defs/TemplateTimelineDefinition" }, { "type": "null" } ], "default": null }, "resources": { "anyOf": [ { "$ref": "#/$defs/TemplateResourcesDefinition" }, { "type": "null" } ], "default": null }, "execution_actions": { "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": "Execution Actions" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "File Ids" }, "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 }, "workflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workflow Id" } }, "$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": "Defines a job to be executed by a work item job execution.", "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 a job execution for a work item.", "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": "Defines a manual execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "MANUAL", "default": "MANUAL", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "ManualExecution", "type": "object" }, "NoneExecution": { "description": "Defines an unimplemented execution for a work item.", "properties": { "action": { "title": "Action", "type": "string" }, "type": { "const": "NONE", "default": "NONE", "title": "Type", "type": "string" } }, "required": [ "action" ], "title": "NoneExecution", "type": "object" }, "NotebookExecution": { "description": "Defines a notebook execution for a work item.", "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" }, "TemplateResourceDefinition": { "description": "Resource reserved for the work item created from a template.", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" } }, "title": "TemplateResourceDefinition", "type": "object" }, "TemplateResourcesDefinition": { "description": "Resources reserved for the work item created from a template.", "properties": { "assets": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "duts": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "fixtures": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null }, "systems": { "anyOf": [ { "$ref": "#/$defs/TemplateResourceDefinition" }, { "type": "null" } ], "default": null } }, "title": "TemplateResourcesDefinition", "type": "object" }, "TemplateTimelineDefinition": { "description": "Timeline properties for the work item created from a template.", "properties": { "estimated_duration_in_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Estimated Duration In Seconds" } }, "title": "TemplateTimelineDefinition", "type": "object" } } }
- Fields
-
field dashboard:
Optional[Dashboard] = None The dashboard data related to the work item created from this template.
-
field description:
Optional[str] = None The description of the work item created from this template.
-
field execution_actions:
Optional[List[Annotated[NotebookExecution|ManualExecution|JobExecution|NoneExecution]]] = None The execution actions defined for the work item.
-
field file_ids:
Optional[List[str]] = None The array of file IDs associated with the work item template.
-
field name:
Optional[str] = None The name of the work item template.
-
field part_numbers:
Optional[List[str]] = None The array of part numbers of the products linked to the work item template.
-
field product_families:
Optional[List[str]] = None The array of product families to which the work item template belongs.
-
field properties:
Optional[Dict[str,str]] = None Additional properties associated with the work item created from this template.
-
field resources:
Optional[TemplateResourcesDefinition] = None Resources selection criteria for the work item created from this template.
-
field summary:
Optional[str] = None The summary of the work item template.
-
field template_group:
Optional[str] = None The template group defined by the user.
-
field test_program:
Optional[str] = None The test program associated with the work item created from this template.
-
field timeline:
Optional[TemplateTimelineDefinition] = None Timeline properties for the work item created from this template.
-
field type:
Optional[str] = None The type of work item created from this template.
-
field workflow_id:
Optional[str] = None The ID of the workflow associated with the work item created from this template.
-
field workspace:
Optional[str] = None The workspace to which the work item template belongs.