nisystemlink.clients.testmonitor
- class nisystemlink.clients.testmonitor.TestMonitorClient(configuration)[source]
- __init__(configuration)[source]
Initialize an instance.
- Parameters
configuration (
Optional
[nisystemlink.clients.core.HttpConfiguration
]) – Defines the web server to connect to and information about how to connect.base_path – The base path for all API calls.
- pydantic model nisystemlink.clients.testmonitor.models.ApiInfo[source]
Information about the available API operations.
Show JSON schema
{ "title": "ApiInfo", "description": "Information about the available API operations.", "type": "object", "properties": { "operations": { "$ref": "#/definitions/V2Operations" } }, "required": [ "operations" ], "definitions": { "Operation": { "title": "Operation", "description": "Represents an operation that can be performed on a data frame.", "type": "object", "properties": { "available": { "title": "Available", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "available", "version" ] }, "V2Operations": { "title": "V2Operations", "description": "The operations available in the routes provided by the v2 HTTP API.", "type": "object", "properties": { "getProducts": { "$ref": "#/definitions/Operation" }, "queryProducts": { "$ref": "#/definitions/Operation" }, "createProducts": { "$ref": "#/definitions/Operation" }, "updateProducts": { "$ref": "#/definitions/Operation" }, "deleteProducts": { "$ref": "#/definitions/Operation" }, "deleteManyProducts": { "$ref": "#/definitions/Operation" }, "getResults": { "$ref": "#/definitions/Operation" }, "getResultsPropertyKeys": { "$ref": "#/definitions/Operation" }, "queryResults": { "$ref": "#/definitions/Operation" }, "createResults": { "$ref": "#/definitions/Operation" }, "updateResults": { "$ref": "#/definitions/Operation" }, "deleteResult": { "$ref": "#/definitions/Operation" }, "deleteManyResults": { "$ref": "#/definitions/Operation" }, "getSteps": { "$ref": "#/definitions/Operation" }, "querySteps": { "$ref": "#/definitions/Operation" }, "createSteps": { "$ref": "#/definitions/Operation" }, "updateSteps": { "$ref": "#/definitions/Operation" }, "deleteStep": { "$ref": "#/definitions/Operation" }, "deleteManySteps": { "$ref": "#/definitions/Operation" }, "queryPaths": { "$ref": "#/definitions/Operation" } }, "required": [ "getProducts", "queryProducts", "createProducts", "updateProducts", "deleteProducts", "deleteManyProducts", "getResults", "getResultsPropertyKeys", "queryResults", "createResults", "updateResults", "deleteResult", "deleteManyResults", "getSteps", "querySteps", "createSteps", "updateSteps", "deleteStep", "deleteManySteps", "queryPaths" ] } } }
- Fields
-
field operations:
V2Operations
[Required]
- pydantic model nisystemlink.clients.testmonitor.models.Operation[source]
Represents an operation that can be performed on a data frame.
Show JSON schema
{ "title": "Operation", "description": "Represents an operation that can be performed on a data frame.", "type": "object", "properties": { "available": { "title": "Available", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "available", "version" ] }
-
field available:
bool
[Required] Whether or not the operation is available to the caller (e.g. due to permissions).
-
field version:
int
[Required] The version of the available operation.
-
field available:
- pydantic model nisystemlink.clients.testmonitor.models.V2Operations[source]
The operations available in the routes provided by the v2 HTTP API.
Show JSON schema
{ "title": "V2Operations", "description": "The operations available in the routes provided by the v2 HTTP API.", "type": "object", "properties": { "getProducts": { "$ref": "#/definitions/Operation" }, "queryProducts": { "$ref": "#/definitions/Operation" }, "createProducts": { "$ref": "#/definitions/Operation" }, "updateProducts": { "$ref": "#/definitions/Operation" }, "deleteProducts": { "$ref": "#/definitions/Operation" }, "deleteManyProducts": { "$ref": "#/definitions/Operation" }, "getResults": { "$ref": "#/definitions/Operation" }, "getResultsPropertyKeys": { "$ref": "#/definitions/Operation" }, "queryResults": { "$ref": "#/definitions/Operation" }, "createResults": { "$ref": "#/definitions/Operation" }, "updateResults": { "$ref": "#/definitions/Operation" }, "deleteResult": { "$ref": "#/definitions/Operation" }, "deleteManyResults": { "$ref": "#/definitions/Operation" }, "getSteps": { "$ref": "#/definitions/Operation" }, "querySteps": { "$ref": "#/definitions/Operation" }, "createSteps": { "$ref": "#/definitions/Operation" }, "updateSteps": { "$ref": "#/definitions/Operation" }, "deleteStep": { "$ref": "#/definitions/Operation" }, "deleteManySteps": { "$ref": "#/definitions/Operation" }, "queryPaths": { "$ref": "#/definitions/Operation" } }, "required": [ "getProducts", "queryProducts", "createProducts", "updateProducts", "deleteProducts", "deleteManyProducts", "getResults", "getResultsPropertyKeys", "queryResults", "createResults", "updateResults", "deleteResult", "deleteManyResults", "getSteps", "querySteps", "createSteps", "updateSteps", "deleteStep", "deleteManySteps", "queryPaths" ], "definitions": { "Operation": { "title": "Operation", "description": "Represents an operation that can be performed on a data frame.", "type": "object", "properties": { "available": { "title": "Available", "type": "boolean" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "available", "version" ] } } }
- Fields
-
field query_products:
Operation
[Required] The ability to query products based on their properties.
-
field query_results:
Operation
[Required] “The ability to to query results based on their properties.