> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/api-reference/tracr-api/references/diamonds.md). # Diamonds ## Create Rough Diamond > Create a rough diamond in the inventory. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/rough/create":{"post":{"description":"Create a rough diamond in the inventory.","operationId":"create_rough_diamond_diamonds_rough_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoughDiamond"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV1"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Create Rough Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"CreateRoughDiamond":{"additionalProperties":false,"description":"Describes what's mandatory for the create rough diamond endpoint,\nregardless of a particular instance's configuration.","properties":{"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","default":"assured"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Box description
Tracr class: entity_specific","nullable":true,"title":"Box Description"},"box_id":{"description":"System name and ID pairs identifying the source batch for the diamond.
Tracr class: entity_specific","nullable":false,"title":"Box Id","type":"string"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}]},"participant_id":{"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID. This field must be unique within the box/shipment the diamond is registered against.","nullable":false,"pattern":"^\\S(.*\\S)?$","title":"Participant Id","type":"string"},"participant_timestamp":{"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific","format":"date-time","nullable":false,"title":"Participant Timestamp","type":"string"},"rough":{"$ref":"#/components/schemas/RoughSchema"},"sight_no":{"anyOf":[{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight number
Tracr class: entity_specific","nullable":true},{"type":"null"}],"title":"Sight No"},"sight_year":{"anyOf":[{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight year
Tracr class: entity_specific","nullable":true},{"type":"null"}],"title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags
Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["box_id","participant_id","participant_timestamp","rough"],"title":"CreateRoughDiamond","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"RoughSchema":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats
Tracr class: traceability","nullable":false,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale
Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.
Tracr class: traceability","nullable":true,"title":"Stress"}},"required":["carats"],"title":"RoughSchema","type":"object"},"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Resend Data Request > Resend a pending diamond data request. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{diamond_id}/data-request/{data_request_id}/resend":{"post":{"description":"Resend a pending diamond data request.","operationId":"resend_data_request_diamonds__diamond_id__data_request__data_request_id__resend_post","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},{"in":"path","name":"data_request_id","required":true,"schema":{"title":"Data Request Id","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Returned when the specified DiamondDataRequest could not be found."},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Returned when the DiamondDataRequest is not in a pending state, or when it lacks an associated IntegrationEvent."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Resend Data Request","tags":["Diamonds"]}}}} ``` ## Get Diamond > Returns the current version of the requested diamond, if it exists. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}":{"get":{"description":"Returns the current version of the requested diamond, if it exists.","operationId":"get_diamond_diamonds__id__get","parameters":[{"description":"The ID (UUID or Diamond ID) of the diamond","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID or Diamond ID) of the diamond","title":"Id"}},{"description":"If true, the diamond is returned only if its possession state is HELD","in":"query","name":"only_if_held","required":false,"schema":{"default":false,"description":"If true, the diamond is returned only if its possession state is HELD","title":"Only If Held","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV1"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request does not match specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Upload Diamond Grading Certificate > Upload any grading report associating it with the polished diamond.\ > Rough diamonds cannot be updated with a grading report file. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/grading_certificates":{"post":{"description":"Upload any grading report associating it with the polished diamond.\nRough diamonds cannot be updated with a grading report file.","operationId":"upload_diamond_grading_certificate_diamonds__id__files_grading_certificates_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GradingCertificateUploadParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GradedMeasurementUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Grading Certificate","tags":["Diamonds"]}}},"components":{"schemas":{"GradingCertificateUploadParams":{"description":"The form usede by the upload_grading_certificate_endpoint.","properties":{"carats":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"certificate_file":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"description":"The grading certificate file.","title":"Certificate File"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"clarity_characteristics_diagram":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"title":"Clarity Characteristics Diagram"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"file":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"deprecated":true,"description":"The grading certificate file. This field is deprecated, use certificate_file instead.","title":"File"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate No"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report No"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"Other","title":"Grading Lab"},"length":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"proportions_diagram":{"anyOf":[{"format":"binary","type":"string"},{"type":"null"}],"title":"Proportions Diagram"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"title":"GradingCertificateUploadParams","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"GradedMeasurementUploadResponse":{"additionalProperties":false,"properties":{"graded_measurement_id":{"description":"Graded Measurement ID.","title":"Graded Measurement Id","type":"string"},"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash","graded_measurement_id"],"title":"GradedMeasurementUploadResponse","type":"object"}}}} ``` ## Upload Diamond Image > Upload an image file associating it with the current lifecycle state of the\ > diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/images":{"post":{"description":"Upload an image file associating it with the current lifecycle state of the\ndiamond.","operationId":"upload_diamond_image_diamonds__id__files_images_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_image_diamonds__id__files_images_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Image","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_image_diamonds__id__files_images_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Valid values: default, 3d, b2b, heart, arrow, aset_scope, plot, face_up, dark_field, ideal_scope, fluorescence, inclusion_map, diagram, other. Default: default"}},"required":["file"],"title":"Body_upload_diamond_image_diamonds__id__files_images_post","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Plan > Upload a plan file associating it with only the rough diamond. Polished\ > diamonds cannot be updated with a plan file. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/plan":{"post":{"description":"Upload a plan file associating it with only the rough diamond. Polished\ndiamonds cannot be updated with a plan file.","operationId":"upload_diamond_plan_diamonds__id__files_plan_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_plan_diamonds__id__files_plan_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Plan","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_plan_diamonds__id__files_plan_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Version"}},"required":["file"],"title":"Body_upload_diamond_plan_diamonds__id__files_plan_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Plan Report > Upload a plan file report associating it with only the rough diamond.\ > Polished diamonds cannot be updated with a plan file. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/plan/reports":{"post":{"description":"Upload a plan file report associating it with only the rough diamond.\nPolished diamonds cannot be updated with a plan file.","operationId":"upload_diamond_plan_report_diamonds__id__files_plan_reports_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_plan_report_diamonds__id__files_plan_reports_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Plan Report","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_plan_report_diamonds__id__files_plan_reports_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"}},"required":["file"],"title":"Body_upload_diamond_plan_report_diamonds__id__files_plan_reports_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Scan > Upload a scan file associating it with the current lifecycle state of the\ > diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/scan":{"post":{"description":"Upload a scan file associating it with the current lifecycle state of the\ndiamond.","operationId":"upload_diamond_scan_diamonds__id__files_scan_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_scan_diamonds__id__files_scan_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Scan","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_scan_diamonds__id__files_scan_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"}},"required":["file"],"title":"Body_upload_diamond_scan_diamonds__id__files_scan_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Scan Report > Upload a scan report file associating it with the current lifecycle state\ > of the diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/scan/reports":{"post":{"description":"Upload a scan report file associating it with the current lifecycle state\nof the diamond.","operationId":"upload_diamond_scan_report_diamonds__id__files_scan_reports_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_scan_report_diamonds__id__files_scan_reports_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Scan Report","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_scan_report_diamonds__id__files_scan_reports_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Software Version"}},"required":["file"],"title":"Body_upload_diamond_scan_report_diamonds__id__files_scan_reports_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Supplementary File > Upload any supplementary files associating them with the current lifecycle\ > state of the diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/supplementary_files":{"post":{"description":"Upload any supplementary files associating them with the current lifecycle\nstate of the diamond.","operationId":"upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Supplementary File","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"}},"required":["file"],"title":"Body_upload_diamond_supplementary_file_diamonds__id__files_supplementary_files_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Upload Diamond Video > Upload a video file associating it with the current lifecycle state of the\ > diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/videos":{"post":{"description":"Upload a video file associating it with the current lifecycle state of the\ndiamond.","operationId":"upload_diamond_video_diamonds__id__files_videos_post","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_diamond_video_diamonds__id__files_videos_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity. Incorrect file extension."},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Upload Diamond Video","tags":["Diamonds"]}}},"components":{"schemas":{"Body_upload_diamond_video_diamonds__id__files_videos_post":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"file":{"format":"binary","title":"File","type":"string"}},"required":["file"],"title":"Body_upload_diamond_video_diamonds__id__files_videos_post","type":"object"},"FileUploadResponse":{"additionalProperties":false,"properties":{"hash":{"description":"File contents hash.","title":"Hash","type":"string"}},"required":["hash"],"title":"FileUploadResponse","type":"object"}}}} ``` ## Get Diamond File > Download a file ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/files/{hash}":{"get":{"description":"Download a file","operationId":"get_diamond_file_diamonds__id__files__hash__get","parameters":[{"description":"File contents hash.","in":"path","name":"hash","required":true,"schema":{"description":"File contents hash.","title":"Hash","type":"string"}},{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"responses":{"302":{"content":{"application/json":{"schema":{}}},"description":"A redirection to a presigned S3 url for the requested file."},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Diamond File","tags":["Diamonds"]}}}} ``` ## Get Graded Measurements > Get an unpaginated list of all graded measurements for the diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/graded-measurements":{"get":{"description":"Get an unpaginated list of all graded measurements for the diamond.","operationId":"get_graded_measurements_diamonds__id__graded_measurements_get","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleListResponse_GradingDataView_"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Graded Measurements","tags":["Diamonds"]}}},"components":{"schemas":{"SimpleListResponse_GradingDataView_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/GradingDataView"},"title":"Results","type":"array"}},"required":["results"],"title":"SimpleListResponse[GradingDataView]","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}} ``` ## Deselect Graded Measurement > Mark the specified graded measurement as inactive. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/graded-measurements/{graded_measurement_id}/deselect":{"patch":{"description":"Mark the specified graded measurement as inactive.","operationId":"deselect_graded_measurement_diamonds__id__graded_measurements__graded_measurement_id__deselect_patch","parameters":[{"in":"path","name":"graded_measurement_id","required":true,"schema":{"title":"Graded Measurement Id","type":"string"}},{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GradingDataView"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Deselect Graded Measurement","tags":["Diamonds"]}}},"components":{"schemas":{"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}} ``` ## Select Graded Measurement > Mark the specified graded measurement as active. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/graded-measurements/{graded_measurement_id}/select":{"patch":{"description":"Mark the specified graded measurement as active.","operationId":"select_graded_measurement_diamonds__id__graded_measurements__graded_measurement_id__select_patch","parameters":[{"in":"path","name":"graded_measurement_id","required":true,"schema":{"title":"Graded Measurement Id","type":"string"}},{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GradingDataView"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Select Graded Measurement","tags":["Diamonds"]}}},"components":{"schemas":{"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}} ``` ## Polish Diamond > Transform a rough diamond to a polished diamond in the inventory. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/polish":{"post":{"description":"Transform a rough diamond to a polished diamond in the inventory.","operationId":"polish_diamond_diamonds__id__polish_post","parameters":[{"description":"The ID (UUID) of the diamond to polish.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond to polish.","title":"Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolishDiamond"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV1"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Polish Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"PolishDiamond":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.
Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr class: entity_specific","nullable":true,"title":"Participant Id"},"participant_timestamp":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific","nullable":true,"title":"Participant Timestamp"},"polished":{"$ref":"#/components/schemas/PolishedSchema"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags
Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["polished"],"title":"PolishDiamond","type":"object"},"PolishedSchema":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats
Tracr class: traceability","nullable":false,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond
Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond
Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle
Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height
Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition
Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size
Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut
Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent
Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum
Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum
Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale
Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle
Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category
Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category
Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle
Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent
Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond
Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"$ref":"#/components/schemas/Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond
Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent
Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Width"}},"required":["carats","shape"],"title":"PolishedSchema","type":"object"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Create Rough Child Diamond > Following a split, registers any subsequent parts (children) by linking to\ > the original diamond. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/rough/create":{"post":{"description":"Following a split, registers any subsequent parts (children) by linking to\nthe original diamond.","operationId":"create_rough_child_diamond_diamonds__id__rough_create_post","parameters":[{"description":"The ID (UUID) of the diamond to create a child diamond from.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond to create a child diamond from.","title":"Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoughChildDiamond"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV1"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Create Rough Child Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"CreateRoughChildDiamond":{"additionalProperties":false,"description":"Describes what's mandatory for the create rough child diamond endpoint,\nregardless of a particular instance's configuration.","properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.
Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr class: entity_specific","nullable":false,"pattern":"^\\S(.*\\S)?$","title":"Participant Id","type":"string"},"participant_timestamp":{"description":"A timestamp (in ISO8601 format) representing the real world time that the change happened.
Tracr class: entity_specific","format":"date-time","nullable":false,"title":"Participant Timestamp","type":"string"},"rough":{"$ref":"#/components/schemas/RoughSchema"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags
Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_id","participant_timestamp","rough"],"title":"CreateRoughChildDiamond","type":"object"},"RoughSchema":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"type":"string"}],"description":"Weight of the diamond in carats
Tracr class: traceability","nullable":false,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Formatted Fancy colour (Intensity + Overtone + Colour) or colour from the standard scale
Tracr class: entity_specific","nullable":true,"title":"Display Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.
Tracr class: traceability","nullable":true,"title":"Stress"}},"required":["carats"],"title":"RoughSchema","type":"object"},"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Split Diamond > Mark a rough diamond as split. Split means the rough diamond has been cut\ > and it is now removed from the inventory. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/split":{"post":{"description":"Mark a rough diamond as split. Split means the rough diamond has been cut\nand it is now removed from the inventory.","operationId":"split_diamond_diamonds__id__split_post","parameters":[{"description":"The ID (UUID) of the diamond to split.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond to split.","title":"Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestWithTimestamp"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV1"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Split Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"RequestWithTimestamp":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}]},"participant_timestamp":{"description":"The ISO 8601 timestamp of when the real world event occurred","format":"date-time","title":"Participant Timestamp","type":"string"}},"required":["participant_timestamp"],"title":"RequestWithTimestamp","type":"object"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"DiamondV1":{"description":"A diamond as returned from V1 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV1Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV1Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV1Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV1","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV1Polished":{"description":"Polished attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV1Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV1Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V1 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV1Provenance","type":"object"},"DiamondV1Rough":{"description":"Rough attributes of a diamond as returned from the V1 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV1Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Get Diamonds > Returns a paginated list of diamonds from the platform. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond/":{"get":{"description":"Returns a paginated list of diamonds from the platform.","operationId":"get_diamonds_v2_diamond__get","parameters":[{"description":"Filter to diamonds with an exact match on the given box ID.","in":"query","name":"box_id","required":false,"schema":{"description":"Filter to diamonds with an exact match on the given box ID.","title":"Box Id","type":"string"}},{"description":"Filter to diamonds where the box ID contains the given value (case sensitive).","in":"query","name":"box_id__contains","required":false,"schema":{"description":"Filter to diamonds where the box ID contains the given value (case sensitive).","title":"Box Id Contains","type":"string"}},{"description":"Filter to diamonds where the box ID contains the given value (case insensitive).","in":"query","name":"box_id__icontains","required":false,"schema":{"description":"Filter to diamonds where the box ID contains the given value (case insensitive).","title":"Box Id Icontains","type":"string"}},{"description":"Filter to diamonds with an exact match on the given sight year.","in":"query","name":"sight_year","required":false,"schema":{"description":"Filter to diamonds with an exact match on the given sight year.","title":"Sight Year","type":"integer"}},{"description":"Filter to diamonds with an exact match on the given sight number.","in":"query","name":"sight_no","required":false,"schema":{"description":"Filter to diamonds with an exact match on the given sight number.","title":"Sight No","type":"integer"}},{"description":"Filter to diamonds updated on or after the timestamp. Must be an ISO-8601 compliant timestamp.","in":"query","name":"system_timestamp__gte","required":false,"schema":{"description":"Filter to diamonds updated on or after the timestamp. Must be an ISO-8601 compliant timestamp.","format":"date-time","title":"System Timestamp Gte","type":"string"}},{"description":"Filter to diamonds updated before the timestamp. Must be an ISO-8601 compliant timestamp.","in":"query","name":"system_timestamp__lt","required":false,"schema":{"description":"Filter to diamonds updated before the timestamp. Must be an ISO-8601 compliant timestamp.","format":"date-time","title":"System Timestamp Lt","type":"string"}},{"description":"Filter to diamonds updated on or after the user supplied timestamp. Must be an ISO-8601 compliant timestamp.","in":"query","name":"participant_timestamp__gte","required":false,"schema":{"description":"Filter to diamonds updated on or after the user supplied timestamp. Must be an ISO-8601 compliant timestamp.","format":"date-time","title":"Participant Timestamp Gte","type":"string"}},{"description":"Filter to diamonds updated before the user supplied timestamp. Must be an ISO-8601 compliant timestamp.","in":"query","name":"participant_timestamp__lt","required":false,"schema":{"description":"Filter to diamonds updated before the user supplied timestamp. Must be an ISO-8601 compliant timestamp.","format":"date-time","title":"Participant Timestamp Lt","type":"string"}},{"description":"Filter to diamonds with one of the specified Tracr IDs.","in":"query","name":"diamond_id__in","required":false,"schema":{"description":"Filter to diamonds with one of the specified Tracr IDs.","title":"Diamond Id In","type":"string"}},{"description":"Filter to diamonds with the specified participant ID (from ERP).","in":"query","name":"participant_id","required":false,"schema":{"description":"Filter to diamonds with the specified participant ID (from ERP).","title":"Participant Id","type":"string"}},{"description":"Filter to diamonds with one of the specified participant IDs (from ERP).","in":"query","name":"participant_id__in","required":false,"schema":{"description":"Filter to diamonds with one of the specified participant IDs (from ERP).","title":"Participant Id In","type":"string"}},{"description":"Filter to diamonds where the parent diamond has the given Tracr ID.","in":"query","name":"diamond_parent_id","required":false,"schema":{"description":"Filter to diamonds where the parent diamond has the given Tracr ID.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Parent Id","type":"string"}},{"description":"Filter to diamonds where the parent diamond has one of the given Tracr IDs.","in":"query","name":"diamond_parent_id__in","required":false,"schema":{"description":"Filter to diamonds where the parent diamond has one of the given Tracr IDs.","title":"Diamond Parent Id In","type":"string"}},{"description":"Filter diamonds based on whether they have a parent or not.","in":"query","name":"diamond_parent_id__isnull","required":false,"schema":{"description":"Filter diamonds based on whether they have a parent or not.","title":"Diamond Parent Id Isnull","type":"boolean"}},{"description":"Filter to diamonds where the parent diamond has the given participant ID.","in":"query","name":"participant_parent_id","required":false,"schema":{"description":"Filter to diamonds where the parent diamond has the given participant ID.","title":"Participant Parent Id","type":"string"}},{"description":"Filter to diamonds where the parent diamond has one of the given participant IDs.","in":"query","name":"participant_parent_id__in","required":false,"schema":{"description":"Filter to diamonds where the parent diamond has one of the given participant IDs.","title":"Participant Parent Id In","type":"string"}},{"description":"Filter to diamonds with the specified lifecycle state.","in":"query","name":"lifecycle_state","required":false,"schema":{"$ref":"#/components/schemas/LifecycleState","description":"Filter to diamonds with the specified lifecycle state.","title":"Lifecycle State"}},{"description":"Filter to diamonds with one of the specified lifecycle states.","in":"query","name":"lifecycle_state__in","required":false,"schema":{"description":"Filter to diamonds with one of the specified lifecycle states.","title":"Lifecycle State In","type":"string"}},{"description":"Filter to diamonds with the specified possession state.","in":"query","name":"possession_state","required":false,"schema":{"$ref":"#/components/schemas/PossessionState","description":"Filter to diamonds with the specified possession state.","title":"Possession State"}},{"description":"Filter to diamonds with one of the specified possession states.","in":"query","name":"possession_state__in","required":false,"schema":{"description":"Filter to diamonds with one of the specified possession states.","title":"Possession State In","type":"string"}},{"description":"Filter to diamonds with the specified unlock status.","in":"query","name":"unlock_status","required":false,"schema":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Filter to diamonds with the specified unlock status.","title":"Unlock Status"}},{"description":"Filter to diamonds with or without a rough check.","in":"query","name":"rough_check","required":false,"schema":{"description":"Filter to diamonds with or without a rough check.","title":"Rough Check","type":"boolean"}},{"description":"Filter diamonds with an exact match on the source of the active grading data.","in":"query","name":"grading__source","required":false,"schema":{"$ref":"#/components/schemas/GradedMeasurementSource","description":"Filter diamonds with an exact match on the source of the active grading data.","title":"Grading Source"}},{"description":"Filter diamonds with an exact match on the grading lab of the active grading data.","in":"query","name":"grading__lab","required":false,"schema":{"$ref":"#/components/schemas/GradingLab","description":"Filter diamonds with an exact match on the grading lab of the active grading data.","title":"Grading Lab"}},{"description":"Filter diamonds based on whether objective verification has been attempted or not.","in":"query","name":"rough_objective_verification_results__isnull","required":false,"schema":{"description":"Filter diamonds based on whether objective verification has been attempted or not.","title":"Rough Objective Verification Results Isnull","type":"boolean"}},{"description":"Filter diamonds based on the source of the current objective verification.","in":"query","name":"rough_objective_verification_results__source__in","required":false,"schema":{"description":"Filter diamonds based on the source of the current objective verification.","title":"Rough Objective Verification Results Source In","type":"string"}},{"description":"Filter diamonds based on the status of the current objective verification.","in":"query","name":"rough_objective_verification_results__status__in","required":false,"schema":{"description":"Filter diamonds based on the status of the current objective verification.","title":"Rough Objective Verification Results Status In","type":"string"}},{"description":"Filter diamonds based on whether objective verification has been attempted or not.","in":"query","name":"polished_objective_verification_results__isnull","required":false,"schema":{"description":"Filter diamonds based on whether objective verification has been attempted or not.","title":"Polished Objective Verification Results Isnull","type":"boolean"}},{"description":"Filter diamonds based on the source of the current objective verification.","in":"query","name":"polished_objective_verification_results__source__in","required":false,"schema":{"description":"Filter diamonds based on the source of the current objective verification.","title":"Polished Objective Verification Results Source In","type":"string"}},{"description":"Filter diamonds based on the status of the current objective verification.","in":"query","name":"polished_objective_verification_results__status__in","required":false,"schema":{"description":"Filter diamonds based on the status of the current objective verification.","title":"Polished Objective Verification Results Status In","type":"string"}},{"description":"Filter to diamonds where the grader report number matches the given value.","in":"query","name":"grading__report_number","required":false,"schema":{"description":"Filter to diamonds where the grader report number matches the given value.","title":"Grading Report Number","type":"string"}},{"description":"Filter to diamonds where the grader inscription numbers contain the given value.","in":"query","name":"grading__inscription_number","required":false,"schema":{"description":"Filter to diamonds where the grader inscription numbers contain the given value.","title":"Grading Inscription Number","type":"string"}},{"deprecated":true,"description":"Filter to diamonds with the specified registering party (e.g., participant, sarine, diadna). This filter is deprecated and will be removed in a future version. Please use `registered_by_integration` instead.","in":"query","name":"registered_by","required":false,"schema":{"$ref":"#/components/schemas/RegisteringParty","deprecated":true,"description":"Filter to diamonds with the specified registering party (e.g., participant, sarine, diadna). This filter is deprecated and will be removed in a future version. Please use `registered_by_integration` instead.","title":"Registered By"}},{"deprecated":true,"description":"Filter to diamonds with one of the specified registering parties. This filter is deprecated and will be removed in a future version. Please use `registered_by_integration__in` instead.","in":"query","name":"registered_by__in","required":false,"schema":{"deprecated":true,"description":"Filter to diamonds with one of the specified registering parties. This filter is deprecated and will be removed in a future version. Please use `registered_by_integration__in` instead.","title":"Registered By In","type":"string"}},{"description":"Filter to diamonds registered via the specified integration (e.g., participant, sarine).","in":"query","name":"registered_by_integration","required":false,"schema":{"$ref":"#/components/schemas/RegisteringIntegrationParty","description":"Filter to diamonds registered via the specified integration (e.g., participant, sarine).","title":"Registered By Integration"}},{"description":"Filter to diamonds registered via one of the specified integrations.","in":"query","name":"registered_by_integration__in","required":false,"schema":{"description":"Filter to diamonds registered via one of the specified integrations.","title":"Registered By Integration In","type":"string"}},{"description":"Filter to diamonds polished via the specified integration (e.g., participant, sarine).","in":"query","name":"polished_by_integration","required":false,"schema":{"$ref":"#/components/schemas/RegisteringIntegrationParty","description":"Filter to diamonds polished via the specified integration (e.g., participant, sarine).","title":"Polished By Integration"}},{"description":"Filter to diamonds polished via one of the specified integrations.","in":"query","name":"polished_by_integration__in","required":false,"schema":{"description":"Filter to diamonds polished via one of the specified integrations.","title":"Polished By Integration In","type":"string"}},{"description":"List archived diamonds","in":"query","name":"is_archived","required":false,"schema":{"default":false,"description":"List archived diamonds","title":"Is Archived","type":"boolean"}},{"description":"Filter to diamonds that appear in the outbound shipment with the specified ID.","in":"query","name":"outbound_shipment_id","required":false,"schema":{"description":"Filter to diamonds that appear in the outbound shipment with the specified ID.","title":"Outbound Shipment Id","type":"string"}},{"description":"Filter diamonds based on whether they're in an active outbound shipment.","in":"query","name":"in_outbound_shipment","required":false,"schema":{"description":"Filter diamonds based on whether they're in an active outbound shipment.","title":"In Outbound Shipment","type":"boolean"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"minimum":1,"title":"Page","type":"integer"}},{"in":"query","name":"size","required":false,"schema":{"default":100,"maximum":1000,"minimum":1,"title":"Size","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondsV2ListResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Diamonds","tags":["Diamonds"]}}},"components":{"schemas":{"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"RegisteringParty":{"enum":["participant","sarine","diadna"],"title":"RegisteringParty","type":"string"},"RegisteringIntegrationParty":{"enum":["participant","sarine"],"title":"RegisteringIntegrationParty","type":"string"},"DiamondsV2ListResponse":{"description":"A paginated response containing zero or more diamonds.","properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page.","title":"Next"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"description":"The number of the current page.","title":"Page"},"pages":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"The total number of pages.","title":"Pages"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL of the previous page.","title":"Previous"},"results":{"description":"The results for the current page.","items":{"$ref":"#/components/schemas/DiamondV2"},"title":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"DiamondsV2ListResponse","type":"object"},"DiamondV2":{"description":"A diamond as returned from V2 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV2","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Get diamond filters > Return the filter values that can be used to filter diamonds. This returns three types of value:\ > \- Distinct lists contain all distinct values used in the filtered diamonds.\ > \- Range lists the min and max values used in the filtered diamonds.\ > \- Bucket lists the min and max values and a list of buckets in which diamonds can be found. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond/filter":{"get":{"description":"Return the filter values that can be used to filter diamonds. This returns three types of value:\n- Distinct lists contain all distinct values used in the filtered diamonds.\n- Range lists the min and max values used in the filtered diamonds.\n- Bucket lists the min and max values and a list of buckets in which diamonds can be found.","operationId":"filters_v2_diamond_filter_get","parameters":[{"description":"Filter to diamonds with the specified lifecycle state.","in":"query","name":"lifecycle_state","required":false,"schema":{"$ref":"#/components/schemas/LifecycleState","description":"Filter to diamonds with the specified lifecycle state.","title":"Lifecycle State"}},{"description":"Filter to diamonds with the specified possession state.","in":"query","name":"possession_state","required":false,"schema":{"$ref":"#/components/schemas/PossessionState","description":"Filter to diamonds with the specified possession state.","title":"Possession State"}},{"description":"Filter diamonds with or without an active graded measurement.","in":"query","name":"grading__is_active","required":false,"schema":{"description":"Filter diamonds with or without an active graded measurement.","title":"Grading Is Active","type":"boolean"}},{"description":"List archived diamonds","in":"query","name":"is_archived","required":false,"schema":{"default":false,"description":"List archived diamonds","title":"Is Archived","type":"boolean"}},{"description":"Filter on whether the diamond has no parent","in":"query","name":"diamond_parent_id__isnull","required":false,"schema":{"description":"Filter on whether the diamond has no parent","title":"Diamond Parent Id Isnull","type":"boolean"}},{"description":"The filter fields to return. If absent, all fields will be returned.","in":"query","name":"fields","required":false,"schema":{"default":[],"description":"The filter fields to return. If absent, all fields will be returned.","items":{"type":"string"},"title":"Fields","type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV2FiltersResponse"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get diamond filters","tags":["Diamonds"]}}},"components":{"schemas":{"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2FiltersResponse":{"description":"Result filter values found across all diamonds.","properties":{"results":{"additionalProperties":{"$ref":"#/components/schemas/DiamondV2Filter"},"title":"Results","type":"object"}},"required":["results"],"title":"DiamondV2FiltersResponse","type":"object"},"DiamondV2Filter":{"description":"The filter values supported by a field.","properties":{"bucket":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiamondV2Bucket"},"type":"array"},{"type":"null"}],"title":"Bucket"},"distinct":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Distinct"},"range":{"anyOf":[{"$ref":"#/components/schemas/DiamondV2Range"},{"type":"null"}]}},"title":"DiamondV2Filter","type":"object"},"DiamondV2Bucket":{"description":"A carat weight bucket.","properties":{"exclusive_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusive End"},"inclusive_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inclusive Start"}},"required":["inclusive_start","exclusive_end"],"title":"DiamondV2Bucket","type":"object"},"DiamondV2Range":{"description":"A range of values.","properties":{"max":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Max"},"min":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Min"}},"required":["min","max"],"title":"DiamondV2Range","type":"object"}}}} ``` ## Get Diamond Detail > Returns detailed information about a specific diamond, including its top rough (parent diamond) if it exists. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond/{id}":{"get":{"description":"Returns detailed information about a specific diamond, including its top rough (parent diamond) if it exists.","operationId":"get_diamond_detail_v2_diamond__id__get","parameters":[{"description":"The ID (UUID) of the diamond.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond.","title":"Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV2Detail"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Get Diamond Detail","tags":["Diamonds"]}}},"components":{"schemas":{"DiamondV2Detail":{"description":"Extended diamond details as returned from the V2 diamond detail endpoint.\n\nThis model extends DiamondV2 with additional fields:\n- top_rough: Details of the diamond's parent rough diamond (if it exists)\n- status: The possession state of the diamond (same as used in inventory)","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"status":{"$ref":"#/components/schemas/DiamondStatus","description":"The inventory status of the diamond"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"top_rough":{"anyOf":[{"$ref":"#/components/schemas/DiamondV2TopRough"},{"type":"null"}],"description":"Details of the diamond's top rough"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id","status"],"title":"DiamondV2Detail","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondStatus":{"description":"Derived inventory status of a diamond, mirroring the portal-api status column.\n\nValues:\n- ``transferring``: The diamond is in an active outbound transfer.\n- ``unavailable``: Polished, not unlocked, rough OV passed but polished OV is still\n required (mandate_polished_check is active and carats ≥ threshold).\n- ``locked``: Polished diamond that has not yet been unlocked.\n- ``action_required_missing_rough_scan``: Top-level rough diamond above the carat\n threshold that is missing its rough scan.\n- ``action_required_unconfirmed_rough_scan``: Top-level rough diamond above the\n carat threshold whose rough OV returned a failure result.\n- ``processing_rough_objective_verification``: Rough OV for this diamond is in progress.\n- ``processing_polished_objective_verification``: Polished OV for this diamond is in progress.\n- ``available``: All other cases — the diamond is available for use.","enum":["transferring","unavailable","locked","action_required_missing_rough_scan","action_required_unconfirmed_rough_scan","processing_rough_objective_verification","processing_polished_objective_verification","available"],"title":"DiamondStatus","type":"string"},"DiamondV2TopRough":{"properties":{"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["current_stage","diamond_id","entity_specific_tags","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","system_timestamp","version_id"],"title":"DiamondV2TopRough","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Update Polished Diamond > Update the polished object of a diamond in the inventory.\ > \ > Only polished diamonds can be updated with this endpoint. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond/{id}/polished":{"patch":{"description":"Update the polished object of a diamond in the inventory.\n\nOnly polished diamonds can be updated with this endpoint.","operationId":"update_polished_diamond_v2_diamond__id__polished_patch","parameters":[{"description":"The ID (UUID) of the diamond to update.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond to update.","title":"Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePolished"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV2"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Update Polished Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"UpdatePolished":{"additionalProperties":false,"properties":{"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.
Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"pattern":"^\\S(.*\\S)?$","type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID. This field must be unique within the box/shipment the diamond is registered against. Can be updated as long as the the diamond's possession_state is held.","title":"Participant Id"},"participant_timestamp":{"format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/PolishedRW","default":{}},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags
Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_timestamp"],"title":"UpdatePolished","type":"object"},"PolishedRW":{"additionalProperties":false,"description":"Data on the polished diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats
Tracr class: traceability","nullable":true,"title":"Carats"},"clarity":{"anyOf":[{"pattern":"^(FL|IF|LC|VVS1|VVS2|VS1|VS2|SI1|SI2|SI3|I1|I2|I3|P1|P2|P3)$","type":"string"},{"type":"null"}],"description":"Clarity of polished diamond
Tracr class: traceability","nullable":true,"title":"Clarity"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of polished diamond
Tracr class: traceability","nullable":true,"title":"Colour"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Angle
Tracr class: traceability","nullable":true,"title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Crown Height
Tracr class: traceability","nullable":true,"title":"Crown Height"},"culet_condition":{"anyOf":[{"pattern":"^(P|A|C)$","type":"string"},{"type":"null"}],"description":"Culet Condition
Tracr class: traceability","nullable":true,"title":"Culet Condition"},"culet_size":{"anyOf":[{"pattern":"^(EL|VL|L|SL|M|S|VS|N)$","type":"string"},{"type":"null"}],"description":"Culet Size
Tracr class: traceability","nullable":true,"title":"Culet Size"},"cut_grade":{"anyOf":[{"pattern":"^(I|EX|VG|G|F|P|NA)$","type":"string"},{"type":"null"}],"description":"Grade of Cut
Tracr class: traceability","nullable":true,"title":"Cut Grade"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"3rd dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depth percent
Tracr class: traceability","nullable":true,"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Maximum
Tracr class: traceability","nullable":true,"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Diameter Minimum
Tracr class: traceability","nullable":true,"title":"Diameter Minimum"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of polished diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of polished diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"girdle_condition":{"anyOf":[{"pattern":"^(P|F|B)$","type":"string"},{"type":"null"}],"description":"Condition of girdle
Tracr class: traceability","nullable":true,"title":"Girdle Condition"},"girdle_thickness_from":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Smallest girdle thickness category
Tracr class: traceability","nullable":true,"title":"Girdle Thickness From"},"girdle_thickness_to":{"anyOf":[{"pattern":"(?i)^(Extremely Thick|Very Thick|Thick|Slightly Thick|Medium|Thin|Slightly Thin|Very Thin|Extremely Thin)$","type":"string"},{"type":"null"}],"description":"Largest girdle thickness category
Tracr class: traceability","nullable":true,"title":"Girdle Thickness To"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"First dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Angle
Tracr class: traceability","nullable":true,"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pavillion Percent
Tracr class: traceability","nullable":true,"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Quality of polished diamond
Tracr class: traceability","nullable":true,"title":"Polish Quality"},"shape":{"anyOf":[{"pattern":"(?i)^(Asscher|Baguette|Briolette|Bullets|Calf|Cushion|Emerald|European Cut|Flanders|Half Moon|Heart|Hexagonal|Kite|Lozenge|Marquise|Octagonal|Old Miner|Oval|Pear|Pentagonal|Princess|Radiant|Rectangle|Rose|Round|Shield|Square|Square Emerald|Square Radiant|Star|Tapered Baguette|Tapered Bullet|Trapezoid|Triangle|Trilliant|Cushion Modified Brilliant|Other)$","type":"string"},{"type":"null"}],"description":"Shape of polished diamond
Tracr class: traceability","nullable":true,"title":"Shape"},"symmetry":{"anyOf":[{"pattern":"^(I|EX|VG-EX|VG|G-VG|G|F-G|F|P)$","type":"string"},{"type":"null"}],"description":"Symmetry of the polished diamond
Tracr class: traceability","nullable":true,"title":"Symmetry"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Table percent
Tracr class: traceability","nullable":true,"title":"Table Percent"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Second dimension of polished diamond
Tracr class: traceability","nullable":true,"title":"Width"}},"title":"PolishedRW","type":"object"},"DiamondV2":{"description":"A diamond as returned from V2 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV2","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` ## Update Rough Diamond > Update the rough object of a diamond in the inventory.\ > \ > Only rough diamonds can be updated with this endpoint. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.34.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond/{id}/rough":{"patch":{"description":"Update the rough object of a diamond in the inventory.\n\nOnly rough diamonds can be updated with this endpoint.","operationId":"update_rough_diamond_v2_diamond__id__rough_patch","parameters":[{"description":"The ID (UUID) of the diamond to update.","in":"path","name":"id","required":true,"schema":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"format":"uuid","type":"string"}],"description":"The ID (UUID) of the diamond to update.","title":"Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoughV2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiamondV2"}}},"description":"Successful Response"},"401":{"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"description":"Diamond ID not found. A diamond, with the provided ID, does not exist."},"409":{"description":"Diamond is archived"},"412":{"description":"Precondition check failed: The operation cannot be applied to the current state of the diamond."},"422":{"description":"Unprocessable Entity, request JSON body is not as per specification"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Update Rough Diamond","tags":["Diamonds"]}}},"components":{"schemas":{"UpdateRoughV2":{"additionalProperties":false,"properties":{"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Box description
Tracr class: entity_specific","nullable":true,"title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"System name and ID pairs identifying the source batch for the diamond.
Tracr class: entity_specific","nullable":true,"title":"Box Id"},"entity_specific_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Entity specific tags.
Tracr class: entity_specific","nullable":true,"title":"Entity Specific Tags"},"participant_id":{"anyOf":[{"pattern":"^\\S(.*\\S)?$","type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID. This field must be unique within the box/shipment the diamond is registered against. Can be updated as long as the the diamond's possession_state is held.","title":"Participant Id"},"participant_timestamp":{"format":"date-time","title":"Participant Timestamp","type":"string"},"provenance":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Provenance"},"rough":{"$ref":"#/components/schemas/RoughRW","default":{}},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight number
Tracr class: entity_specific","nullable":true,"title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Sight year
Tracr class: entity_specific","nullable":true,"title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Supplementary tags
Tracr class: supplementary","nullable":true,"title":"Supplementary Tags"}},"required":["participant_timestamp"],"title":"UpdateRoughV2","type":"object"},"RoughRW":{"additionalProperties":false,"description":"Data on the rough diamond","properties":{"carats":{"anyOf":[{"exclusiveMinimum":0,"type":"number"},{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Weight of the diamond in carats
Tracr class: traceability","nullable":true,"title":"Carats"},"colour":{"anyOf":[{"pattern":"^(D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z)$","type":"string"},{"type":"null"}],"description":"Colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Colour"},"fancy_colour":{"anyOf":[{"pattern":"^(BK|B|BN|CH|CM|CG|GY|G|O|P|PL|R|V|Y|W|X)$","type":"string"},{"type":"null"}],"description":"Fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour"},"fancy_colour_intensity":{"anyOf":[{"pattern":"^(F|VL|L|FL|FC|FCD|I|FV|D)$","type":"string"},{"type":"null"}],"description":"Intensity of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Overtone of fancy colour
Tracr class: traceability","nullable":true,"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"pattern":"^(B|W|Y|O|R|G|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence colour of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Colour"},"fluorescence_intensity":{"anyOf":[{"pattern":"^(VS|S|M|F|SL|VSL|N)$","type":"string"},{"type":"null"}],"description":"Fluorescence intensity of rough diamond
Tracr class: traceability","nullable":true,"title":"Fluorescence Intensity"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"
Tracr class: traceability","nullable":true,"title":"Quality"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stress description such as Tension, Light Stress etc.
Tracr class: traceability","nullable":true,"title":"Stress"}},"title":"RoughRW","type":"object"},"DiamondV2":{"description":"A diamond as returned from V2 API endpoints.","properties":{"archived_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Timestamp indicating when this diamond was archived.
Tracr Class: entity_specific","title":"Archived At"},"assets":{"default":[],"items":{"discriminator":{"mapping":{"image":"#/components/schemas/DiamondAssetV2ImageResponse","inscription_number":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse","plan":"#/components/schemas/DiamondAssetV2PlanResponse","plan_report":"#/components/schemas/DiamondAssetV2PlanReportResponse","scan":"#/components/schemas/DiamondAssetV2ScanResponse","scan_report":"#/components/schemas/DiamondAssetV2ScanReportResponse","supplementary":"#/components/schemas/DiamondAssetV2SupplementaryResponse","three_d_plan":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse","video":"#/components/schemas/DiamondAssetV2VideoResponse"},"propertyName":"asset_type"},"oneOf":[{"$ref":"#/components/schemas/DiamondAssetV2ImageResponse"},{"$ref":"#/components/schemas/DiamondAssetV2VideoResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ScanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2PlanReportResponse"},{"$ref":"#/components/schemas/DiamondAssetV2InscriptionNumberResponse"},{"$ref":"#/components/schemas/DiamondAssetV2ThreeDPlanResponse"},{"$ref":"#/components/schemas/DiamondAssetV2SupplementaryResponse"}]},"title":"Assets","type":"array"},"assurance_level":{"$ref":"#/components/schemas/AssuranceLevel","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific"},"box_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Box Description"},"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier of the box/lot/shipment the diamond is registered against.
Tracr Class: entity_specific","title":"Box Id"},"current_stage":{"$ref":"#/components/schemas/CurrentStage","description":"Indicates whether the diamond is rough or polished.
Tracr Class: traceability"},"data_requests":{"description":"The data requests associated with this diamond.","items":{"$ref":"#/components/schemas/DiamondDataRequest"},"title":"Data Requests","type":"array"},"diamond_id":{"description":"The diamond's unique identifier assigned by Tracr. Synonymous with Tracr ID.
Tracr Class: traceability","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"Tracr ID of the diamond's parent.
Tracr Class: traceability","title":"Diamond Parent Id"},"entity_specific_tags":{"anyOf":[{"$ref":"#/components/schemas/EntitySpecificTags"},{"type":"null"}],"description":"Tracr Class: entity_specific"},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Grading"},"id":{"description":"Legacy identifier of the diamond, superseded by diamond_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","format":"uuid","title":"Id","type":"string"},"is_current":{"description":"Indicates whether the version of the diamond returned from the API is the latest version. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Is Current","type":"boolean"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState","description":"Tracr Class: traceability"},"parent_id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Legacy identifier of the diamond's parent, superseded by diamond_parent_id. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Parent Id"},"participant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.
Tracr Class: entity_specific","title":"Participant Id"},"participant_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ERP of the diamond's parent.
Tracr Class: entity_specific","title":"Participant Parent Id"},"participant_timestamp":{"description":"User supplied timestamp of when the diamond was last modified.
Tracr Class: entity_specific","format":"date-time","title":"Participant Timestamp","type":"string"},"polished":{"$ref":"#/components/schemas/DiamondV2Polished"},"polished_objective_verification_results":{"description":"Polished objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"possession_state":{"$ref":"#/components/schemas/PossessionState","description":"Tracr Class: supplementary"},"producer_uuid":{"description":"Tracr platform identifier of the producer that first registered this diamond.
Tracr Class: traceability","format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/DiamondV2Provenance"},"rough":{"$ref":"#/components/schemas/DiamondV2Rough"},"rough_check":{"description":"Indicates whether this diamond has passed rough objective verification. Prior to a diamond being unlocked the Rough Check status will always be false.
Tracr Class: supplementary","title":"Rough Check","type":"boolean"},"rough_objective_verification_results":{"description":"Rough objective verification results for the diamond.
Tracr Class: supplementary","items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"schema_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates the internal schema version used when putting the diamond on blockchain. This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Schema Version"},"sight_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight No"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Sight Year"},"supplementary_tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Tags"},"system_timestamp":{"description":"Tracr Class: entity_specific","format":"date-time","title":"System Timestamp","type":"string"},"three_d_plan_available":{"default":false,"description":"Indicates whether a 3D plan is available for the diamond.
Tracr Class: supplementary","title":"Three D Plan Available","type":"boolean"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus","description":"Tracr Class: supplementary"},"verification_description":{"default":"verified record","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary","title":"Verification Description","type":"string"},"verification_status":{"$ref":"#/components/schemas/VerificationStatus","default":"Verified","description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: supplementary"},"verification_status_modified_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"This field is deprecated and will be removed in a future revision of the API.
Tracr Class: entity_specific","title":"Verification Status Modified At"},"version_id":{"description":"The identifier of the diamond's current version. This changes to a new unique identifier each time the diamond is updated.
Tracr Class: traceability","title":"Version Id","type":"string"}},"required":["assurance_level","current_stage","diamond_id","entity_specific_tags","id","is_current","lifecycle_state","participant_timestamp","polished","provenance","possession_state","producer_uuid","rough","rough_check","polished_objective_verification_results","rough_objective_verification_results","system_timestamp","unlock_status","version_id"],"title":"DiamondV2","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"const":"image","default":"image","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ImageFileExtension","description":"The image's file extension."},"filename":{"description":"The filename of the image.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type of image."},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"ImageType":{"enum":["default","3d","b2b","heart","arrow","aset_scope","plot","face_up","dark_field","ideal_scope","fluorescence","inclusion_map","diagram","other"],"title":"ImageType","type":"string"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"const":"video","default":"video","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/VideoFileExtension","description":"The video's file extension."},"filename":{"description":"The filename of the video.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"const":"scan","default":"scan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The scan's file extension."},"filename":{"description":"The filename of the scan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtension":{"description":"The different file extensions supported by Tracr for both rough and\npolished diamond scans.","enum":["adv","cap","gem","mmd","mme","oxy","ply","srn","stl","stn"],"title":"ScanFileExtension","type":"string"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"const":"scan_report","default":"scan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the scan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software running on the scanner used to produce this scan report.","title":"Scan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"const":"plan","default":"plan","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"$ref":"#/components/schemas/ScanFileExtension","description":"The plan's file extension."},"filename":{"description":"The filename of the plan.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan.","title":"Plan Software Version"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"const":"plan_report","default":"plan_report","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan report's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the plan report.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model of the scanner used to produce this plan report.","title":"Scan Device Model"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"const":"inscription_number","default":"inscription_number","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"const":"json","description":"The inscription number file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the inscription number file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No","type":"string"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The grading that inscribed the diamond.","title":"Grading Lab"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","grading_lab","graded_date","grader_inscription_no","content_hash"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"const":"three_d_plan","default":"three_d_plan","title":"Asset Type","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"polished_three_d_plan_content_hash":{"description":"The SHA-512 hash of the polished 3D plan's content.","title":"Polished Three D Plan Content Hash","type":"string"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension","type":"string"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename","type":"string"},"rough_three_d_plan_content_hash":{"description":"The SHA-512 hash of the rough 3D plan's content.","title":"Rough Three D Plan Content Hash","type":"string"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension","type":"string"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename","type":"string"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"const":"supplementary","default":"supplementary","title":"Asset Type","type":"string"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash","type":"string"},"created_at":{"description":"The time at which this diamond asset was first uploaded. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Created At","type":"string"},"diamond_id":{"description":"The Tracr ID for the diamond to which this asset belongs.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"diamond_stage":{"anyOf":[{"$ref":"#/components/schemas/CurrentStage"},{"type":"null"}],"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The supplementary file's file extension.","title":"Extension","type":"string"},"filename":{"description":"The filename of the supplementary file.","title":"Filename","type":"string"},"gallery":{"anyOf":[{"$ref":"#/components/schemas/DiamondAssetGallery"},{"type":"null"}],"description":"The gallery in which this asset will appear on the diamond details page in the Tracr Portal. On the Diamond Experience diamonds in the rough gallery will appear onthe Provenance page, diamonds in the split and polished galleries willappear on the Craftsmanship page. If no gallery is specified, the asset will not be displayed, but it will still be transferred with the diamond. "},"gallery_priority":{"default":0,"description":"Determines the position of the asset in the specified gallery relative to the other assets in the gallery. Assets with a higher gallery priority will appear before assets with a lower gallery priority. Assets with an equal gallery priority will appear subject to the lexicographical order of their id.","maximum":99,"minimum":-99,"title":"Gallery Priority","type":"integer"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"default":false,"description":"Whether this asset will appear as the diamond's hero asset. Hero assets appear at the top of the diamond details within the Tracr portal and on the Your Diamond page of the Diamond Experience. Hero assets can also appear in the gallery if one is specified. The position of a hero asset within the gallery is subject to subject to the configured gallery priority.","title":"Is Hero","type":"boolean"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Text that will appear as an overlay on the bottom right of the asset when it is displayed in a gallery.","title":"Label"},"updated_at":{"description":"The time at which this diamond asset was last updated. This field is not transferred. When the recipient of a transfer receives this asset, this field will be set to the time at which the transfer of the diamond completes.","format":"date-time","title":"Updated At","type":"string"}},"required":["diamond_id","id","created_at","updated_at","filename","extension","content_hash"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"DiamondDataRequest":{"description":"Represents data that has been requested for a diamond.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"data_request_type":{"$ref":"#/components/schemas/DiamondDataRequestType"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors"},"id":{"title":"Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondDataRequestStatus"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["id","status","data_request_type","created_at","updated_at"],"title":"DiamondDataRequest","type":"object"},"DiamondDataRequestType":{"enum":["three_d_plan"],"title":"DiamondDataRequestType","type":"string"},"DiamondDataRequestStatus":{"enum":["pending","success","error"],"title":"DiamondDataRequestStatus","type":"string"},"EntitySpecificTags":{"additionalProperties":true,"properties":{"dit_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dit Session Id"}},"title":"EntitySpecificTags","type":"object"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"crown_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Angle"},"crown_height":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}]},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"depth":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth"},"depth_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}]},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}]},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}]},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}]},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}]},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}]},"graded_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Graded Date"},"grader_certificate_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Clarity Characteristics"},"grader_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Colour"},"grader_inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Grader Inscription Numbers"},"grader_report_comments":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Comments"},"grader_report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Number"},"grader_report_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Report Type"},"grader_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grader Shape"},"grading_certificate_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Description"},"grading_certificate_filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Filename"},"grading_certificate_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grading Certificate Hash"},"grading_lab":{"anyOf":[{"$ref":"#/components/schemas/GradingLab"},{"type":"null"}]},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_selectable":{"title":"Is Selectable","type":"boolean"},"length":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Length"},"measurement_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement Text"},"pavillion_angle":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/GradedMeasurementSource"},"supplementary_files":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}]},"table_percent":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Table Percent"},"validation_level":{"anyOf":[{"$ref":"#/components/schemas/ValidationLevel"},{"type":"null"}]},"width":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"Colour":{"enum":["D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"title":"Colour","type":"string"},"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"},"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"},"FancyColour":{"enum":["BK","B","BN","CH","CM","CG","GY","G","O","P","PL","R","V","Y","W","X"],"title":"FancyColour","type":"string"},"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"},"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"},"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"},"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"},"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"},"GradingLab":{"description":"An Enum of grading lab values to be used when interacting with PCS-API.","enum":["AGS","CGL","DCLA","GCAL","GHI","GIA","GSI","HRD","IGI","IIDGR","IOD","NGTC","Other","PGS","RDC","RDR","SGL","VGR","SSEF"],"title":"GradingLab","type":"string"},"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"},"Shape":{"description":"An enum of the possible values for the shape of a diamond.","enum":["Asscher","Baguette","Briolette","Bullets","Calf","Cushion","Cushion Modified Brilliant","Emerald","European Cut","Flanders","Half Moon","Heart","Hexagonal","Kite","Lozenge","Marquise","Octagonal","Old Miner","Oval","Pear","Pentagonal","Princess","Radiant","Rectangle","Rose","Round","Shield","Square","Square Emerald","Square Radiant","Star","Tapered Baguette","Tapered Bullet","Trapezoid","Triangle","Trilliant","Other"],"title":"Shape","type":"string"},"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"},"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"DiamondV2Polished":{"description":"Polished attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"anyOf":[{"pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Carats"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}],"description":"Tracr Class: traceability"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}],"description":"Tracr Class: traceability"},"crown_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Angle"},"crown_height":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Crown Height"},"culet_condition":{"anyOf":[{"$ref":"#/components/schemas/CuletCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"culet_size":{"anyOf":[{"$ref":"#/components/schemas/CuletSize"},{"type":"null"}],"description":"Tracr Class: traceability"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}],"description":"Tracr Class: traceability"},"depth":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth"},"depth_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Depth Percent"},"diameter_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Maximum"},"diameter_minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Diameter Minimum"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_condition":{"anyOf":[{"$ref":"#/components/schemas/GirdleCondition"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_from":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"girdle_thickness_to":{"anyOf":[{"$ref":"#/components/schemas/GirdleThickness"},{"type":"null"}],"description":"Tracr Class: traceability"},"grading_certificates":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingCertificateRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Grading Certificates"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"length":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Length"},"pavillion_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Angle"},"pavillion_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Pavillion Percent"},"polish_quality":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}],"description":"Tracr Class: traceability"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"symmetry":{"anyOf":[{"$ref":"#/components/schemas/Symmetry"},{"type":"null"}],"description":"Tracr Class: traceability"},"table_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Table Percent"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"},"width":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Width"}},"title":"DiamondV2Polished","type":"object"},"GradingCertificateRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"graded_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of grading in ISO8601 format","title":"Graded Date"},"grader_certificate_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading Certificate Number","title":"Grader Certificate No"},"grader_inscription_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Inscription number on diamond","title":"Grader Inscription No"},"grader_report_no":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading report number","title":"Grader Report No"},"grading_lab":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Grading lab that provides grading report","title":"Grading Lab"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"GradingCertificateRef","type":"object"},"ImageRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_type":{"$ref":"#/components/schemas/ImageType","default":"default","description":"Image type"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"},"scan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the software used to create the report","title":"Scan Software Name"},"scan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of the software used to create the report","title":"Scan Software Version"}},"required":["hash"],"title":"ScanRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"}},"required":["hash"],"title":"FileRef","type":"object"},"ObjectiveVerificationData":{"properties":{"id":{"title":"Id","type":"string"},"source":{"$ref":"#/components/schemas/ObjectiveVerificationDataSource"},"status":{"$ref":"#/components/schemas/ObjectiveVerificationDataStatus"}},"required":["id","source","status"],"title":"ObjectiveVerificationData","type":"object"},"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"},"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondV2Provenance":{"additionalProperties":false,"description":"Provenance of a diamond as returned from the V2 API endpoints.\n
\n
\nAs of the 21st of May 2025 the diamond's provenance will be locked until the diamond is unlocked.\nSee the [provenance documentation](https://docs.tracr.com/docs/tracr-api/giigyxcp903fd-provenance) for more details.","properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166 alpha-2 Country code for the diamond.
Tracr class: supplementary","nullable":true,"title":"Country Code"},"is_country_code_available":{"description":"Defines whether a country code will be available in the provenance data when the provenance is unlocked. This is available if the provenance is locked or unlocked.","title":"Is Country Code Available","type":"boolean"},"is_locked":{"default":false,"description":"Defines whether the diamond's provenance is visible or locked.","title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of mine
Tracr class: traceability","nullable":true,"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Provenance can be a ISO 3166 alpha-2 Country code, Country name, or an Entity name
Tracr class: traceability","nullable":true,"title":"Provenance Name"},"provenance_type":{"anyOf":[{"pattern":"^(Country|Entity)$","type":"string"},{"type":"null"}],"description":"Define the type of data in the field 'provenance'
Tracr class: traceability","nullable":true,"title":"Provenance Type"}},"required":["is_country_code_available"],"title":"DiamondV2Provenance","type":"object"},"DiamondV2Rough":{"description":"Rough attributes of a diamond as returned from the V2 API endpoints.","properties":{"carats":{"description":"Tracr Class: traceability","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Carats","type":"string"},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: entity_specific","title":"Display Colour"},"fancy_colour":{"anyOf":[{"$ref":"#/components/schemas/FancyColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_intensity":{"anyOf":[{"$ref":"#/components/schemas/FancyColourIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"fancy_colour_overtone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Fancy Colour Overtone"},"fluorescence_colour":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceColour"},{"type":"null"}],"description":"Tracr Class: traceability"},"fluorescence_intensity":{"anyOf":[{"$ref":"#/components/schemas/FluorescenceIntensity"},{"type":"null"}],"description":"Tracr Class: traceability"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/ImageRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Images"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Model"},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"plan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/PlanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Plan Reports"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Quality"},"scan":{"anyOf":[{"$ref":"#/components/schemas/ScanRef"},{"type":"null"}],"description":"Tracr Class: traceability"},"scan_reports":{"anyOf":[{"items":{"$ref":"#/components/schemas/ScanRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Scan Reports"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Stress"},"supplementary_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: supplementary","title":"Supplementary Files"},"videos":{"anyOf":[{"items":{"$ref":"#/components/schemas/FileRef"},"type":"array"},{"type":"null"}],"description":"Tracr Class: traceability","title":"Videos"}},"required":["carats"],"title":"DiamondV2Rough","type":"object"},"PlanRef":{"additionalProperties":false,"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the file","title":"Description"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The original filename submitted for the file","title":"Filename"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"plan_software_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software company name","title":"Plan Software Manufacturer"},"plan_software_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software name","title":"Plan Software Name"},"plan_software_version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Software version","title":"Plan Software Version"},"scan_device_manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer of the device eg. Sarine, Octonus","title":"Scan Device Manufacturer"},"scan_device_model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Model of the machine eg. Diaexpert, Galaxy, Helium Rough","title":"Scan Device Model"}},"required":["hash"],"title":"PlanRef","type":"object"},"DiamondUnlockStatus":{"description":"Represents the unlock status of a diamond, as returned by the API.","enum":["locked","unlocked","not_eligible_for_unlock"],"title":"DiamondUnlockStatus","type":"string"},"VerificationStatus":{"description":"A representation of whether or not diamond verification succeed.\n\n- Pending: The request has not yet been processed by Diamond ID.\n- Verified: The diamond has successfully been verified by Diamond ID.\n- Invalid: A business logic error occurred, such as GIS attempting to verify\n a diamond a second time when it was successfully verified before\n- Error: A validation error has occurred, such as missing diamond_parent_id,\n missing features etc.\n- Unverifiable: A verification error occurred (such as the values were\n outside tolerance) and appropriate feedback was returned.","enum":["Pending","Unverifiable","Verified","Duplicate","Invalid","Error"],"title":"VerificationStatus","type":"string"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tracr.com/api-reference/tracr-api/references/diamonds.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.