nisystemlink.clients.spec

class nisystemlink.clients.spec.SpecClient(configuration=None)

__init__(configuration=None)

Initialize an instance.

Parameters

configuration (Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, the HttpConfigurationManager is used to obtain the configuration.

Raises

ApiException – if unable to communicate with the Spec Service.

api_info()

Get information about available API operations.

Return type

nisystemlink.clients.spec.models.V1Operations

Returns

Information about available API operations.

Raises

ApiException – if unable to communicate with the DataFrame Service.

create_specs(specs)

Creates one or more specifications.

Parameters

specs (nisystemlink.clients.spec.models.CreateSpecificationsRequest) – A list of specifications to create.

Return type

nisystemlink.clients.spec.models.CreateSpecificationsPartialSuccess

Returns

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

Raises

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

• invalid arguments. –

delete_specs(ids)

Deletes one or more specifications by global id.

Parameters

• ids (List[str]) – a list of specification ids. Note that these are the global ids and not the

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

Return type

Optional[nisystemlink.clients.spec.models.DeleteSpecificationsPartialSuccess]

Returns

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

Raises

• ApiException – if unable to communicate with the nispec service or if there are invalid

• arguments. –

query_specs(query)

Queries for specs that match the filters.

Parameters

query (nisystemlink.clients.spec.models.QuerySpecificationsRequest) – The query contains a product id as well as a filter for specs under that product.

Return type

nisystemlink.clients.spec.models.QuerySpecifications

Returns

A list of specifications that match the filter.

update_specs(specs)

Updates one or more specifications.

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

Parameters

• specs (nisystemlink.clients.spec.models.UpdateSpecificationsRequest) – a list of specifications that are to be updated. Must include the global id and

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

Return type

Optional[nisystemlink.clients.spec.models.UpdateSpecificationsPartialSuccess]

Returns

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

pydantic model nisystemlink.clients.spec.models.Condition

A single condition.

Show JSON schema

{
   "title": "Condition",
   "description": "A single condition.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "value": {
         "title": "Value",
         "anyOf": [
            {
               "$ref": "#/definitions/NumericConditionValue"
            },
            {
               "$ref": "#/definitions/StringConditionValue"
            }
         ]
      }
   },
   "definitions": {
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      }
   }
}

Fields

• name

• value

field name: Optional[str] = None

Name of the condition.

field value: Union[NumericConditionValue, StringConditionValue, None] = None

Value of the condition.

pydantic model nisystemlink.clients.spec.models.ConditionRange

Specifies the range of values that the condition must cover.

Show JSON schema

{
   "title": "ConditionRange",
   "description": "Specifies the range of values that the condition must cover.",
   "type": "object",
   "properties": {
      "min": {
         "title": "Min",
         "type": "number"
      },
      "max": {
         "title": "Max",
         "type": "number"
      },
      "step": {
         "title": "Step",
         "type": "number"
      }
   }
}

Fields

• max

• min

• step

field max: Optional[float] = None

Maximum value of the condition range.

field min: Optional[float] = None

Minimum value of the condition range.

field step: Optional[float] = None

Step value of the condition range.

class nisystemlink.clients.spec.models.ConditionType(value)

Conditions are either numeric or string type.

NUMERIC = 'NUMERIC'

Numeric condition.

STRING = 'STRING'

String condition.

pydantic model nisystemlink.clients.spec.models.CreateSpecificationsPartialSuccess

When some specs can not be created, this contains the list that was and was not created.

Show JSON schema

{
   "title": "CreateSpecificationsPartialSuccess",
   "description": "When some specs can not be created, this contains the list that was and was not created.",
   "type": "object",
   "properties": {
      "createdSpecs": {
         "title": "Createdspecs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CreatedSpecification"
         }
      },
      "failedSpecs": {
         "title": "Failedspecs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/SpecificationDefinition"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "definitions": {
      "CreatedSpecification": {
         "title": "CreatedSpecification",
         "description": "A specification successfully created on the server.",
         "type": "object",
         "properties": {
            "createdAt": {
               "title": "Createdat",
               "type": "string",
               "format": "date-time"
            },
            "createdBy": {
               "title": "Createdby",
               "type": "string"
            },
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "productId",
            "specId",
            "id",
            "version"
         ]
      },
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      },
      "SpecificationDefinition": {
         "title": "SpecificationDefinition",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/SpecificationType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "block": {
               "title": "Block",
               "type": "string"
            },
            "limit": {
               "$ref": "#/definitions/SpecificationLimit"
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            },
            "conditions": {
               "title": "Conditions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Condition"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         },
         "required": [
            "productId",
            "specId",
            "type"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• created_specs

• error

• failed_specs

field created_specs: Optional[List[CreatedSpecification]] = None

Information about the created specification(s)

field error: Optional[ApiError] = None

field failed_specs: Optional[List[SpecificationDefinition]] = None

List of specification requests that failed during creation.

pydantic model nisystemlink.clients.spec.models.CreateSpecificationsRequest

Create multiple specifications.

Show JSON schema

{
   "title": "CreateSpecificationsRequest",
   "description": "Create multiple specifications.",
   "type": "object",
   "properties": {
      "specs": {
         "title": "Specs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/SpecificationDefinition"
         }
      }
   },
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      },
      "SpecificationDefinition": {
         "title": "SpecificationDefinition",
         "description": "Base class for models that are serialized to and from JSON.",
         "type": "object",
         "properties": {
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/SpecificationType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "block": {
               "title": "Block",
               "type": "string"
            },
            "limit": {
               "$ref": "#/definitions/SpecificationLimit"
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            },
            "conditions": {
               "title": "Conditions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Condition"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         },
         "required": [
            "productId",
            "specId",
            "type"
         ]
      }
   }
}

Fields

• specs

field specs: Optional[List[SpecificationDefinition]] = None

List of specifications to be created.

pydantic model nisystemlink.clients.spec.models.CreatedSpecification

A specification successfully created on the server.

Show JSON schema

{
   "title": "CreatedSpecification",
   "description": "A specification successfully created on the server.",
   "type": "object",
   "properties": {
      "createdAt": {
         "title": "Createdat",
         "type": "string",
         "format": "date-time"
      },
      "createdBy": {
         "title": "Createdby",
         "type": "string"
      },
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      }
   },
   "required": [
      "productId",
      "specId",
      "id",
      "version"
   ]
}

Fields

• id

• version

field id: str [Required]

The global Id of the specification.

field version: int [Required]

Current version of the specification.

When an update is applied, the version is automatically incremented.

pydantic model nisystemlink.clients.spec.models.DeleteSpecificationsPartialSuccess

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

Show JSON schema

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

Fields

• deleted_spec_ids

• error

• failed_spec_ids

field deleted_spec_ids: List[str] [Required]

Global IDs of the deleted specifications.

field error: ApiError [Required]

field failed_spec_ids: List[str] [Required]

Global IDs of the specifications that could not be deleted.

pydantic model nisystemlink.clients.spec.models.NumericConditionValue

A numeric condition.

Numeric conditions can contain a combination of ranges and discrete lists.

Show JSON schema

{
   "title": "NumericConditionValue",
   "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
   "type": "object",
   "properties": {
      "conditionType": {
         "$ref": "#/definitions/ConditionType"
      },
      "range": {
         "title": "Range",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ConditionRange"
         }
      },
      "discrete": {
         "title": "Discrete",
         "type": "array",
         "items": {
            "type": "number"
         }
      },
      "unit": {
         "title": "Unit",
         "type": "string"
      }
   },
   "required": [
      "conditionType"
   ],
   "definitions": {
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      }
   }
}

Fields

• discrete

• range

• unit

field discrete: Optional[List[float]] = None

List of condition discrete values.

field range: Optional[List[ConditionRange]] = None

List of condition range values.

field unit: Optional[str] = None

Unit of the condition.

pydantic model nisystemlink.clients.spec.models.Operation

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

Show JSON schema

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

Fields

• available

• version

field available: bool [Required]

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

field version: int [Required]

The version of the available operation.

pydantic model nisystemlink.clients.spec.models.QuerySpecifications

The list of matching specifications and a continuation token to get the next items.

Show JSON schema

{
   "title": "QuerySpecifications",
   "description": "The list of matching specifications and a continuation token to get the next items.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "specs": {
         "title": "Specs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/SpecificationWithHistory"
         }
      }
   },
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      },
      "SpecificationWithHistory": {
         "title": "SpecificationWithHistory",
         "description": "A full specification with update and create history.",
         "type": "object",
         "properties": {
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedBy": {
               "title": "Updatedby",
               "type": "string"
            },
            "createdAt": {
               "title": "Createdat",
               "type": "string",
               "format": "date-time"
            },
            "createdBy": {
               "title": "Createdby",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            },
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/SpecificationType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "block": {
               "title": "Block",
               "type": "string"
            },
            "limit": {
               "$ref": "#/definitions/SpecificationLimit"
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            },
            "conditions": {
               "title": "Conditions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Condition"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         },
         "required": [
            "id",
            "version",
            "productId",
            "specId",
            "type"
         ]
      }
   }
}

Fields

• specs

field specs: Optional[List[SpecificationWithHistory]] = None

List of queried specifications.

An empty list indicates that there are no specifications meeting the criteria provided in the request.

pydantic model nisystemlink.clients.spec.models.QuerySpecificationsRequest

The request to query specifications.

Show JSON schema

{
   "title": "QuerySpecificationsRequest",
   "description": "The request to query specifications.",
   "type": "object",
   "properties": {
      "productIds": {
         "title": "Productids",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "take": {
         "title": "Take",
         "type": "integer"
      },
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "projection": {
         "type": "array",
         "items": {
            "$ref": "#/definitions/Projection"
         }
      },
      "orderBy": {
         "$ref": "#/definitions/OrderBy"
      },
      "orderByDescending": {
         "title": "Orderbydescending",
         "type": "boolean"
      }
   },
   "required": [
      "productIds"
   ],
   "definitions": {
      "Projection": {
         "title": "Projection",
         "description": "The allowed projections for query.\n\nWhen using projection, only the fields specified by the projection element will be included in\nthe response.",
         "enum": [
            "ID",
            "PRODUCT_ID",
            "SPEC_ID",
            "NAME",
            "CATEGORY",
            "TYPE",
            "SYMBOL",
            "BLOCK",
            "LIMIT",
            "UNIT",
            "CONDITION_NAME",
            "CONDITION_VALUES",
            "CONDITION_UNIT",
            "CONDITION_TYPE",
            "KEYWORDS",
            "PROPERTIES",
            "WORKSPACE",
            "CREATED_AT",
            "CREATED_BY"
         ],
         "type": "string"
      },
      "OrderBy": {
         "title": "OrderBy",
         "description": "The valid ways to order the response to a spec query.",
         "enum": [
            "ID",
            "SPEC_ID"
         ]
      }
   }
}

Fields

• continuation_token

• filter

• order_by

• order_by_descending

• product_ids

• projection

• take

field continuation_token: Optional[str] = None

Allows users to continue the query at the next specification that matches the given criteria.

To retrieve the next batch of specifications, pass the continuation token from the previous batch in the next request. The service responds with the next batch of data and provides a new continuation token. To paginate results, continue sending requests with the newest continuation token provided in each response.

field filter: Optional[str] = None

The specification query filter in Dynamic Linq format.

Allowed properties in the filter are: - specId: String representing the SpecID of a specification. - name: String representing the name of a specification. - category: String representing the category of a specification. - type: String enumeration representing the type of the specification.

Possible values are : PARAMETRIC, FUNCTIONAL

• block: String representing the block of a specification.

• symbol: String representing the symbol of a specification.

• unit: String representing the unit of a specification.

• workspace: String representing the ID of the workspace the specification belongs to.

• createdBy: String representing the ID of the user who created the specification.

• createdAt: ISO-8601 formatted UTC timestamp indicating when the specification was created.

• updatedBy: String representing the ID of the user who updated the specification.

• updatedAt: ISO-8601 formatted UTC timestamp indicating when the specification was updated.

See [Dynamic Linq](https://github.com/ni/systemlink-OpenAPI-documents/wiki/Dynamic-Linq-Query-Language) documentation for more details.

field order_by: Optional[OrderBy] = None

Specifies the field to use to sort specifications.

By default, specifications are sorted by ID.

field order_by_descending: Optional[bool] = None

Specifies whether to return the specifications in descending order.

By default, this value is false and specifications are sorted in ascending order.

field product_ids: List[str] [Required]

IDs of the products to query the specifications for.

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

Specifies the fields to include in the returned specifications.

Fields you do not specify are excluded. Returns all fields if no value is specified.

field take: Optional[int] = None

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

Uses the default if the specified value is negative. The default value is 1000 specs.

pydantic model nisystemlink.clients.spec.models.Specification

The complete definition of a specification.

Show JSON schema

{
   "title": "Specification",
   "description": "The complete definition of a specification.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      },
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "category": {
         "title": "Category",
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/SpecificationType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "block": {
         "title": "Block",
         "type": "string"
      },
      "limit": {
         "$ref": "#/definitions/SpecificationLimit"
      },
      "unit": {
         "title": "Unit",
         "type": "string"
      },
      "conditions": {
         "title": "Conditions",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Condition"
         }
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      }
   },
   "required": [
      "id",
      "version",
      "productId",
      "specId",
      "type"
   ],
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      }
   }
}

Fields

• block

• category

• conditions

• keywords

• limit

• name

• properties

• symbol

• type

• unit

field block: Optional[str] = None

Block name of the specification.

Typically a block is one of the subsystems of the overall product being specified.

field category: Optional[str] = None

Category of the specification.

field conditions: Optional[List[Condition]] = None

Conditions associated with the specification.

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

Keywords or phrases associated with the specification.

field limit: Optional[SpecificationLimit] = None

The limits for this spec.

field name: Optional[str] = None

Name of the specification.

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

Additional properties associated with the specification.

field symbol: Optional[str] = None

Short form identifier of the specification.

field type: SpecificationType [Required]

Type of the specification.

field unit: Optional[str] = None

Unit of the specification.

pydantic model nisystemlink.clients.spec.models.SpecificationCreation

When the spec was created and when.

Show JSON schema

{
   "title": "SpecificationCreation",
   "description": "When the spec was created and when.",
   "type": "object",
   "properties": {
      "createdAt": {
         "title": "Createdat",
         "type": "string",
         "format": "date-time"
      },
      "createdBy": {
         "title": "Createdby",
         "type": "string"
      }
   }
}

Fields

• created_at

• created_by

field created_at: Optional[datetime] = None

ISO-8601 formatted timestamp indicating when the specification was created.

field created_by: Optional[str] = None

Id of the user who created the specification.

pydantic model nisystemlink.clients.spec.models.SpecificationDefinition

Show JSON schema

{
   "title": "SpecificationDefinition",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "category": {
         "title": "Category",
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/SpecificationType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "block": {
         "title": "Block",
         "type": "string"
      },
      "limit": {
         "$ref": "#/definitions/SpecificationLimit"
      },
      "unit": {
         "title": "Unit",
         "type": "string"
      },
      "conditions": {
         "title": "Conditions",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Condition"
         }
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      }
   },
   "required": [
      "productId",
      "specId",
      "type"
   ],
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      }
   }
}

Fields

• block

• category

• conditions

• keywords

• limit

• name

• properties

• symbol

• type

• unit

field block: Optional[str] = None

Block name of the specification.

Typically a block is one of the subsystems of the overall product being specified.

field category: Optional[str] = None

Category of the specification.

field conditions: Optional[List[Condition]] = None

Conditions associated with the specification.

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

Keywords or phrases associated with the specification.

field limit: Optional[SpecificationLimit] = None

The limits for this spec.

field name: Optional[str] = None

Name of the specification.

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

Additional properties associated with the specification.

field symbol: Optional[str] = None

Short form identifier of the specification.

field type: SpecificationType [Required]

Type of the specification.

field unit: Optional[str] = None

Unit of the specification.

pydantic model nisystemlink.clients.spec.models.SpecificationLimit

A limit for a specification.

The limit is the value that a measurement should be compared against during analysis to determine the health or pass/fail status of that measurement.

Show JSON schema

{
   "title": "SpecificationLimit",
   "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
   "type": "object",
   "properties": {
      "min": {
         "title": "Min",
         "type": "number"
      },
      "typical": {
         "title": "Typical",
         "type": "number"
      },
      "max": {
         "title": "Max",
         "type": "number"
      }
   }
}

Fields

• max

• min

• typical

field max: Optional[float] = None

Maximum value of the specification.

All measurements that map to this specification should be < this limit.

field min: Optional[float] = None

Minimum limit of the specification.

All measurements that map to this specification should be > this limit.

field typical: Optional[float] = None

Typical value of the specification.

pydantic model nisystemlink.clients.spec.models.SpecificationServerManaged

Show JSON schema

{
   "title": "SpecificationServerManaged",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      }
   },
   "required": [
      "id",
      "version"
   ]
}

Fields

• id

• version

field id: str [Required]

The global Id of the specification.

field version: int [Required]

Current version of the specification.

When an update is applied, the version is automatically incremented.

class nisystemlink.clients.spec.models.SpecificationType(value)

The overall type of the specification.

FUNCTIONAL = 'FUNCTIONAL'

Functional specs only have pass/fail status.

PARAMETRIC = 'PARAMETRIC'

Parametric specs have limits.

pydantic model nisystemlink.clients.spec.models.SpecificationUpdated

When the spec was updated and when.

Show JSON schema

{
   "title": "SpecificationUpdated",
   "description": "When the spec was updated and when.",
   "type": "object",
   "properties": {
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "updatedBy": {
         "title": "Updatedby",
         "type": "string"
      }
   }
}

Fields

• updated_at

• updated_by

field updated_at: Optional[datetime] = None

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

field updated_by: Optional[str] = None

Id of the user who last updated the specification.

pydantic model nisystemlink.clients.spec.models.SpecificationUserManaged

Show JSON schema

{
   "title": "SpecificationUserManaged",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "required": [
      "productId",
      "specId"
   ]
}

Fields

• product_id

• spec_id

• workspace

field product_id: str [Required]

Id of the product to which the specification will be associated.

field spec_id: str [Required]

User provided value using which the specification will be identified.

This should be unique for a product and workspace combination.

field workspace: Optional[str] = None

Id of the workspace to which the specification will be associated.

Default workspace will be taken if the value is not given.

pydantic model nisystemlink.clients.spec.models.SpecificationWithHistory

A full specification with update and create history.

Show JSON schema

{
   "title": "SpecificationWithHistory",
   "description": "A full specification with update and create history.",
   "type": "object",
   "properties": {
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "updatedBy": {
         "title": "Updatedby",
         "type": "string"
      },
      "createdAt": {
         "title": "Createdat",
         "type": "string",
         "format": "date-time"
      },
      "createdBy": {
         "title": "Createdby",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      },
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "category": {
         "title": "Category",
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/SpecificationType"
      },
      "symbol": {
         "title": "Symbol",
         "type": "string"
      },
      "block": {
         "title": "Block",
         "type": "string"
      },
      "limit": {
         "$ref": "#/definitions/SpecificationLimit"
      },
      "unit": {
         "title": "Unit",
         "type": "string"
      },
      "conditions": {
         "title": "Conditions",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Condition"
         }
      },
      "keywords": {
         "title": "Keywords",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      }
   },
   "required": [
      "id",
      "version",
      "productId",
      "specId",
      "type"
   ],
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      }
   }
}

Fields

• block

• category

• conditions

• id

• keywords

• limit

• name

• product_id

• properties

• spec_id

• symbol

• type

• unit

• version

• workspace

field block: Optional[str] = None

Block name of the specification.

Typically a block is one of the subsystems of the overall product being specified.

field category: Optional[str] = None

Category of the specification.

field conditions: Optional[List[Condition]] = None

Conditions associated with the specification.

field id: str [Required]

The global Id of the specification.

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

Keywords or phrases associated with the specification.

field limit: Optional[SpecificationLimit] = None

The limits for this spec.

field name: Optional[str] = None

Name of the specification.

field product_id: str [Required]

Id of the product to which the specification will be associated.

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

Additional properties associated with the specification.

field spec_id: str [Required]

User provided value using which the specification will be identified.

This should be unique for a product and workspace combination.

field symbol: Optional[str] = None

Short form identifier of the specification.

field type: SpecificationType [Required]

Type of the specification.

field unit: Optional[str] = None

Unit of the specification.

field version: int [Required]

Current version of the specification.

When an update is applied, the version is automatically incremented.

field workspace: Optional[str] = None

Id of the workspace to which the specification will be associated.

Default workspace will be taken if the value is not given.

pydantic model nisystemlink.clients.spec.models.StringConditionValue

A string condition.

String conditions may only contain discrete lists of values.

Show JSON schema

{
   "title": "StringConditionValue",
   "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
   "type": "object",
   "properties": {
      "conditionType": {
         "$ref": "#/definitions/ConditionType"
      },
      "discrete": {
         "title": "Discrete",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "conditionType"
   ],
   "definitions": {
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      }
   }
}

Fields

• discrete

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

List of condition discrete values.

pydantic model nisystemlink.clients.spec.models.UpdateSpecificationsPartialSuccess

Show JSON schema

{
   "title": "UpdateSpecificationsPartialSuccess",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "updatedSpecs": {
         "title": "Updatedspecs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/UpdatedSpecification"
         }
      },
      "failedSpecs": {
         "title": "Failedspecs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Specification"
         }
      },
      "error": {
         "$ref": "#/definitions/ApiError"
      }
   },
   "definitions": {
      "UpdatedSpecification": {
         "title": "UpdatedSpecification",
         "description": "A specification that was updated on the server.",
         "type": "object",
         "properties": {
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "updatedBy": {
               "title": "Updatedby",
               "type": "string"
            },
            "id": {
               "title": "Id",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            },
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            }
         },
         "required": [
            "id",
            "version",
            "productId",
            "specId"
         ]
      },
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      },
      "Specification": {
         "title": "Specification",
         "description": "The complete definition of a specification.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            },
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/SpecificationType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "block": {
               "title": "Block",
               "type": "string"
            },
            "limit": {
               "$ref": "#/definitions/SpecificationLimit"
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            },
            "conditions": {
               "title": "Conditions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Condition"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         },
         "required": [
            "id",
            "version",
            "productId",
            "specId",
            "type"
         ]
      },
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      }
   }
}

Fields

• error

• failed_specs

• updated_specs

field error: Optional[ApiError] = None

Any errors that occurred.

field failed_specs: Optional[List[Specification]] = None

Information about each of the specification request(s) that failed during the update.

field updated_specs: Optional[List[UpdatedSpecification]] = None

Information about each of the updated specification(s).

pydantic model nisystemlink.clients.spec.models.UpdateSpecificationsRequest

Show JSON schema

{
   "title": "UpdateSpecificationsRequest",
   "description": "Base class for models that are serialized to and from JSON.",
   "type": "object",
   "properties": {
      "specs": {
         "title": "Specs",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Specification"
         }
      }
   },
   "definitions": {
      "SpecificationType": {
         "title": "SpecificationType",
         "description": "The overall type of the specification.",
         "enum": [
            "PARAMETRIC",
            "FUNCTIONAL"
         ]
      },
      "SpecificationLimit": {
         "title": "SpecificationLimit",
         "description": "A limit for a specification.\n\nThe limit is the value that a measurement should be compared against during analysis to\ndetermine the health or pass/fail status of that measurement.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "typical": {
               "title": "Typical",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            }
         }
      },
      "ConditionType": {
         "title": "ConditionType",
         "description": "Conditions are either numeric or string type.",
         "enum": [
            "NUMERIC",
            "STRING"
         ]
      },
      "ConditionRange": {
         "title": "ConditionRange",
         "description": "Specifies the range of values that the condition must cover.",
         "type": "object",
         "properties": {
            "min": {
               "title": "Min",
               "type": "number"
            },
            "max": {
               "title": "Max",
               "type": "number"
            },
            "step": {
               "title": "Step",
               "type": "number"
            }
         }
      },
      "NumericConditionValue": {
         "title": "NumericConditionValue",
         "description": "A numeric condition.\n\nNumeric conditions can contain a combination of ranges and discrete lists.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "range": {
               "title": "Range",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ConditionRange"
               }
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "StringConditionValue": {
         "title": "StringConditionValue",
         "description": "A string condition.\n\nString conditions may only contain discrete lists of values.",
         "type": "object",
         "properties": {
            "conditionType": {
               "$ref": "#/definitions/ConditionType"
            },
            "discrete": {
               "title": "Discrete",
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "conditionType"
         ]
      },
      "Condition": {
         "title": "Condition",
         "description": "A single condition.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "title": "Value",
               "anyOf": [
                  {
                     "$ref": "#/definitions/NumericConditionValue"
                  },
                  {
                     "$ref": "#/definitions/StringConditionValue"
                  }
               ]
            }
         }
      },
      "Specification": {
         "title": "Specification",
         "description": "The complete definition of a specification.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            },
            "productId": {
               "title": "Productid",
               "type": "string"
            },
            "specId": {
               "title": "Specid",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "category": {
               "title": "Category",
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/SpecificationType"
            },
            "symbol": {
               "title": "Symbol",
               "type": "string"
            },
            "block": {
               "title": "Block",
               "type": "string"
            },
            "limit": {
               "$ref": "#/definitions/SpecificationLimit"
            },
            "unit": {
               "title": "Unit",
               "type": "string"
            },
            "conditions": {
               "title": "Conditions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Condition"
               }
            },
            "keywords": {
               "title": "Keywords",
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            }
         },
         "required": [
            "id",
            "version",
            "productId",
            "specId",
            "type"
         ]
      }
   }
}

Fields

• specs

field specs: Optional[List[Specification]] = None

List of specifications to be updated.

pydantic model nisystemlink.clients.spec.models.UpdatedSpecification

A specification that was updated on the server.

Show JSON schema

{
   "title": "UpdatedSpecification",
   "description": "A specification that was updated on the server.",
   "type": "object",
   "properties": {
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "updatedBy": {
         "title": "Updatedby",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      },
      "productId": {
         "title": "Productid",
         "type": "string"
      },
      "specId": {
         "title": "Specid",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "required": [
      "id",
      "version",
      "productId",
      "specId"
   ]
}

Fields

• product_id

• spec_id

• workspace

field product_id: str [Required]

Id of the product to which the specification will be associated.

field spec_id: str [Required]

User provided value using which the specification will be identified.

This should be unique for a product and workspace combination.

field workspace: Optional[str] = None

Id of the workspace to which the specification will be associated.

Default workspace will be taken if the value is not given.

pydantic model nisystemlink.clients.spec.models.V1Operations

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

Show JSON schema

{
   "title": "V1Operations",
   "description": "The operations available in the routes provided by the v1 HTTP API.",
   "type": "object",
   "properties": {
      "createSpecifications": {
         "$ref": "#/definitions/Operation"
      },
      "querySpecifications": {
         "$ref": "#/definitions/Operation"
      },
      "updateSpecifications": {
         "$ref": "#/definitions/Operation"
      },
      "deleteSpecifications": {
         "$ref": "#/definitions/Operation"
      }
   },
   "required": [
      "createSpecifications",
      "querySpecifications",
      "updateSpecifications",
      "deleteSpecifications"
   ],
   "definitions": {
      "Operation": {
         "title": "Operation",
         "description": "Represents an operation that can be performed on a data frame.",
         "type": "object",
         "properties": {
            "available": {
               "title": "Available",
               "type": "boolean"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "available",
            "version"
         ]
      }
   }
}

Fields

• create_specifications

• delete_specifications

• query_specifications

• update_specifications

field create_specifications: Operation [Required]

The ability to create new specifications.

field delete_specifications: Operation [Required]

The ability to delete specifications.

field query_specifications: Operation [Required]

The ability to query specifications.

field update_specifications: Operation [Required]

The ability to update specifications.