Parts and Part Revisioning
Last updated
Last updated
Part objects in ION represent abstractions that carry information about a particular part, while the physical parts themselves are part inventory objects. The part objects dictate the MBOM, revision, supplier part number, tracking type and other additional attributes about a part.
Below is a list of part attributes and their description. For a more complete list of part fields use the graphiql editor to view the part object.
The queries below specify how to list parts by a filter or get a specific part.
Creates a part object with a particular part number. Part number and revision must be unique, if no revision is supplied in the create mutation then the part defaults to revision A. Once created the revision of a part cannot be updated, instead the createPartRevision mutation must be used to iterate a part's revision. Returns the new part.
Mutation to create part object
Updates a part object. Tracking type can only be updated to either "serial" or "lot" if all existing inventory objects related to this part conform to the new tracking type. Returns the updated part object.
Mutation to update part object
Creates a new revision for a particular part. A revision can be generated from any part, there are no restrictions requiring the revision to be generated from the current latest revision. For example if our part "ion-13" has existing revisions A and B, then a third revision C can be generated from either existing revision A or B. All information in the new revision is copied over from the old revision unless explicitly overriden in the mutation input. The new revision will be the next valid alphabetic character from the part's latest revision. If the part's latest revision is C, then the new revision will be D. If the part's latest revision is Z, then the new revision will be AA. Returns the newly created part object with the updated revision.
Mutation to create a part revision
Delete a part object. This will delete not only the part object itself but also cascade and delete the MBOM and MBOM substitutes associated with this part. A part which has existing inventory or was used within a run cannot be deleted. Returns the ID of the deleted part.
Mutation to delete part object
Query to retrieve parts
ION allows users to define custom schemes for part revisioning. These schemes are defined within an organization's settings, the mutation below demonstrates how to create a new scheme. First a user needs the ID and etag of the organization before its settings can be updated. Following that there are four additional variables which define a part revision scheme.
name (string): The name of the new revision scheme
default (boolean): If true all newly created parts will inherit this revision scheme
allowOverflow (boolean): Defines whether an error should be raised when the max iteration of a revision scheme is reached, or if it should overflow to the next available value.
format (array[string]): The format is an array of strings which defines how the values of a revision scheme should appear. The string values in the array can be either NUMERIC
, ALPHABETICAL
, or single character length constants. The format below would define part revisions like 00-1
or 95-7
.
Once a part revision scheme exists in an organization's settings it can subsequently be updated. Currently the only allowable updates to a part revision scheme are the fields allowOverflow and default.
There are two strategies for changing the revision scheme of an existing part. Both involve setting the revisionScheme
for a part in either the updatePart
or createPartRevision
mutations above. The revisionScheme
should be set to the name of one of the schemes in the organization's settings.
Setting the revisionScheme
in the updatePart
mutation casts the part's revision. For example if a part currently has revision D
and we update that part to use the revisionScheme "new scheme" which we created above then the revision will be set to 00-4
Setting the revisionScheme
in the createPartRevision
mutation resets the parts revision, starting it over from the initial revision of the new scheme. If a part has revision D
and we update the part's revisionScheme
in the createPartRevision
mutation it will be set to 00-1
.
Part Object
Description
id
Unique identifier of Part object
partNumber
parts must have a unique partNumber and revision
revision
Revision for part, defaults to A
trackingType
If set enforces all inventory for part to match tracking type. Can be either "serial" or "lot"
quantity
The summed quantity of all inventory for a part
partsInventory
List of inventory objects related to a part
runs
List of runs related to part
mbom
List of MBOM item which describe the BOM of a part