UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.9__py3-none-any.whl

type_spec/external/api/inputs/get_input_data.yaml

@@ -9,39 +9,26 @@ Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The material family ID to get the input values from."
         input_ids:
-            type: Optional<List<Integer>>
+            type: Optional<List<ObjectId>>
             desc: "The input IDs to get the data from. If this is not filled in, all inputs from a material family will be returned (in paginated form)."
-        offset:
+        offset?:
             type: Optional<Integer>
             desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID"
         is_parameter:
             type: Optional<Boolean>
             desc: "Whether to get parameters or ingredients. By default both are returned. When set to true, only parameters are returned, and when set to false, only ingredients are returned"
-        limit:
+        limit?:
             type: Optional<Integer>
             desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
 
-InputAttrVal:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "The unique integer ID for the input attribute value. Used for joining and identification elsewhere."
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the attribute, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the attribute, if it is not of numeric type"
-
 SimpleInputAttr:
     type: Object
     properties:
         attribute_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the input attribute value. Used for joining and identification elsewhere."
         name:
             type: String
@@ -54,7 +41,7 @@ SimpleInputGlobalCategory:
     type: Object
     properties:
         category_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the global category. Used for joining and identification elsewhere."
         name:
             type: String
@@ -64,7 +51,7 @@ SimpleInputSubcategory:
     type: Object
     properties:
         subcategory_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the subcategory. Used for joining and identification elsewhere."
         name:
             type: String
@@ -74,7 +61,7 @@ FullInput:
     type: Object
     properties:
         input_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the input value. Used for joining and identification elsewhere"
         name:
             type: String
@@ -86,13 +73,13 @@ FullInput:
             type: Boolean
             desc: "Whether the input is a process parameter (true) or an ingredient (false)"
         attributes:
-            type: List<InputAttrVal>
+            type: List<input_attributes.InputAttributeValue>
             desc: "Attributes associated with an input, such as CAS number, density, etc."
         global_category_id:
-            type: Integer
+            type: Optional<ObjectId>
             desc: "The global category ID associated with the input"
         subcategory_ids:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "The subcategory IDs associated with an input. Inputs can be placed into an unlimited number of subcategories"
 
 Data:

type_spec/external/api/inputs/get_input_names.yaml

@@ -9,15 +9,15 @@ Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The material family ID to get the input values from"
-        offset:
+        offset?:
             type: Optional<Integer>
             desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the input ID"
         is_parameter:
             type: Optional<Boolean>
             desc: "Whether to get parameters or ingredients. By default both are returned. When set to true, only parameters are returned, and when set to false, only ingredients are returned"
-        limit:
+        limit?:
             type: Optional<Integer>
             desc: "The maximum number of results to return. By default this is set to 20,000 and it cannot be set higher than 20,000"
 
@@ -25,7 +25,7 @@ InputWithName:
     type: Object
     properties:
         input_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the input value. Used for joining and identification elsewhere"
         name:
             type: String

type_spec/external/api/inputs/get_inputs_data.yaml

@@ -9,14 +9,14 @@ Arguments:
     type: Object
     properties:
         input_ids:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "Ids of the inputs to retrieve"
 
 AttributeDetails:
     type: Object
     properties:
         attribute_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the attribute."
         name:
             type: String
@@ -25,24 +25,11 @@ AttributeDetails:
             type: String
             desc: "The value type of the attribute"
 
-InputAttributeValue:
-    type: Object
-    properties:
-        attribute_id:
-            type: Integer
-            desc: "A unique identifier for the attribute."
-        quantity_dec:
-            type: Decimal
-            desc: "The value for the metadata, if it is of numeric type"
-        quantity_json:
-            type: JsonValue
-            desc: "The value for the metadata, if it is not of numeric type"
-
 InputTag:
     type: Object
     properties:
         tag_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the tag."
         tag_name:
             type: String
@@ -52,10 +39,10 @@ InputCategory:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the material family id where the category assignment is made."
         category_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifer for the category"
         category_name:
             type: String
@@ -65,7 +52,7 @@ InputDetails:
     type: Object
     properties:
         input_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the input."
         name:
             type: String
@@ -77,7 +64,7 @@ InputDetails:
             type: String
             desc: "The type of the input.  E.g. input, process parameter, equipment"
         attributes:
-            type: List<InputAttributeValue>
+            type: List<input_attributes.InputAttributeValue>
             desc: "The attributes of the input"
         categories:
             type: List<InputCategory>

type_spec/external/api/inputs/set_input_attribute_values.yaml

@@ -16,10 +16,10 @@ InputAttributeValue:
     type: Object
     properties:
         input_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the input to set the attribute value on"
         attribute_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the attribute."
         quantity_dec?:
             type: Decimal
@@ -29,9 +29,5 @@ InputAttributeValue:
             desc: "The value for the attribute, if it is not of numeric type"
 
 Data:
-    type: Object
+    type: response.Response
     properties:
-        status:
-            type: Literal<'ok'>
-            default: "ok"
-            desc: "'ok' indicates the post request was successful"

type_spec/external/api/outputs/get_output_data.yaml

@@ -9,10 +9,10 @@ Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The material family ID to get the output values from."
         output_ids?:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "The output IDs to get the data from. If this is not filled in, all outputs from a material family will be returned (in paginated form)."
         offset?:
             type: Integer
@@ -25,7 +25,7 @@ OutputAttrVal:
     type: Object
     properties:
         attribute_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
         quantity_dec:
             type: Decimal
@@ -38,7 +38,7 @@ SimpleOutputAttr:
     type: Object
     properties:
         attribute_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the output attribute value. Used for joining and identification elsewhere."
         name:
             type: String
@@ -51,28 +51,17 @@ SimpleOutputGlobalCategory:
     type: Object
     properties:
         category_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID for the global category. Used for joining and identification elsewhere."
         name:
             type: String
             desc: "The name of the output global category"
 
-SimpleUnit:
-    type: Object
-    desc: "A representation of units within Uncountable system"
-    properties:
-        unit_id:
-            type: Integer
-            desc: "A unique ID for the unit, referenceable elsewhere"
-        name:
-            type: String
-            desc: "The name of the unit"
-
 FullOutput:
     type: Object
     properties:
         output_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
         name:
             type: String
@@ -84,10 +73,10 @@ FullOutput:
             type: List<OutputAttrVal>
             desc: "Attributes associated with an output, such as a test documentation"
         global_category_id:
-            type: Integer
+            type: Optional<ObjectId>
             desc: "The global category ID associated with the output"
         unit_id:
-            type: Integer
+            type: Optional<ObjectId>
             desc: "The unit for the output, which all data is stored in. This may be different than the users default displayed information for the output"
 
 Data:
@@ -100,4 +89,4 @@ Data:
         global_categories:
             type: List<SimpleOutputGlobalCategory>
         units:
-            type: List<SimpleUnit>
+            type: List<units.SimpleUnit>

type_spec/external/api/outputs/get_output_names.yaml

@@ -9,7 +9,7 @@ Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The material family ID to get the output values from"
         offset?:
             type: Integer
@@ -22,7 +22,7 @@ OutputWithName:
     type: Object
     properties:
         output_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the output value. Used for joining and identification elsewhere"
         name:
             type: String

type_spec/external/api/project/get_projects.yaml

@@ -11,42 +11,32 @@ Arguments:
             type: Boolean
             desc: "Whether to get projects from all material families. Material families are high level groupings of data, usually separated by functional area"
         material_family_id:
-            type: Optional<Integer>
+            type: Optional<ObjectId>
             desc: "The specific material family ID to get projects from. Only fill this in if all_material_families is set to false"
 
 Project:
     type: Object
     properties:
         id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
         name:
             type: String
             desc: "The name of the project"
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
         project_owner_id:
-            type: Optional<Integer>
+            type: Optional<ObjectId>
             desc: "The projects owner, as a user ID within the platform"
         phase_id:
-            type: Optional<Integer>
+            type: Optional<ObjectId>
             desc: "The phase id corresponding to a phase workflow"
 
-Phase:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the phase. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the phase"
-
 Data:
     type: Object
     properties:
         projects:
             type: List<Project>
         phases:
-            type: List<Phase>
+            type: List<phases.Phase>

type_spec/external/api/project/get_projects_data.yaml

@@ -8,79 +8,43 @@ Arguments:
     type: Object
     properties:
         project_ids:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "The projects to get the data from"
-        offset:
+        offset?:
             type: Optional<Integer>
             desc: "Used for pagination. All pagination is done in order of Project ID"
-        limit:
+        limit?:
             type: Optional<Integer>
             desc: "The number of data points to return. If not filled in, it will be set to 100, and cannot be set higher than 100"
 
-Field:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the field"
-        name:
-            type: String
-            desc: "The name of the field"
-        value_type:
-            type: String
-            desc: "The type of the field for instance whether it is numeric, text, categorical"
-
-FieldValue:
-    type: Object
-    properties:
-        field_id:
-            type: Integer
-            desc: "The unique ID for the field"
-        row_index:
-            type: Optional<Integer>
-            desc: "For table fields, which row of the table is the value on"
-        value:
-            type: JsonValue
-            desc: "The value for the field"
-
 ProjectDetailed:
     type: Object
     properties:
         id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the project. Used as foreign key to reference elsewhere."
         name:
             type: String
             desc: "The name of the project"
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "A unique identifier for the material family. Used as foreign key to reference elsewhere."
         project_owner_id:
-            type: Optional<Integer>
+            type: Optional<ObjectId>
             desc: "The projects owner, as a user ID within the platform"
         phase_id:
-            type: Optional<Integer>
+            type: Optional<ObjectId>
             desc: "The phase id corresponding to a phase workflow"
         values:
-            type: List<FieldValue>
+            type: List<field_values.ArgumentValueId>
             desc: "List of fields and values associated with the project"
 
-Phase:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the phase. Used as foreign key to reference elsewhere."
-        name:
-            type: String
-            desc: "The name of the phase"
-
 Data:
     type: Object
     properties:
         projects:
             type: List<ProjectDetailed>
         phases:
-            type: List<Phase>
+            type: List<phases.Phase>
         fields:
-            type: List<Field>
+            type: List<fields.Field>

type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml

@@ -9,15 +9,15 @@ Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The material family ID to get the recipe metadata values from."
         recipe_metadata_ids:
-            type: Optional<List<Integer>>
+            type: Optional<List<ObjectId>>
             desc: "The recipe metadata IDs to get the data from. If this is not filled in, all metadata from a material family will be returned (in paginated form)."
-        offset:
+        offset?:
             type: Optional<Integer>
             desc: "Used for pagination, where the number of results returned exceeds the limit. Results are always ordered by the metadata ID"
-        limit:
+        limit?:
             type: Optional<Integer>
             desc: "The maximum number of results to return. By default this is set to 1,000 and it cannot be set higher than 1,000"
 
@@ -25,7 +25,7 @@ FullRecipeMetadataField:
     type: Object
     properties:
         recipe_metadata_id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the recipe metadata value. Used for joining and identification elsewhere"
         name:
             type: String

type_spec/external/api/recipes/create_recipes.yaml

@@ -5,19 +5,6 @@ $endpoint:
     function: main.site.app.external.recipes.create_recipes.create_recipes
     desc: "Sets inputs values for an experiment. Values set can be numeric, text or categorical types in the Uncountable system"
 
-MetadataValue:
-    type: Object
-    properties:
-        metadata_id:
-            type: Integer
-            desc: The id of the metadata field to populate
-        value_numeric?:
-            type: Decimal
-            desc: "The numeric value for the metadata. Should be none if output is not of type numeric."
-        value_str?:
-            type: String
-            desc: "The string value for the metadata if applicable for this metadata field"
-
 CreateRecipeDefinition:
     type: Object
     properties:
@@ -25,23 +12,23 @@ CreateRecipeDefinition:
             type: String
             desc: "The name for the recipe"
         workflow_id:
-            type: Integer
+            type: ObjectId
             desc: "The identifier of the workflow to create the recipe with"
         workflow_variant_id?:
             type: Optional<ObjectId>
             desc: "The identifier of the workflow variant to create the recipe with"
         recipe_metadata?:
-            type: List<MetadataValue>
+            type: List<recipe_metadata.MetadataValue>
             desc: "Metadata values to populate the recipe with"
 
 Arguments:
     type: Object
     properties:
         material_family_id:
-            type: Integer
+            type: ObjectId
             desc: "The identifier of the material family to create the recipes in"
         project_id?:
-            type: Integer
+            type: ObjectId
             desc: "The identifier of the project to create the recipes in"
         recipe_definitions:
             type: List<CreateRecipeDefinition>
@@ -50,7 +37,7 @@ CreateRecipeResult:
     type: Object
     properties:
         recipe_id:
-            type: Integer
+            type: ObjectId
             desc: The identifier for the created recipe
 
 Data:

type_spec/external/api/recipes/get_curve.yaml

@@ -8,43 +8,11 @@ Arguments:
     type: Object
     properties:
         recipe_output_id:
-            type: Integer
+            type: ObjectId
             desc: "The recipe output ID to fetch the curve for. This must be a curve recipe output. Recipe Outputs can be found from external_get_recipes_data"
 
-CurveValue:
-    type: Object
-    properties:
-        index:
-            type: Integer
-            desc: "The index of the value in the curve"
-        quantity?:
-            type: Decimal
-            desc: "The value for the curve if the curve is a numeric curve"
-        quantity_timestamp?:
-            type: DateTime
-            desc: "The timestamp value if the curve is a timestamp curve in UTC"
-
-Curve:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "The unique integer ID of the curve. Used for joining and identification elsewhere"
-        x_type:
-            type: String
-            desc: "The type of axis for the x-axis.  Options include numeric and timestamp"
-        x_values:
-            type: List<CurveValue>
-            desc: "The values for the x-axis"
-        y_type:
-            type: String
-            desc: "The type of axis for the y-axis.  Options include numeric"
-        y_values:
-            type: List<CurveValue>
-            desc: "The values for the y-axis"
-
 Data:
     type: Object
     properties:
         curve:
-            type: Curve
+            type: curves.Curve

type_spec/external/api/recipes/get_recipe_calculations.yaml

@@ -8,42 +8,32 @@ Arguments:
     type: Object
     properties:
         recipe_ids:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "Ids of the Recipes to retrieve calculations for"
         calculation_ids?:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "Optionally a list of ids of calculations to retrieve"
 
 RecipeCalculation:
     type: Object
     properties:
         recipe_id:
-            type: Integer
+            type: ObjectId
             desc: "Identifier for the recipe"
         calculation_id:
-            type: Integer
+            type: ObjectId
             desc: "Identifier for the calculation"
-        quantity_dec:
+        quantity_dec?:
             type: Decimal
             desc: "The value for the calculation, if it is of numeric type"
-        quantity_json:
+        quantity_json?:
             type: JsonValue
             desc: "The value for the calculation, if it is not of numeric type"
 
-Calculation:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "Identifier for the calculation"
-        name:
-            type: String
-            desc: "Name of the calculation"
-
 Data:
     type: Object
     properties:
         recipe_calculations:
             type: List<RecipeCalculation>
         calculations:
-            type: List<Calculation>
+            type: List<calculations.Calculation>

type_spec/external/api/recipes/get_recipe_links.yaml

@@ -9,7 +9,7 @@ Arguments:
     type: Object
     properties:
         recipe_ids:
-            type: List<Integer>
+            type: List<ObjectId>
             desc: "Ids of the Recipes to retrieve links for"
         depth:
             type: Integer

type_spec/external/api/recipes/get_recipe_names.yaml

@@ -9,14 +9,14 @@ Arguments:
     type: Object
     properties:
         project_id:
-            type: Integer
+            type: ObjectId
             desc: "Required: The project ID to get the recipes/experiments from."
 
 SimpleRecipe:
     type: Object
     properties:
         id:
-            type: Integer
+            type: ObjectId
             desc: "The unique integer ID of the recipe/experiment. Used for joining and identification elsewhere"
         name:
             type: String