> This is part 1 of 2 of the full documentation (pages 1–100 of 115). > The content is paginated: fetch every part to see all of it. > Next part: https://docs.tracr.com/llms-full.txt/1 > Page index: https://docs.tracr.com/llms.txt # 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 This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.tracr.com/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. --- # Whats New? Here's what's new in Tracr. ### Editing Assets (1.35) Users now have much more control over which are assets are displayed in the galleries associated with an individual diamond. You can add and remove images to the rough and split galleries of polished diamonds, and you can have multiple images of the same type. See the [full documentation](/tracr-user-guide/12.-editing-assets). ### Fancy Colours extended to GIA list (1.35) We initially launched with a subset of fancy colours in 1.33. We have extended that list to support the full GIA coloured diamonds list. | GIA Fancy Colour | Tracr FancyColour enum value | | ---------------- | ---------------------------- | | Blue-Gray | B\_GY | | Blue-Green | B\_G | | Brown-Orange | BN\_O | | Brown-Pink | BN\_P | | Brown-Purple | BN\_PL | | Brown-Red | BN\_R | | Brown-Yellow | BN\_Y | | Gray-Blue | GY\_B | | Gray-Green | GY\_G | | Gray-Purple | GY\_PL | | Gray-Violet | GY\_V | | Green-Blue | G\_B | | Green-Gray | G\_GY | | Green-Yellow | G\_Y | | Orange-Brown | O\_BN | | Orange-Yellow | O\_Y | | Pink-Brown | P\_BN | | Pink-Purple | P\_PL | | Purple-Red | PL\_R | | Purple-Brown | PL\_BN | | Purple-Gray | PL\_GY | | Purple-Pink | PL\_P | | Red-Brown | R\_BN | | Red-Purple | R\_PL | | Violet-Gray | V\_GY | | Yellow-Brown | Y\_BN | | Yellow-Gray | Y\_GY | | Yellow-Green | Y\_G | | Yellow-Orange | Y\_O | ### Shipments Improvements (1.34.0) We've made some improvements to the Shipments interfaces, both inbound and outbound. On the inbound shipments you can now select multiple rough shipments and accept any that are awaiting acceptance in bulk. This process uses the same slide out drawer control used in other places such as transfer, share and unlock. We've also begun to split the shipments into multiple views to separate the active shipments and the archived shipments. Over time we will continue to separate out the views and make further improvements to the shipments flows. ### Locked Diamond Page (1.34.0) We have made an update to the Tracr platform designed to improve the user journey for all diamonds that are registered as polished on Tracr but currently in a "locked" state. Previously, searching for a locked diamond resulted in a "not found" page. We are replacing this with a new, informative landing page. Users will now be greeted by a page that clearly explains the diamond’s locked status and showcases the value of Tracr’s provenance and verification capabilities. Find out more [here](#locked-diamond-page). ### Fancy Colours (1.33.0) We have made an update to the Tracr platform to improve the way users upload fancy coloured diamonds and how they show up in the platform and search interfaces. ### Lab Eligibile (1.32.0) We have made an update to the platform to help users work out if their diamonds are eligible for grading through a 3rd party grading lab. If the diamond is not eligible, the user will be informed with a reason, and a recommended action. This information will also be available to the 3rd party labs so both parties have the information required to move a diamond through the grading process. ### Update box/shipment information (1.28.0) You can now edit the details of the container (box, shipment) that a rough diamond is registered against in Tracr. If you accidentally register a diamond against the incorrect box or shipment, you can now correct this without having to contact support. These values can be edited using the Tracr API. If you change the box or shipment details then Tracr will automatically invalidate any Rough Check matches against the updated diamond and will perform a new match using the updated details. *** ### Transfer from Inventory (1.27.0) The Transfer from Inventory feature provides a fast and structured way to move diamonds from your available inventory to recipients. This process eliminates the need for manual CSV exports and imports by allowing you to handle transfers directly within the platform. More details [here](/tracr-help-pages/shipments/shipments-outbound-transfer-from-inventory) ### Lab Eligibility (1.27.0) Tracr has been working on integrations with trusted grading labs which will allow you to submit a diamond to a grading lab with a Tracr ID to link your grading report to the Tracr digital record. > There is also the option with some labs (GIA, IoD) to add your Tracr provenance to the grading report. This requires a diamond to be unlocked. A diamond needs to have a few requirements met to be eligible for grading through one of our integrations. These include: being a polished diamond and having a supported scan report that Tracr can process. We have extended the Portal and Tracr API to provide you with the LAB ELIGIBLE status and the breakdown of the eligibility requirements. *** ### Changes to provenance information display (1.26.0) Tracr remains dedicated to driving industry success and transparency across the diamond supply chain. To support the continued growth of our platform and secure its long-term business viability, we have introduced an important update to how provenance information is managed. Provenance information is not available until the diamond is polished and unlocked. ### Update Participant ID / ERP ID / Stock ID For any Tracr diamond, you can now update the Participant ID by changing the Stock ID value in your Sarine software and that update will flow through to the diamond record in Tracr. It’s also possible to update the Participant ID against a diamond in Tracr using the API. Documentation for that is [here](https://docs.tracr.com/docs/tracr-api/202db28925f02-update-rough-diamond) *** ## Inventory #### Rough and Split Diamonds For rough and split diamonds, your diamond will have one of two new values for **Provenance**: single provenance or mixed provenance.

New values for Provenance

#### Polished Diamonds For polished diamonds, you will need to unlock a diamond to see the provenance information. If your diamond is locked, your diamond will have one of two new values for **Provenance**: single provenance or mixed provenance. If your diamond is unlocked, your diamond will have a mixed provenance or the country of origin. > Note: **DTC** is an example of a mixed provenance, and will be available on unlock.

Example of polished inventory with differing provenance information

### Participant Search and Share #### Rough and Split Diamonds For rough and split diamonds, your diamond will have one of two new values for **Provenance**: single provenance or mixed provenance.

Example of a rough diamond with single provenance.

#### Polished Diamonds If your diamond is locked, it will **not** be available in Participant Search and Share. If your diamond is unlocked, your diamond will have a mixed provenance or the country of origin.

Example of a polished, unlocked diamond witgh a single provenance: Botswana.

### Tracr API and Tracr Search API Where provenance is returned in the Tracr API and Tracr Search API, the following changes will come into effect. #### Mixed Provenance {% tabs %} {% tab title="New - Rough, Split & Polished Locked" %} ```json { ... "provenance": { "is_country_code_available": false, "is_locked": true, "provenance_name": "", "provenance_type": "Entity" } } ``` {% endtab %} {% tab title="New - Polished Unlocked" %} ```json { ... "provenance": { "is_country_code_available": false, "is_locked": false, "provenance_name": "DTC", "provenance_type": "Entity" } } ``` {% endtab %} {% tab title="Previous" %} ```json { ... "provenance": { "is_country_code_available": false, "is_locked": false, "provenance_name": "DTC", "provenance_type": "Entity" } } ``` {% endtab %} {% endtabs %} #### Single Provenance {% tabs %} {% tab title="New - Rough, Split & Polished Locked" %} ```json { ... "provenance": { "is_country_code_available": true, "is_locked": true, "provenance_name": "", "provenance_type": "Country" } } ``` {% endtab %} {% tab title="New - Polished Unlocked" %} ```json { ... "provenance": { "is_country_code_available": true, "country_code": "BW", "is_locked": false, "provenance_name": "BW", "provenance_type": "Country" } } ``` {% endtab %} {% tab title="Previous" %} ```json { ... "provenance": { "is_country_code_available": true, "country_code": "BW", "is_locked": false, "provenance_name": "BW", "provenance_type": "Country" } } ``` {% endtab %} {% endtabs %} *** ## Table Improvements (version 1.24.0) Tracr has improved our interface to enable better user experience. The first step is the inventory table. There is an updated look and feel, as well as improvements including: * Ability to copy fields * Reordering columns * Pagination * Improved column resizing *** ## Search by Report/Inscription Number (version 1.24.0) This version of Tracr introduces the ability to search using grading report numbers and inscription numbers across the Tracr Inventory, Participant Search, and Diamond Experience. *** ## Archive and unarchive diamonds in your inventory (version 1.23.0) This version of Tracr introduces the ability to separate your inventory into **Active** and **Archived** sections.

Active and Archived sections.

If you sell a diamond or remove it from the Tracr process, you can archive the diamond so that it is no longer appears in your **Active** inventory but instead appears in your **Archived** inventory. If you later withdraw a diamond for sale, or the buyer of the diamond becomes a Tracr participant and you want to transfer the digital asset to them, you can unarchive the diamond so that it moves back to your **Active** inventory. On the **Archived** tab you can only view or unarchive a diamond. You cannot edit, share, or unlock an archived diamond.

View or unarchive an archived diamond

*** ## Transferring status (version 1.23.0) This version of Tracr introduces a new status, **Transferring**, to help users know which diamonds are available to archive. Diamonds in an active Transfer have the status **Transferring**. > Note: **Transferring** status can be displayed for rough, split and polished diamonds. *** ## Shipments outbound and inbound (version 1.15.0) This version of Tracr introduces a change to the transfer process. A non-De Beers producer can now register rough diamonds on the Tracr platform. Once registered, the producer can create a shipment of rough diamonds and send that shipment to a manufacturer using the shipment outbound workflow. Accepting the inbound shipment allows the manufacturer to load diamonds using the Integration Tool against that shipment up to the bounds of the shipment (count, total carats, carat range). *** ## Rough Check (version 1.14.0) This version of Tracr includes the addition of Rough Check in the Portal. Rough Check is a check against a rough diamond uploaded by the producer and the rough diamond a manufacturer uploads. This check is performed using Diamond ID, a core service in the Tracr platform ecosystem primarily tasked with validating, verifying, and identifying diamonds. You will be able to see a Rough Check against your diamond in your Rough Inventory and on the Diamond Details page.

Rough Check in the Rough Inventory.

## Changes to transfer in (version 1.13.0) In this version of Tracr, the 'transfer in' workflow has been simplified and inscription numbers no longer need to be provided when accepting transfers of polished diamonds. In the following image, the recipient has accepted five diamonds, rejected three diamonds, the sender has cancelled one diamond, and one diamond is available for transfer. The **Accept** and **Reject** buttons allow this diamond to be accepted (without the need to upload a CSV file containing Tracr IDs and inscription numbers) or rejected.

Accepting ownership of diamonds.

*** ## Diamond unlocking (version 1.10.0) From 1st January 2024, all new polished diamonds added to Tracr will be automatically locked. To share or transfer a locked diamond, the owner must first unlock the diamond. Participants can unlock one or more locked diamonds from their inventory or from the Diamond Details page. {% hint style="warning" %} To make sure that stones that are unlocked are accessible for future use, you will not be able to delete an unlocked stone. Please make sure you are happy with the stone you are unlocking and that it has all the necessary assets. {% endhint %} The following video shows you how to unlock a diamond from your inventory. {% embed url="" %} # Coming Soon ## Q4 2026 ### QR Codes We understand that sometimes a Tracr ID or URL to a diamond experience can be lengthy, so are currently building the functionality to generate QR codes for a singular diamond. User will have the option to generate these with a branded Tracr logo, or without. They will also have the option to download them as an SVG or PNG. ### Unlock Reporting in Portal We've taken your feedback and recognise that receiving an unitemised invoice can be confusing. We are not able to fully support an itemised invoice at the minute, but we are currently building a tool within the portal to allow you to see all the diamonds you unlock. You will be able to filter on this report to match it with your invoice, allowing you to perform a reconciliation. # 1. Introduction Read this section to learn more about TracrTM, how to log in to the Tracr Management Portal, and what to do before you begin registering your diamonds on Tracr. ## What is Tracr? Tracr is an advanced technology platform developed by De Beers Group to underpin trust in diamond provenance. Using leading-edge technologies, including blockchain, artificial intelligence, the internet of things and advanced security and privacy technologies, Tracr enables confidence in a diamond's source throughout the diamond value chain. The Tracr platform combines distributed ledger technology with advanced data security and privacy, ensuring that participants control the use of and access to their own data. Each participant on Tracr has their own distributed version of the platform, meaning that their data can only be shared with their permission, and only they choose who can access their information. The advanced privacy technologies used by Tracr reinforce data security on the platform. The immutable nature of each transaction on the platform ensures that the data cannot be tampered with when the diamond progresses through the value chain. The decentralised nature of the platform ensures its speed and scalability, with the ability to register one million diamonds a week onto the platform. With centralised platforms, dealing with large volumes of data can cause bottlenecks, but the decentralised model used by Tracr avoids such issues and enables rapid scaling. The scalability, speed, and security of Tracr are combined into an intuitive user experience to support ease of use for platform participants. ## Log in to Tracr The Tracr Support team will provide you with an introduction to the process, requirements, and a demonstration of the Tracr Management Portal. Tracr will also create and provide you with access details to your test (UAT) instance of the Tracr Management Portal which is fully functional and can be used to test your production data files. {% hint style="warning" %} Please be aware that Tracr only accepts sight boxes invoiced by De Beers. {% endhint %} To begin, log in to Tracr: {% stepper %} {% step %} ### Go to the Tracr URL Go to the Tracr URL you have received by email from the Tracr Support team. {% endstep %} {% step %} ### Accept terms Read the terms and conditions and privacy policy, then select the checkbox to accept. {% endstep %} {% step %} ### Select login method Select **Login with JumpCloud**. {% endstep %} {% step %} ### Enter credentials Enter your JumpCloud credentials, set up during the onboarding to Tracr, and select **Login**. {% endstep %} {% endstepper %} You should now complete the preliminary activities before you upload your diamond data to Tracr. ## Preliminary activities Before you start registering your diamonds, you should: * Ensure that your sight box is eligible for Tracr. Every eligible De Beers sight box has a Tracr sticker on it. If the Tracr sticker is missing, please contact your De Beers Key Account Manager. * Download and install the appropriate scanner template to export the reports that Tracr needs. Tracr supports scanners from vendors including Sarine (Advisor/Instructor) and Octonus (Helium).\ To get the required scanner template, go to **Tracr Management Portal > Integration > Integration Tool > Integration toolkit** * Download CSV templates for integrating diamond data.\ To download rough, split, and polished Tracr templates, go to **Tracr Management Portal > Integration > Integration Tool > Integration toolkit** * Review the Data Dictionary, which gives a comprehensive overview of all data points required for uploading data for a diamond, at any stage of its lifecycle.\ To download the Data Dictionary, go to **Tracr Management Portal > Integration > Integration Tool > Integration toolkit** ## Your diamond data To register diamonds on Tracr, you must upload the required data through the Tracr Management Portal or using the Tracr Loader. You should upload data whenever a diamond changes form, this includes windowing and when unexpected incidents happen during the manufacturing process. You can also upload optional files like images and videos to enhance your Diamond Experience. ### Tracr data requirements for traceability #### Rough to polished

Data requirements for rough to polished diamonds.

#### Rough to split to polished

Data requirements for rough to split to polished diamonds.

# 2. Quickstart {% stepper %} {% step %} ### Log in to the Tracr platform To begin, log in to Tracr. * Go to the Tracr URL you have received by email from the Tracr Support team. * Read the terms and conditions and privacy policy, then select the checkbox to accept. * Select **Login with JumpCloud**. * Enter your JumpCloud credentials, set up during the onboarding to Tracr, and select **Login**. You can now upload your diamond data to Tracr. {% endstep %} {% step %} ### Prepare your diamond data To register and track diamonds on Tracr, you must upload a CSV file containing the required data, and optional data such as images and videos, whenever the diamond changes form. #### Scanner and CSV templates You should install the appropriate Tracr scanner template to export the reports that Tracr requires. You should also download CSV templates to help you create CSV files containing diamond data in the correct format. Scanner templates, CSV templates, and supporting documentation are part of the Integration toolkit. * From the Tracr menu, select **Integration > Integration Tool**. * Select the **Integration toolkit** button. * Select **Download toolkit** to download the complete integration toolkit or choose the components that you want to download. #### Data Dictionary Review the Data Dictionary, which gives a comprehensive overview of all data points required for uploading data for a diamond, at any stage of its lifecycle. The Data Dictionary is part of the Integration toolkit. {% endstep %} {% step %} ### Upload your diamond data to Tracr Before you start, prepare a CSV file containing your diamond data. Please note that Tracr only accepts sight boxes invoiced by De Beers and certain other producers. #### Select the CSV file to upload To ensure your CSV file is valid and contains the required information, please use one of the CSV templates. * From the Tracr menu, select **Integration > Integration Tool**. * On the **Session history** page, select the **New session** button. * Either drag and drop your prepared CSV file onto the **Upload CSV file** page or select the **Or, select from device** button to browse for and select the file that you want to upload. #### CSV validation Once uploaded, Tracr validates your CSV file. * If the file is valid, Tracr asks you to confirm the integration type. * Select your integration type. It is important that the type you select matches the type defined in your CSV file. If not, the next validation step will fail, and you will get an error. * Select **Continue**. #### What happens next? Tracr validates the selected file to ensure that it matches the integration type that you selected. If validation is successful, Tracr displays the **Required files** page with the **Session overview** tab selected. You must now upload all the files listed in the CSV file before you can complete the upload. #### What to do if your CSV file fails validation If validation fails, Tracr displays the **Upload failed** page. You should review the error text and make the appropriate changes to your CSV file or ensure that you select the correct integration type during the upload process. Select **Quit** and create a new session to continue. {% endstep %} {% step %} ### Upload the required files to Tracr Your CSV file lists the files to associate with each diamond. You need to upload these files before you can submit the session. #### Select the files to upload Before you start, ensure that you have access to all the files associated with your CSV file. You will find a list of the files that Tracr is expecting on the **Missing files** tab. * Either drag and drop the required files onto the **Session overview** tab or select the **Or, select from device** button to browse for and select the files that you want to upload to Tracr.\ As Tracr accepts the files, you will see a green tick appear under the appropriate file type on the **Session overview** tab. An orange exclamation mark indicates a file is missing. A red exclamation mark indicates that the file has failed validation.\ You will not be able to complete your session if there are any missing or failed files. #### Submit the session When all files are uploaded, look for the message ‘Ready to submit. All required files have been accepted and uploaded for this session, submit to continue.’ in the top right corner. * Select the **Submit session** button.\ Tracr displays a summary of the number of diamonds that you are submitting and the number that you have excluded from the upload. * Select **Submit** to complete the upload and submit the session for matching and verification. * On the confirmation page, either select **View in history** to display the submitted session on the **Session history** page or **Download report** to download a report of the completed session. #### What happens next? Tracr processes the session, which appears on the **Session history** page with the status ‘Submitted’. #### What to do if Tracr does not accept a file Tracr validates each file as it is uploaded. If a file fails validation, it is listed on the **Failed files** tab. You should review the details to understand why Tracr did not accept the file. To save the session and continue later when you have the correct file, select the **Quit** button, choose **Save and quit**, and then select **Quit**. The session appears on the **Session history** page with the status ‘In progress’. {% endstep %} {% step %} ### View the processing status of your upload Monitoring is part of the data integration process, and it allows you to monitor the verification status of the diamonds you have uploaded to Tracr. #### Check the verification status of your diamonds * From the Tracr menu, select **Integration > Monitoring**.\ Tracr displays the status of all the diamonds that you have uploaded. * Use the filters at the top of the **Integration monitoring** page to locate your session. #### Status Tracr displays the status of an integration as either ‘Registered’ or ‘Error’. * **Registered** – The diamond is verified and on the Tracr Portal. You can find the diamond in your inventory. * **Invalid** – An error has occurred, and Tracr did not register the diamond. Check the entry in the **Details** column to understand the error. #### What do the error messages mean? If the status is ‘Invalid’, the **Details** column displays the reason Tracr did not verify the diamond. Common errors include: * **Child diamond cannot be heavier than its parent** – The parent diamond carat weight is less than the subject diamond. * **No boxes found** – The box ID in the CSV used to upload a rough diamond has not been found for the sight year and number provided. * **Too many carats** – The total carat weight does not match the expected carat weight as registered against the box by De Beers. * **Too many diamonds** – You are trying to register more diamonds than De Beers assigned to the box. * **Diamond is not unique** – The same diamond ID already exists on Tracr. * **Could not find existing diamond or parent (parent id xxxxxx) for yyyyyy** – You cannot register a split or polish or perform an update because the existing or parent diamond is not registered on Tracr. For more help on these and other error messages that you may see in the **Details** column, please contact {% endstep %} {% step %} ### Review your diamond inventory Once a diamond is registered and assigned a Tracr ID, it appears in your inventory. #### View diamonds in your inventory There are separate diamond inventories for the various lifecycle states: Rough, Split, Polished, and Graded. * From the Tracr menu, select **Inventory > Rough / Split / Polished / Graded**.\ Tracr displays diamonds in the selected inventory. * Use the filters at the top of the **Inventory** page to find diamonds in your inventory. Different filters are available depending on the lifecycle state of the diamond. #### You need to know Tracr automatically manages your inventory, which means that every time you integrate diamonds, and they pass the control process, your inventory is updated. For example, if you have diamonds in your rough inventory and then upload polished data, Tracr automatically moves the diamonds from your rough inventory to your polished inventory. {% endstep %} {% step %} ### View a diamond’s journey (Diamond Details) The Diamond Details page is a visual representation of a diamond's journey through its lifecycle, and it is available for all diamonds in your inventory. #### View the Diamond Details for a diamond You can view the Diamond Details page for a single diamond or multiple diamonds in your inventory. * From the menu, select **Inventory > Rough / Split / Polished / Graded**.\ Tracr displays diamonds in the selected inventory. * Select the checkbox next to the diamond(s) that you want to view. * At the bottom of the page, select **View**.\ Tracr displays the **Diamond Details** for the selected diamond. If you selected multiple diamonds, use the next and previous arrows to display the Diamond Details page for each diamond. #### What does the Diamond Details show? For each diamond, the Diamond Details page displays a photograph of the latest stage of the diamond (if provided), basic information (provenance, carat, shape, colour), and the Tracr ID. Also shown is a summary of the diamond’s stages (Rough > Split (latest version) > Polished) followed by photographs/videos and more details about each stage. You can also view stage-specific details, scan reports, and grading certificates (if provided). {% endstep %} {% step %} ### Share diamond data You can use Tracr to share the details of one or more diamonds with an external party. #### Share diamond data by email You can share diamond(s) from your inventory or from the Diamond Details page. * From inventory: * Open the inventory containing the diamond(s) that you want to share. * Select the diamonds that you want to share and, at the bottom of the page, select **Share**. * From the Diamond Details page: * Display the Diamond Details page for the diamond(s) that you want to share. * Select the **Share** button. * On the **Share** page, check the preview to ensure you are sharing the correct diamond(s). * If you do not want to share a selected diamond, select the diamond in the diamonds selected to share section, and then select **Remove**. * Provide the following information: * **To** – Enter the email address of each recipient, separated by a comma or space. * **Subject** – Enter the subject of the email. * **Message** – Enter a message to the recipient(s). * Select **Send**.\ Recipients receive an email containing a link to view the diamond(s) that you shared. Note that the link is active for seven days. {% endstep %} {% endstepper %} # 3. Inventory Read this section to learn more about your Tracr inventory, how to view the Diamond Details page, and how to share the details of one or more diamonds with an external party. ## Overview Once a diamond is uploaded using the Integration Tool or Tracr Loader and has been registered and assigned a Tracr ID, it appears in your inventory. Diamonds will also appear in your inventory when you confirm ownership of a diamond transfer. The diamonds in your inventory are distributed by lifecycle state. Access each diamond lifecycle state from the Tracr menu under **Inventory**: * **Rough** – Includes only rough diamonds. * **Split** – Includes split and any other intermediary steps before the diamond is polished. * **Polished** – Includes only polished diamonds. * **Graded** – Includes only graded diamonds (polished diamonds with a grading certificate). You can upload a grading certificate (as a PDF file) either during upload of polished data or by updating a polished diamond that you have already uploaded. > **Note:** Tracr automatically manages your inventory, which means that every time you integrate (add) diamonds, and they pass the control process, your inventory is updated.\ > For example, if you have diamonds in your rough inventory and then upload polished data, Tracr automatically moves the diamonds from your rough inventory to your polished inventory. ## View your inventory There are separate diamond inventories for the various lifecycle states: Rough, Split, Polished, and Graded. Within each inventory, diamonds will either be active (listed on the **Active** tab) or archived (listed on the **Archived** tab). {% stepper %} {% step %} ### To view diamonds in your Tracr inventory * From the Tracr menu, select **Inventory > Rough / Split / Polished / Graded**.\ Tracr displays diamonds in the selected inventory in a tabular format. {% endstep %} {% step %} * Use the filters at the top of the **Inventory** page to find diamonds in your inventory.\ Different filters are available depending on the lifecycle state of the diamond. {% endstep %} {% step %} * To sort your inventory in ascending or descending order, select a column heading.\ Any sorting that you apply persists when you move between your inventory and diamond details. {% endstep %} {% endstepper %} ## Filter your inventory Use filters to find diamonds of interest in your inventory.

Rough inventory filters.

Note that any filters you apply persist when you move between your inventory and diamond details. ### Filter by ID You can now search for multiple diamonds at the same time using our new multi value search. Type or paste a list of values into the search box and all values will be searched for simultaneously. Values must be separated by a comma or a semi-colon. Once you've entered all the values you want to search for, click the search icon, or press enter to perform the search. The `Tracr ID`, `Participant ID`, `Box ID`, `Grading Inscription Number`, and `Grading Report Number` fields will be searched for all the values you've entered. Any diamond which has a field that matches any of the search terms **exactly** will be returned. The search is **case sensitive**. This enhancement is designed to provide greater flexibility and efficiency in your search process. Now multiple diamonds can be searched for and operated on, as the start of a shipment creation process for example.
### Filter using date or physical characteristics You can filter your inventory using a set of default filters: * **Rough and Split Inventory** – Filter by date (using the participant\_timestamp in the uploaded CSV file), carats, colour, model, and/or quality. A Rough Check filter is available if one or more diamonds has a Rough Check, which indicates that a scan was uploaded (by the manufacturer) with the diamond, which Tracr has checked and matched against the producer's scan of that diamond. * **Polished and Graded Inventory** – Filter by date (using the participant\_timestamp in the uploaded CSV file), status, carats, clarity, colour, cut, polish, and/or shape. A Rough Check filter is available if one or more diamonds has a Rough Check, which indicates that a scan was uploaded (by the manufacturer) with the diamond, which Tracr has checked and matched against the producer's scan of that diamond. To filter by date: * Select **Last updated**, choose the date from the calendar, and select **Apply**.\ Tracr only displays diamonds matching the selected date. To filter by physical characteristics or status: * Select the filter, select the filter value(s) that you want to use, and select **Apply**.\ Tracr only displays diamonds matching the selected filter conditions. ### Filter using additional filters To apply additional filters: {% stepper %} {% step %} 1. Select **More filters**. {% endstep %} {% step %} 2\. Choose the filter criteria that you want to apply. To set a range, either move the green indicators to the appropriate positions or select an indicator and then use the left and right arrows on your keyboard to set the value you require. Tracr displays the number of diamonds that match your filter criteria in the bottom right of the **More filters** window. {% endstep %} {% step %} 3\. If you make a mistake, either clear a filter checkbox or select **Clear all**. This also resets all ranges to their default values. {% endstep %} {% step %} 4\. To view your filtered inventory, select **View Diamonds**. {% endstep %} {% endstepper %} ### Clear all filters To clear all filters and redisplay all diamonds in your inventory: * Select **Clear filters**. ## Columns By default, your inventory displays a standard set of columns. You can customise the display and add additional columns to view more information, as required. > **Note:** Tracr remembers your column selections for each lifecycle state when you sign out. {% stepper %} {% step %} ### To display additional columns 1. Select **Columns**. 2. Choose the columns that you want to display. 3. Select **Apply**. {% endstep %} {% step %} ### To remove additional columns 1. Select **Columns**. 2. Clear the checkbox next to any columns that you do not want to display. 3. Select **Apply**. {% endstep %} {% step %} ### To reset the columns to default 1. Select **Columns**. 2. Select **Restore columns to default**. {% endstep %} {% endstepper %} ### Default columns for rough/split inventory Default columns when viewing your rough or split inventory are as follows. Filters are available for columns marked with \*. * **Selection checkbox** – To view or share one or more diamonds, select each checkbox, and then select **View** or **Share** at the bottom of the page. * **Carat**\* – The physical weight of the diamond. * **Colour**\* – The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). To filter your inventory using fancy colours, select the **More filters** button and choose the colours that you want to include. * **Last updated**\* – The timestamp from the CSV file. * **Model**\* – The physical structure (shape) of the diamond which dictates how it is processed. For example, sawable, makeable, or cleavage. * **Provenance** – The diamond’s region or country of origin. This will typically be DTC, which sources diamonds in Botswana, Canada, Namibia, and South Africa. If available, Tracr displays the single country of origin of the diamond. * **Quality**\* – The quality of the diamond, which dictates whether it is used for jewellery or for industrial processes. * **Rough Check** – A tick in this column indicates that a scan was uploaded (by the manufacturer) with the diamond, which Tracr has checked and matched against the producer's scan of that diamond. * **Status** – The status of the diamond. If the staus is 'Transferring' you cannot archive the diamond. * **Actions** – Select the ellipsis to access the following options: * **View** – Display the Diamond Details page for the selected diamond. * **Share** – Share details of the selected diamond with a third party by email. A link in the email allows the recipient to display the Diamond Details page. * **Archive/Unarchive** – Archive (from the **Active** tab) or unarchive (from the **Archived** tab) a diamond. ### Default columns for polished / graded inventory Default columns when viewing your polished or graded inventory are as follows. Filters are available for columns marked with \*. * **Selection checkbox** – To view or share one or more diamonds, select each checkbox, and then select **View** or **Share** at the bottom of the page. * **Carat**\* – The physical weight of the diamond. * **Clarity**\* – The clarity of the diamond, ranging from ‘FL’ (flawless) to ‘P3’ (poor quality). Clarity grades define the quantity, size, and location of inclusions in a diamond. * **Colour**\* – The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). To filter your inventory using fancy colours, select the **More filters** button and choose the colours that you want to include. * **Last updated**\* – The timestamp from the CSV file. * **Provenance** – The diamond’s region or country of origin. This will typically be DTC, which sources diamonds in Botswana, Canada, Namibia, and South Africa. If available, Tracr displays the single country of origin of the diamond. * **Rough Check** – A tick in this column indicates that a scan was uploaded (by the manufacturer) with the diamond, which Tracr has checked and matched against the producer's scan of that diamond. * **Shape**\* – The shape of the diamond. * **Status**\* – The status of the diamond. If the status is 'Locked', you must unlock the diamond before it can be shared or transferred. If the staus is 'Transferring' you cannot archive the diamond. * **Actions** – Select the ellipsis to access the following options: * **View** – Display the Diamond Details page for the selected diamond. * **Share** – Share details of the selected diamond with a third party by email. A link in the email allows the recipient to display the Diamond Details page. * **Unlock** – Unlock a polished or graded diamond so that it can be shared or transferred. Note that when you unlock a diamond you will incur an unlocking fee. * **Archive/Unarchive** – Archive (from the **Active** tab) or unarchive (from the **Archived** tab) a diamond. ## Export your inventory You can export your inventory as a report (xlsx file). When you do this, you can choose to export all diamonds in the selected inventory or apply filters to only export diamonds of interest. {% stepper %} {% step %} 1. Select the inventory that you want to export. {% endstep %} {% step %} 2\. Choose the columns that you want to appear on the report. {% endstep %} {% step %} 3\. If you want to export only diamonds of interest in your inventory, apply the required filters. {% endstep %} {% step %} 4\. Then do one of the following: * To export all diamonds in the inventory, select **Export inventory** and then select **Export all**. * To export filtered diamonds only, select **Export inventory** and then select **Export filtered**. {% endstep %} {% step %} 5\. Tracr generates the report which is downloaded and saved in your default downloads folder. {% endstep %} {% endstepper %} ## View a diamond’s journey (Diamond Details) The Diamond Details page is a visual representation of a diamond's journey through its lifecycle, and it is available for all diamonds in your inventory. Every time you upload a new session, and the diamonds pass the control process, Tracr adds these diamonds to your inventory and generates the Diamond Details page for each one. If you update diamonds in your inventory, Tracr automatically updates the Diamond Details page. For each diamond, the Diamond Details page displays a photograph of the latest stage of the diamond (if provided), basic information (provenance, carat, shape, colour), and the Tracr ID.

Diamond Experience exmple

Also shown is a summary of the diamond’s stages (Rough > Split (latest version) > Polished) followed by photographs/videos and more details about each stage. You can also view stage-specific details, scan reports, and grading certificates (if provided). To open the Diamond Details page for a diamond, do one of the following: * Select the row in the table corresponding to the diamond that you want to view. * In the **Actions** column, select the ellipsis, and then select **View**. To view more than one diamond: * Select the checkbox next to all the diamonds that you want to view (maximum 40 diamonds). At the bottom of the page, select **View**. ### View a grading report You can view the grading report for any graded diamond in your polished or graded inventory by opening the Diamond Details page for that diamond. To view a grading report: {% stepper %} {% step %} 1. Display the Diamond Details page for a graded diamond. {% endstep %} {% step %} 2\. Select **VIEW GRADING REPORT**. The grading report opens in another tab. {% endstep %} {% endstepper %} ## Share your diamond data Tracr allows you to send the details of one or more diamonds to an external party. You can share one or more diamonds from your inventory or from the Diamond Details page. > **Note:** You can only share a diamond if it is unlocked. {% stepper %} {% step %} 1. Select the diamonds that you want to share. * **Inventory** – Select the checkbox next to the diamond(s) that you want to share and, at the bottom of the page, select **Share**. * **Diamond Details** – Display the Diamond Details page for the diamond(s) that you want to share and select the **Share** button. {% endstep %} {% step %} 2\. If any of the selected diamonds are locked, you can either continue without sharing locked diamonds (select the **Continue without locked diamonds** button) or unlock the locked diamonds. To unlock: * Check that you have selected the correct diamond(s) to unlock. * To keep a diamond locked, select **Remove from list** next to the diamond(s) that you want to keep locked. Alternatively, clear the checkbox next any diamonds that you do not want to unlock and select **Remove unselected diamonds from list**. * Select **Unlock selected diamonds**. If you have only one diamond selected, select **Unlock selected diamond** or select **Cancel** to keep the diamond locked. {% endstep %} {% step %} 3\. When all diamonds are unlocked, Tracr displays the **Share** page which shows a preview of the diamond(s) that you want to share on the left and an email form on the right. Check each preview to ensure you are sharing the correct diamond(s). {% endstep %} {% step %} 4\. If you do not want to share a selected diamond, select the diamond in the diamonds selected to share section, and then select **Remove**. {% endstep %} {% step %} 5\. Provide the following information: * **To** – Enter the email address of each recipient, separated by a comma or space. * **Subject** – Enter the subject of the email. * **Message** – Enter a message to the recipient(s). {% endstep %} {% step %} 6\. Select **Send**.\ Recipients receive an email containing a link to view the diamond(s) that you shared. Note that the link is active for seven days. {% endstep %} {% endstepper %}

Sharing diamond data.

## Rough Check All Tracr inventory screens display a **Rough Check** column.\ A green tick in that column indicates that a scan was uploaded to Tracr by the manufacturer with the diamond, which Tracr has checked and matched against the producer's scan of that diamond before it was transferred to the manufacturer. Rough Check status is carried downstream from the original rough diamond to later diamond lifecycle states. > For more information about Rough Check, please read the [Tracr Rough Check article](/tracr-articles/tracr-rough-check). ## Unlock a diamond Polished diamonds can only be shared or transferred if they are unlocked. You can unlock one or more locked diamonds from your inventory or from the Diamond Details page. > **Note:** To make sure that stones that are unlocked are accessible for future use, you will not be able to delete an unlocked stone. Please make sure you are happy with the stone you are unlocking and that it has all the necessary assets. {% embed url="" %} ### To unlock a diamond from your inventory {% stepper %} {% step %} 1. Select the checkbox next to the diamond(s) that you want to unlock. {% endstep %} {% step %} 2\. At the bottom of the page, select **Unlock**. {% endstep %} {% step %} 3\. Check that you have selected the correct diamond(s) to unlock. {% endstep %} {% step %} 4\. To keep a diamond locked, select **Remove from list** next to the diamond that you want to keep locked. {% endstep %} {% step %} 5\. Select **Unlock selected diamonds**. {% endstep %} {% step %} 6\. To confirm that you want to unlock, select **Confirm**. {% endstep %} {% endstepper %} ### To unlock a diamond from the Diamond Details page {% stepper %} {% step %} 1. Display the Diamond Details page for the diamond(s) that you want to unlock. {% endstep %} {% step %} 2\. Select the **Unlock this diamond** button. {% endstep %} {% step %} 3\. Check that you have selected the correct diamond to unlock. If not, select **Cancel**. {% endstep %} {% step %} 4\. To unlock the diamond, select **Unlock diamond**. {% endstep %} {% step %} 5\. To confirm that you want to unlock, select **Confirm**. {% endstep %} {% endstepper %} ## Manage Your Diamonds: Archive and Unarchive We're thrilled to introduce a new feature designed to enhance your inventory management: "Mark as Archived." This feature empowers you to organise your diamond inventory more effectively by allowing you to archive diamonds that are no longer actively managed.
### Key benefits * Improved Organisation: Declutter your active inventory and focus on current stock. * Easy Access to Archived Items: Quickly retrieve archived diamonds through the dedicated **Archived** tab. * Enhanced Workflow: Streamline your inventory management process. > On the **Archived** tab you can only view or unarchive a diamond. You cannot edit, share, or unlock an archived diamond. ### Frequently Asked Questions
Q: Where is the Archived tab located? A: The \_Archived\_ tab is located next to the Active tab in your inventory.
Q: Can I archive multiple diamonds at once? A: Yes, you can select multiple diamonds and archive them simultaneously.
Q: Will archiving a diamond delete it from my system? A: No, archiving a diamond simply moves it to the \_Archived\_ tab. It does not delete the diamond.
Q: Can I search for diamonds within the Archived tab? A: Yes, you can use the search functionality within the \_Archived\_ tab to find specific archived diamonds.
### User Interface Elements * The **Archived Tab** is located next to the Active tab.
* **Archive Button** is available in the Actions menu or on the bottom navigation bar.
* **Unarchive Button** is located in the Actions menu or on the bottom navigation bar in Archived tab.
* **Confirmation Messages:** Displays after archiving or unarchiving.
### How to Archive Diamonds {% stepper %} {% step %} 1. Select Diamonds: Navigate to your main diamond inventory list. Select the checkbox next to each diamond you wish to archive. {% endstep %} {% step %} 2\. Click Archive: Once you've selected the desired diamonds, click the **Archive** button located at the bottom navigation. {% endstep %} {% step %} 3\. Confirmation: A confirmation message will appear, indicating that the selected diamonds have been moved to the "Archived" tab. {% endstep %} {% endstepper %} #### How to Archive a Single Diamond
#### How to Archive Multiple Diamonds
#### How to Unarchive/Restore Diamonds
### Key benefits (Search by Report or Inscription Number) * Saves time by using a more common reference number. * Improves search accuracy. * Enhances usability with a more comprehensive search experience. ### Frequently Asked Questions (Search by Report or Inscription Number)
Q: What is the "Search by Report or Inscription Number" feature? A: This feature allows users to quickly find diamonds by entering their report number or inscription number.
Q: Where can I use this feature? A: You can use this feature on the Tracr Inventory.
Q: Will the search results show all diamond details? A: The search results will display key diamond details. You can click on a result to view the full details.
Q: What if I can't find the diamond I'm looking for? A: Double-check the report or inscription number for accuracy. Make sure your diamond is polished. If you still can't find it, contact customer support for assistance.
### User Interface Elements (Search by Report or Inscription Number) * **Search Bar:** now supports diamond searches using report or inscription numbers.

Where to enter the grading report number or insctiption number on the inventory

* **Results:** will be displayed on the table.

Results of searching for a grading report number or inscription number in the inventory.

### How It Works {% stepper %} {% step %} 1. Enter Report or Inscription Number: In the search field, type the diamond's report or inscription number. {% endstep %} {% step %} 2\. Click Search: Press the "Search" button. {% endstep %} {% step %} 3\. View Results: The matching diamond(s) will appear in the data table. {% endstep %} {% step %} 4\. Click the diamond to access the diamond's details. {% endstep %} {% endstepper %}

How to search for diamonds using a grading report number or inscription number in the inventory.

# 4. Integration Read this section to learn more about the preparation of diamond data to upload to Tracr and how to monitor an integration session. ## Overview Tracr provides two ways of integrating diamond data: * **Integration Tool** available on the Tracr Management Portal. Use the [Integration Tool](/tracr-user-guide/5.-integration-tool) to manually upload your diamond data files. * **Tracr Loader** available for Windows-based operating systems. Use [Tracr Loader](/tracr-user-guide/11.-tracr-loader) to automate the file upload process. You can download the Tracr Loader application and user guide from the **Integration toolkit**. ### Key concepts Before you integrate your diamond data, it is important that you understand the following key concepts: * A participant must claim the provenance of a diamond. Therefore, to register a diamond on Tracr, you must provide information about each diamond from a box so that Tracr can match the box information. If a diamond scan or video is provided, Tracr will also try to identify that single diamond individually. * To register a rough diamond 'family' (all splits and polished), Tracr must be aware of all the diamonds and how they are linked. Tracr therefore requires each diamond to have a unique participant\_id. Each split part of the diamond must have a unique ID. Each polished diamond must also have a unique ID so that Tracr knows which diamond is being polished and the new name of its polished version. * Tracr keeps information about each step from rough to polished. To link diamonds, you must always register the parent diamond first. To register a split diamond, Tracr must know the rough diamond (or the split, if it is a 'split of a split'). To register a polished diamond, Tracr must know which diamond is being polished.

How diamonds are linked by Parent ID. Not that diamonds IDs are for example only.

## Prepare your diamond data for an integration To register diamonds on Tracr, you must upload the required data through the Tracr Management Portal or the Tracr Loader whenever the diamond changes form and/or is passed from one process to another. This includes windowing and when unexpected incidents happen during the manufacturing process. You can also upload optional files like images and videos to enhance the Diamond Experience. {% hint style="info" %} Provided you have all the required data, you can upload multiple diamonds at once provided all diamonds in the upload are at the same stage. You cannot upload rough, all split, and polished diamonds in the same CSV file as Tracr requires different templates for different manufacturing steps. {% endhint %} ### Prepare a rough diamond dataset To integrate rough diamonds, you will need to provide basic information about the diamonds, including the carat, and some information about the sight box, including the year, sight number, and sight box ID. Tracr uses this information to check: * If the box exists and has been assigned to you. * That you are uploading the correct number of carats (total) in the box. Please note: * Tracr does not require the scan and the plan to be provided for rough diamonds. * Providing the images and videos is optional, however, this will greatly improve the Diamond Experience. {% stepper %} {% step %} ### Prepare the rough CSV * Download the rough CSV file template (**Integration Tool > Integration toolkit > CSV Templates**). {% endstep %} {% step %} ### Populate the rough CSV * Populate the CSV file - one row per diamond. {% endstep %} {% step %} ### Use the Data Dictionary * It is recommended that you download and use the Data Dictionary (**Integration Tool > Integration toolkit > Data dictionary**) to help you to populate the CSV file. Filter the Data Dictionary by "Stone State = Rough". Ensure that you populate fields with the column "Required = true". {% endstep %} {% endstepper %} #### Additional data fields to upload a scan file Tracr requires two additional data fields when uploading a scan file: * scan\_device\_manufacturer * scan\_device\_model **Supported technologies** | Technology | Comments | Data field values | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | Lexus Helium |

The Cutwise platform offers a service to convert 3D Scans to STL files.

Please contact Lexus India for more details.

|

Values for the additional fields are:
scan\_device\_manufacturer : "Lexus SoftMac"
scan\_device\_model : "Model name of your device"

| | Diabot | InnovSeed Diabot generates an open STL file which can be uploaded into Tracr. |

Values for the additional fields are:
scan\_device\_manufacturer : "InnovSeed"
scan\_device\_model : "Diabot" or "Diabot NX"

| | Sarine | If you require to use a Sarine device to upload a 3D scan to Tracr, please contact our [Support Team](mailto:support@tracr.com) for more details. | | ### Prepare a split diamond dataset This procedure applies to every modification to the diamond after the rough session and before the diamond is polished. If the rough diamond is split during the manufacturing process, every part that was split has to be declared using a new participant ID and linked to the parent diamond. Please note: * Tracr does not require the scan and the plan to be provided for the split diamonds. * Ensure that the parent diamond is always registered before submitting the split diamond - the parent needs to be declared first. * Providing the images and videos is optional, however, this will greatly improve the Diamond Experience. * Every time you split a rough diamond, each split will receive a new unique Tracr ID. {% stepper %} {% step %} ### Download the split CSV template * Download the split CSV file template (**Integration Tool > Integration toolkit > CSV Templates**). {% endstep %} {% step %} ### Populate the split CSV * Populate the CSV file - one row per diamond. {% endstep %} {% step %} ### Use the Data Dictionary * It is recommended that you download and use the Data Dictionary (**Integration Tool > Integration toolkit > Data dictionary**) to help you to populate the CSV file. Filter the Data Dictionary by "Stone State = Split". Ensure that you populate fields with the column "Required = true". {% endstep %} {% endstepper %} ### Prepare a polished diamond dataset #### Sarine Instructor If you are using **Sarine Instructor** to provide a scan for polished diamonds, you need to generate an XML report and an STL export. Use the template provided by Tracr to export the report for each diamond. To extract data for polished diamonds using Sarine Instructor, refer to [Sarine Instructor: Extracting data for polished diamonds](#sarine-instructor-extracting-data-for-polished-diamonds) In the CSV file, Tracr needs the STL file in the column **scan**, and the XML report in the column **scan\_report**. [Download Sarine export templates](https://jcpackages.tracr.network/integration/Polished_Diamond_Sarine_Instructor_Export_Template.zip) #### Helium software If you are using **Helium software** to provide a scan for polished diamonds, you need to generate an HTM report and an STL export. Use the template provided by Tracr to export the report for each diamond. There are two types of Helium template: * Specific shape, only for a handful of shapes with additional information. * Generic, less information but you can use this template for all shapes. In the CSV file, Tracr needs the STL file in the column **scan**, and the HTM report in the column **scan\_report**. For more information about exporting using a Helium Polish Scanner, please refer to the [Helium Polish Scanner - Settings for Export (PDF)](https://www.lexusindia.in/download/download-files/HELIUMPOLISH_SETTINGS_FOR_EXPORTS.pdf). [Download Helium templates](https://jcpackages.tracr.network/integration/helium_templates.zip) Please note: * Before uploading polished diamond data, please make sure that you register the parent diamond on Tracr. * To verify the polished diamond, a 3D scan and the report of the scan of the diamond are crucial. * Providing the images and videos is optional, however, this will greatly improve the Diamond Experience. * Add the grading document to complete the polished digital asset. {% stepper %} {% step %} ### Download the polished CSV template * Download the polished CSV file template (**Integration Tool > Integration toolkit > CSV Templates**). {% endstep %} {% step %} ### Populate the polished CSV * Populate the CSV file - one row per diamond. {% endstep %} {% step %} ### Use the Data Dictionary * It is recommended that you download and use the Data Dictionary (**Integration Tool > Integration toolkit > Data dictionary**) to help you to populate the CSV file. Filter the Data Dictionary by "Stone State = Polished". Ensure that you populate fields with the column "Required = true". {% endstep %} {% endstepper %} ### Sarine Instructor: Extracting data for polished diamonds Extracting the required traceability data for polished diamonds using Sarine Instructor software is compatible with the following hardware: * DiaMension * DiaMension HD * DiaMark HD * DiaMark™ HD Once a polished diamond is scanned and the file loaded onto the Instructor software, you can extract the following data points: * Diamond Measurements (using a provided template) * Diamond 3D Model The following instructions describe how to extract the required data. {% stepper %} {% step %} ### 1. Install the Tracr templates for polished diamonds * Place the Tracr template file, e.g. ‘TracrPolishedTemplate.txt’, within the Sarine Instructor Export folder:\ Sarine Technologies/Instructor/Export/ {% endstep %} {% step %} ### 2. Export diamond measurements * Open the stone .srn file in Sarine Instructor. * Point to the **Export** icon, and select the corresponding Tracr template, for example, ‘TracrPolishedTemplate.txt’. * In the **Save As** dialog box, save the measurements as ‘YourStoneName.xml’. {% endstep %} {% step %} ### 3. Export the mesh * Open the stone .srn file. * Point to the **Save** icon, and select **Save as**. * In the **Save As** dialog box, select ‘\*.stl’ as the file type and save the mesh with the stone's name. {% endstep %} {% endstepper %} ## Required fields for diamond integration The following are the required fields for diamond integration. Refer to the Data Dictionary for more information, including the allowed values. Rough * participant\_id – Your unique identifier for the diamond. This can be your ERP ID or any other ID which will help you to identify the diamond in your system. * participant\_timestamp – A date and time of your choosing. For example, this may be when you added the diamond into to your system or when it was processed. * box\_id – The parcel identification number. This is the ID of the parcel you receive from the producer. * sight\_year – The sight year. * sight\_no – The sight number. * carats – The weight of the rough diamond. Tracr requires a precision of three digits. {% hint style="info" %} **Note** Producers are no longer required to provide a colour for diamonds registered via DIT at rough. Colour can be omitted by leaving the colour cell for that diamond in the upload CSV blank. {% endhint %} Split * participant\_id – Your unique identifier for the diamond. This can be your ERP ID or any other ID which will help you to identify the diamond in your system. * participant\_parent\_id – Your identifier for the parent rough diamond. * participant\_timestamp – A date and time of your choosing. For example, this may be when you added the diamond into to your system or when it was processed. * carats – The weight of the split diamond. Tracr requires a precision of three digits. Polished * participant\_id – Your unique identifier for the diamond. This can be your ERP ID or any other ID which will help you to identify the diamond in your system. * participant\_parent\_id – Your identifier for the parent split or rough diamond (if the rough was polished without splitting). * participant\_timestamp – A date and time of your choosing. For example, this may be when you added the diamond into to your system or when it was processed. * carats – The weight of the polished diamond. Tracr requires a precision of three digits. * cut\_grade – The grade of cut. * shape – The shape of the polished diamond. * clarity – The relative absence of inclusions and blemishes. * symmetry – The symmetry of the polished diamond. * polish\_quality – The quality of the polished diamond. * scan – The scan of the polished diamond (for example, Sarine scan). * scan\_report – The extracted report of the scan. {% hint style="info" %} **Note** We require mutual exclusivity of `colour` and fancy\_colour fields. You may only provide fancy\_colour (`fancy_colour`, `fancy_colour_intensity` and optionally `fancy_colour_overtone`) or colour values for any given diamond being registered or updated via the integration tool. {% endhint %} Transfer * participant\_id – Your unique identifier for the diamond. This can be your ERP ID or any other ID which will help you to identify the diamond in your system. * transfer\_type – The type of transfer: in or out. * transfer\_timestamp – The date when the diamond was transferred. * box\_id – The parcel identification number. * platform – The name of the participant that purchased or sold the diamond. ## Video quality requirements If you are providing a video of your diamond, please note the following: * Format – .mp4, .avi, .mkv, .mov * Rotation – At least one full 360° rotation horizontally (clockwise or anticlockwise) * Number of frames: At least 30 * Resolution – At least 400 x 400 pixels * Good contrast between the stone and the background * Unobscured background, clean without clamps * (Optional) Additional video in fluorescence #### Examples

Videos with good contrast.

A video with poor contrast.

Videos with visible clamps.

## Tracr data control After uploading diamond data, Tracr runs following control processes: Rough diamonds * For a given sight box, that the total carat weight submitted does not exceed the total carat weight invoiced by De Beers. * For a given sight box, that the number of diamonds submitted does not exceed the number of diamonds invoiced by De Beers (where applicable). Child rough (split) diamonds * That the sum of all the children's carats does not exceed the carat weight of the parent diamond. Polished diamonds * That the carat weight of the polished diamond does not exceed the carat weight of the parent diamond. ## View integration session history Tracr maintains a list of all the sessions that you create, save or abandon.

Session history showing submitted and in progress sessions.

To view your session history: * From the Tracr menu, select **Integration > Integration Tool**.\ The **Session history** page displays a list of your integration sessions. Each session has a status, which shows whether the session was submitted, is in progress, or was abandoned. * **Submitted** – Data has been uploaded and Tracr is processing the diamonds. * **In progress** – The session was not submitted, either because the user did not click **Submit** or chose to save and quit the session, possibly because not all the required files were available. To complete the session, in the **Action** column, select **Continue session**. * **Abandoned** – The session was abandoned. Note that you can only abandon a session if the CSV file has passed validation. ### Session information For each session, Tracr gives the following information: * **Session ID** – The ID allocated to the session by Tracr. * **Session start** – The date and time the session started. You can filter on the start date if you only want to display sessions started on a particular date. * **Session submitted** – The date and time the session was submitted to Tracr. If this is blank, check the **Status** column to see if the session is ‘In progress’ or was ‘Abandoned’. * **Integration type** – The integration type selected when the CSV was uploaded to Tracr. You can filter on integration type if you only want to display sessions of a certain type. * **Diamonds submitted** – The number of diamonds submitted to Tracr. * **Diamonds excluded** – The number of diamonds excluded when the dataset was uploaded to Tracr. * **Status** – The status of the session. You can filter on status if you only want to display sessions at a certain status. * **Details** – Provides more information about the status of the session. * **Action** – The available options depend on the status of the session. * For a ‘Submitted’ session, select the ellipsis to access the following options:\ **Monitoring** – Display the **Integration monitoring** page for the selected session.\ **.xlsx file** – Download a simple or detailed report for the selected session. * For an ‘In progress’ session, select **Continue session** to complete and submit the session. ### Filter your session history You can filter the list of sessions by event date, integration type, or status. To filter by event date: * Select **Start date**, choose the date from the calendar, and select **Apply**.\ Tracr only displays sessions for the selected date. To filter by integration type: * Select **Integration type**, select the type(s) that you want to display, and select **Apply**.\ Tracr only displays sessions for the selected integration type(s). To filter by status: * Select **Status**, select the status(es) that you want to display, and select **Apply**.\ Tracr only displays sessions for the selected status(es). ### Continue a session If a session has been saved (status = ‘In progress’), you can select **Continue session** in the **Action** column on the **Session history** page to complete and submit the session. {% hint style="info" %} If you want to quit a session without submitting it and then continue the session later, select the **Quit** button at any time during file upload and then select **Save and quit**. Tracr saves your session which appears on the **Session history** page with a status of ‘In progress’. {% endhint %} ### Export a session report You can export details of a selected session currently displaying on the **Session history** page as a report (xlsx file). {% stepper %} {% step %} ### 1. Filter sessions * Use the filters to display the session(s) that you want to export. {% endstep %} {% step %} ### 2. Choose report type * In the **Action** column, select the ellipsis and do one of the following: * To download a simple report for the selected session, under **Download a session report as**, select **.xlsx file**.\ [**View example report**](/tracr-user-guide/10.-example-reports#integration-tool-transaction-report) * To download a detailed report for the session, under **Download full session report**, select **.xlsx file**.\ [**View example report**](/tracr-user-guide/10.-example-reports#integration-tool-full-transaction-report) {% endstep %} {% step %} ### 3. Download * Tracr generates the report which is downloaded and saved in your default downloads folder. {% endstep %} {% endstepper %} # 5. Integration Tool Read this section to learn how to upload diamond data to Tracr using the **Integration Tool**. ## Overview Use the Integration Tool to manually upload your data files to your instance of the Tracr Platform. To begin, you need to create a new session. Then, you provide a prepared CSV file containing your diamond data. There are templates to help you prepare the CSV file and a Data Dictionary, which describes the information that you must include in your CSV file for rough, split, or polished diamond data. Do not mix different types of data in your CSV file and it is recommended that you use a text editor to edit the file. ## Create a new session You need to create a new session to upload diamond data to Tracr. {% stepper %} {% step %} ### Start a new session From the Tracr menu, select **Integration > Integration Tool** to display the **Session history** page, then select **New session**. {% endstep %} {% step %} ### Provide your CSV file Either drag and drop your prepared CSV file onto the page or select **Or, select from device** to browse for and select the file that you want to upload. Tracr validates your CSV file and then, if the file is valid, asks you to confirm the integration type. It is important that the type you select matches the type defined in your CSV file. If not, you will get an error. {% endstep %} {% step %} ### Select integration type and continue Select your integration type, and then select **Continue**. * If validation is successful, Tracr displays the **Required files** page with the **Session overview** tab selected. You must then upload the files declared in the CSV file (ensuring that the filenames match) before you can complete the upload. * If validation fails, Tracr displays the **Upload failed** page. You should review the error text and make the appropriate changes to your CSV file. Select **Quit** and create a new session to upload the changed file. {% endstep %} {% endstepper %} {% hint style="warning" %} Typical reasons for failing validation include: * Incorrect integration type selected during upload — the integration type is not correct for the template that you are trying to upload. * Incorrect columns in the CSV file that do not match the CSV template. * Incorrect entries in the CSV file that do not match the accepted values defined in the Data Dictionary. {% endhint %} ## Session overview The **Session overview** tab provides a summary of the files that are associated with each diamond that you are uploading to Tracr. Before you can submit the session, you need to upload the data files referenced in the CSV file. If you are unsure, Tracr lists the names of these files on the **Missing files** tab. To upload the required files: * Either drag and drop the files onto the page or select the **Or, select from device** button to browse for and select the files that you want to upload.\ As Tracr accepts the files, you will see a green tick appear under the appropriate file type on the **Session overview** tab.\ An orange exclamation mark indicates a file is missing. You will not be able to complete your session if there are any files missing. {% hint style="info" %} Tip: To only display diamonds with missing files on the **Session overview** tab, move the **Hide complete diamonds** toggle to the ‘on’ position. {% endhint %} ### Exclude diamonds from upload If you decide that you do not want to upload certain diamonds listed in your CSV file to Tracr, you can manually exclude those diamonds from the upload process. When you exclude a diamond, it is not submitted to Tracr. {% hint style="info" %} Note: To identify an excluded diamond, look for 'You have excluded this diamond, by doing so it will not be submitted with this session' next to the Participant ID. {% endhint %} To exclude a diamond from the upload: * Point to a **Participant ID** on the **Session overview** tab, and then select the **Exclude diamond** icon.

Excluding a diamond.

To include an excluded diamond and submit it to Tracr: * Point to a **Participant ID** on the **Session overview** tab, and then select the **Include diamond** icon.

Including an excluded diamond.

## Missing files The **Missing files** tab lists any files that Tracr is expecting you to provide. You will not be able to complete your session if there are any files missing. {% hint style="info" %} Note: Your CSV file specifies the names and types of files, so if any of these are not to be provided, you need to edit your CSV file and start a new session. {% endhint %} Tracr displays a number in an orange circle on the **Missing files** tab to tell you that there are missing files.

A session with 15 missing files.

To upload missing files: * Either drag and drop the files onto the **Missing files** tab or select the **Or, select from device** button to browse for and select the files that you want to upload.\ As Tracr accepts the files, you will see a green tick appear under the appropriate file type on the **Session overview** tab. An orange exclamation mark indicates a file is missing. You will not be able to complete your session if there are any files missing.\ When all files are uploaded, look for this message in the top right corner: ‘Ready to submit. All required files have been accepted and uploaded for this session, submit to continue.’ ### Download a missing files report You can download a report which details the missing files for the session. The report lists the participant ID, file name, and file type. To download a report: * On the **Missing files** tab, select **download as .xlsx**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#integration-tool-missing-files-report) ## Failed files Tracr validates each file as it is uploaded and lists any files that fail validation on the **Failed files** page. You will not be able to complete your session if any files fail validation. The validation checks include: CSV files * Is the header present? * Does the header match the template? * Are the values in the columns in each row valid according to the template and data dictionary? * Is the participant\_id and participant\_parent\_id distinct from each other? * Are the filenames in each row unique from one another (for declared files, i.e., images, videos, scans, etc)? Any type (for example, scan, plan, and image files) * Is the file > 0 bytes in length? HTML, XML and PDF files * Is the file valid according to its declared file type (i.e., is a .xml file a valid XML file, is a .pdf a valid PDF file)? HTML files * Does the file contain one or more of the HTML anchor tags expected in the HTML accepted by Tracr? PDF files * Is the file greater than 100 kb in size? Tracr displays a number in a red circle on the **Failed files** tab to tell you that there are failed files.

A session with one failed file.

### Download a failed files report You can download a report which details the failed files for the session. The report lists the participant ID, file name, file type, and details. To download a report: * On the **Failed files** tab, select **download as .xlsx**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#integration-tool-failed-files-report) ## Unexpected files Tracr lists any unexpected files that you have uploaded on the **Unexpected files** page. While these files will not affect the upload, you should check the names and types of any files shown on the **Unexpected files** page to see whether these should have been included in your CSV file. To help you do this, you can download a file containing the names and types of any unexpected files. {% hint style="info" %} Note: If you selected all the files in a folder to upload, you may have uploaded the CSV file again. If so, this appears on the **Unexpected files** page. {% endhint %} Tracr displays a number in a white circle on the **Unexpected files** tab to tell you that there are unexpected files.

A session with one unexpected file.

### Download an unexpected files report You can download a report which details the unexpected files for the session. The report lists the file name and file type. To download a report: * On the **Unexpected files** tab, select **download as .xlsx**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#integration-tool-unexpected-files-report) ## Submit a session When all files are uploaded, look for the message ‘Ready to submit. All required files have been accepted and uploaded for this session, submit to continue.’ in the top right corner. You can now select the **Submit session** button. Tracr provides you with a summary of your session: the number of diamonds to submit and the number excluded. Select the **Submit** button to submit the session for matching and verification. You then have the option to download a session report or view the session on the **Session history** page. ## Quit a session You can quit a session without submitting it for matching and verification. To do this, select the **Quit** button at any time. Tracr provides you with two options: * **Save and quit** – Tracr saves your session which appears on the **Session history** page with a status of ‘In progress’. **Select Continue session** to resume the session. * **Abandon and quit (all progress will be lost)** – When you abandon a session, it is no longer accessible, and Tracr deletes all progress. ## Update a diamond after integration Provided you have not uploaded the next processing step, you can update diamonds which you have already integrated. ### Allowed update operations Data for rough diamonds - split or polished not yet uploaded: * Update carat, add images, add videos, add optional data. Data for split diamonds - split or polished version not yet uploaded: * Update carat, add images, add videos, add optional data. Data for polished diamonds, which you can update at any time (unless sold and transferred out): * Update carat, add images, add videos, add grading certificate, add optional data. * Add an additional grading certificate for the same diamond. ### Update procedure To update a diamond that you have already integrated, you can: * Upload the same CSV file containing the diamonds you want to update. Only change the fields that you want to update.\ -or- * Create a new CSV file (using the appropriate Tracr template) with the diamonds you want to update and provide the updated values. {% hint style="warning" %} Important: Every time you update a diamond, you must provide the fields marked in the Data Dictionary as 'required'. {% endhint %} ## Updates to grading certificates You can upload grading certificates multiple times to reflect diamond changes. For example: * Incorrect certificate provided. * Re-cut of the diamond. * Re-certification of the diamond. * Updates to other grading fields (inscription number, grading report number, and so on). After a certificate is uploaded to Tracr, every next upload of grading information will be considered as an update and depending on what must be updated, it can be actioned in one of two ways: If the grading certificate must be updated * Re-upload polished diamond data on your Tracr Portal (mandatory and updated fields only) and provide a new grading certificate and corresponding inscription number. * Upload of a new grading certificate (different file) will create a new grading record for the diamond. * Your Tracr Portal instance and [Tracr Search](https://search.tracr.com/) will display: * The latest grading certificate. * The current and previous inscription numbers. If the inscription number or other grading data other than the grading certificate has to be added or updated * Re-upload polished diamond data on your Tracr Portal and provide the previously uploaded grading certificate with updated or new grading information. * Your Tracr Portal instance and [Tracr Search](https://search.tracr.com/) will display: * The latest (the same) grading certificate. * Updated grading information. Tracr stores all grading certificates uploaded for a polished diamond and this data can be retrieved using the [Tracr Search API.](https://docs.tracr.com/docs/cross-participant-search-xps/) # 6. Integration Monitoring Read this section to learn how to view the verification status of uploaded diamonds. ## Overview The **Integration monitoring** page displays the verification status of diamonds that you have uploaded to Tracr. Each integration has a status, which can be ‘Registered’ or ‘Invalid’. * **Registered** – The diamond is verified, and on the Tracr Portal. * **Invalid** – An error has occurred, and Tracr did not register the diamond. Refer to the **Details** column for more information on the error. ## View the verification status of a session You can view the verification status of diamonds in all submitted sessions or for a specific session.

The Integration Monitoring page showing one registered diamond and one unregistered diamond (invalid).

To view the verification status of all submitted sessions: * From the Tracr menu, select **Integration > Monitoring**.\ The **Integration monitoring** page displays the integration events for each diamond in all submitted sessions. {% stepper %} {% step %} ### View the integration status of a specific session * From the Tracr menu, select **Integration > Integration Tool**. * On the **Session history** page, next to a session, select **Action > Monitoring**.\ The **Integration monitoring** page displays the integration events for each diamond in the selected session. {% endstep %} {% endstepper %} ### Integration event information The information on the **Integration monitoring** page provides details about each diamond and its status in the integration process. * **Integration type** – The integration type selected when the CSV file was uploaded to Tracr. * **Event date** – The date and time Tracr successfully or unsuccessfully registered the diamond. You can filter on the event date if you only want to display events on a particular date. * **Participant ID** – The participant’s unique ID for the diamond. * **Session ID** – The ID allocated to the session by Tracr. * **Box ID** – The sight box identification by Tracr. * **Tracr ID** – The ID allocated when Tracr registered the diamond. You can search your inventory using this ID. * **Status** – The status of the integration event. Tracr displays the status of an integration as either ‘Registered’ or ‘Invalid’. * **Details** – Provides more information if the status of the event is ‘Invalid’. {% hint style="info" %} Searches by ID are case-sensitive. As soon as you type the first three characters in the Filter by ID box, Tracr will list matching diamonds. {% endhint %} ### Filter integration events To find events for a specific diamond or a group of diamonds, you can filter by participant ID, box ID, session ID, or Tracr ID. {% stepper %} {% step %} ### Filter by ID * Type the ID that you want to search for into the **Filter by ID** box. As soon as you type the first three characters, Tracr will list the diamonds that match. (Search is case-sensitive.) * Select **X** to clear the search box to redisplay all events. {% endstep %} {% step %} ### Sort results * To sort the results in ascending/descending order, select any column heading. {% endstep %} {% endstepper %} ### Filter by integration type, last updated, or status You can filter integration events by integration type, last updated, or status. * To only display events last updated on a particular date, select **Event date**, choose the date from the calendar, and select **Apply**. * To only display events of a certain integration type or status, select the filter, select the filter value(s) that you want to use, and select **Apply**. ### Clear all filters To clear all filters and redisplay all events, select **Clear**. ### Export an event report You can export details of all the events currently displaying on the **Integration monitoring** page as a report (xlsx file). {% stepper %} {% step %} ### Prepare the report Use the filters to display the events that you want to export. {% endstep %} {% step %} ### Export Select **Export report** and then select **xlsx file**. {% endstep %} {% step %} ### Download Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#integration-monitoring-report) {% endstep %} {% endstepper %} ## Integration errors Typical integration errors include: * **Child diamond cannot be heavier than its parent** – The parent diamond carat weight is less than the subject diamond. * **No boxes found** – The box ID in the CSV used to upload a rough diamond has not been found for the sight year and number provided. * **Too many carats** – The total carat weight does not match the expected carat weight as registered against the box by De Beers. * **Too many diamonds** – You are trying to register more diamonds than De Beers assigned to the box. * **Diamond is not unique** – The same diamond ID already exists on Tracr. * **Could not find existing diamond or parent (parent id xxxxxx) for yyyyyy** – You cannot register a split or polish or perform an update because the existing or parent diamond is not registered on Tracr. {% hint style="info" %} For help on these and other error messages shown in the **Details** column, contact {% endhint %} # 7. Shipments Outbound Read this section to understand how to create, view and manage shipments of diamonds to transfer to manufacturers or retailers. ## Overview If you are a producer, you can create a shipment of rough diamonds to transfer to a manufacturer. On receipt of the transfer, the manufacturer can accept or reject the shipment. If it is accepted, the manufacturer must then upload diamonds against the shipment using the **Integration Tool**. If you are a manufacturer, you can create a shipment of diamonds to transfer to a retailer. When you transfer a diamond out of your inventory, you make it eligible for transfer into the recipient’s Tracr inventory. Tracr sends notifications to the recipient and the diamond appears on the list of eligible diamonds for transfer in. When the recipient accepts ownership and the transfer completes, the diamonds are added to the recipient’s inventory. {% hint style="info" %} As a manufacturer, you can only transfer diamonds that are verified, inscribed, and held within your inventory. {% endhint %} ## Create a new shipment To transfer diamonds to a new recipient, you must create a shipment which specifies the diamonds that you want to transfer from your inventory. {% hint style="info" %} Before you start: Prepare a CSV file with the Tracr IDs of the diamonds you want to transfer. To avoid syntax errors, name the column tracr\_id. [Download transfer CSV template](https://jcpackages.tracr.network/integration/transfer_out_template.csv) If you are transferring polished diamonds, ensure that your CSV file does not contain locked diamonds as you cannot transfer a diamond if it is locked. {% endhint %} {% stepper %} {% step %} ### Start a new shipment * From the Tracr menu, select **Shipments > Outbound**. * Select **New shipment**. {% endstep %} {% step %} ### Upload CSV In the **New Shipment** dialog box: * Select the **Integration type**, either *Rough* or *Polished*. * Either drag and drop your prepared CSV file onto the page or choose **Select from device** to browse for and select the file that you want to upload. * Select **Upload**. Look for ‘CSV uploaded successfully' to confirm that Tracr has accepted the file. {% endstep %} {% step %} ### Review uploaded diamonds * Review the diamonds in the shipment. Note that you cannot proceed with the shipment if it contains unavailable or locked diamonds. * If any diamonds are unavailable (for example, already transferred, in a shipment, not inscribed, not found, or locked), either select **Remove** next to the unavailable diamond or select **Remove all unavailable diamonds**, and then select **Confirm**. {% endstep %} {% step %} ### Remove unwanted diamonds * Remove any diamonds you do not want to include in the shipment. To do this, either select **Remove** next to the diamond or select the diamonds to remove and then select **Remove** at the bottom of the page. Then select **Confirm**. * Select **Continue**. {% endstep %} {% step %} ### Finalise and send * Enter a name to identify the shipment. * Enter the recipient's Tracr API URL. For example, [*https://api.*](https://api./)*\* * Select **Send shipment**. * Review the shipment information, then either: * Select **Confirm** to confirm the shipment. * Select **Cancel** to cancel the shipment. Note: You can still cancel the shipment after sending until your recipient accepts the shipment. {% endstep %} {% endstepper %} ## Active outbound shipments When you create a new outbound shipment, it appears on your active shipments list. You can view the active shipments including the number of diamonds transferred, outstanding, cancelled or rejected. ### View active diamond shipments The **Active** tab lists the collections of diamonds (shipments) that have yet to be completed, that is, the shipment contains diamonds that have not been transferred, rejected, or cancelled. {% hint style="info" %} To make a diamond eligible for transfer to another Tracr account, select the **New shipment** button and complete the New Shipment process. {% endhint %} To view pending diamond shipments: * From the Tracr menu, select **Shipments > Outbound**.\ The **Active** tab lists the collections of diamonds (shipments) selected for transfer.

Shipments Outbound Active tab, five of the shipments of polished diamonds have been sent and not yet accepted or rejected. The shipments can be cancelled. Two shipments have been accepted.

## Columns By default, the outbound shipments table displays a standard set of columns. You can customise the display and add additional columns to view more information, as required. > **Note:** Tracr remembers your column selections for inbound and outbound shipments screens when you sign out. {% stepper %} {% step %} ### To display additional columns 1. Select **Columns**. 2. Choose the columns that you want to display. {% endstep %} {% step %} ### To remove additional columns 1. Select **Columns**. 2. Clear the checkbox next to any columns that you do not want to display. {% endstep %} {% step %} ### To reset the columns to default 1. Select **Columns**. 2. Select **Restore columns to default**. {% endstep %} {% endstepper %} #### Active shipment information For each active shipment, Tracr displays the following information on the **Active** tab: * **Recipient** - The name of the recipient, entered when the transfer was created. * **Shipment ID** - The ID assigned to the transfer when it was created. * **Date sent** - The date the shipment was sent to the recipient. * **Shipment name** - The name given to the shipment when it was created. * **Total diamonds** - The number of diamonds in the shipment. * **Total carats** - The total number of carats for all diamonds in the shipment. * **Carat range** - The range of carat weights for diamonds in the shipment. * **Integration** - The integration type (*Rough* or *Polished*) selected when the shipment was created. * **Status** - The status of the active shipment: * **Accepting**, **Cancelling**, or **Rejecting** - Tracr is processing the shipment. Applies only to rough shipments. * **In progress** - Some, but not all of the diamonds in the shipment have been accepted, cancelled, or rejected. Applies only to polished shipments. * **Sent** - The recipient has been notified of all the diamonds in the shipment. * **Actions (three dots)** * **Cancel** - Select this button to cancel the transfer of the shipment. This button is only shown until the recipient accepts the shipment. * **View** - Select this button to view details of the diamonds in the shipment. ### Filter Shipments The outbound shipments screen includes a search box. Typing in this field will filter the list of outbound shipments by the recipient, shipment ID, or shipment name. ### View active shipment details You can view more information for each shipment listed on the **Active** tab, including the status of each polished diamond in the transfer. To view active outbound shipment details: * Next to a shipment on the **Outbound Active** tab, select **View**.\ Tracr displays the **Pending shipment** page, which shows the status of each diamond in the shipment.

Details for an active outbound polished shipment. The recipient has rejected one of the diamonds, and one diamond is still available for transfer. The sender has cancelled the third diamond.

Details for an active outbound rough shipment. The shipment can still be cancelled.

#### Active shipment details Descriptions of the columns on the **Pending shipment** page are as follows: * **Total diamonds** - The number of diamonds in the shipment. * **Total carats** - The total number of carats for all diamonds in the shipment. * **Carat range** - The range of carat weights for all diamonds in the shipment. * **Tracr ID** - The ID allocated when Tracr registered the diamond. * **Participant ID** - The ID of the diamond in the participant’s ERP system, which is used to maintain the relationship between a diamond in the ERP and the same diamond in the Tracr platform. * **Shape** - The shape of the diamond. * **Carat** - The physical weight of the diamond. * **Clarity** - The clarity of the diamond, ranging from ‘FL’ (flawless) to ‘P3’ (poor quality). Clarity grades define the quantity, size, and location of inclusions in a diamond. * **Colour** - The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). * **Cut** - The diamond’s proportions, symmetry, and polish, ranging from poor to excellent. * **Status** - For a polished shipment, each diamond has a status: * **Cancelled** - The sender cancelled the transfer of the diamond in the shipment. * **Rejected** - The recipient rejected the diamond in the shipment. * **Sent** - The diamond has been sent; the recipient can now accept or reject the diamond in the shipment. * **Transferred** - The recipient accepted the transfer of the diamond in the shipment. * **Actions (three dots)** * **Cancel** - Cancels the transfer of the selected diamond to the recipient. ### Cancel a shipment You can cancel an active shipment. For a rough shipment, you can only do this if the shipment has not yet been accepted. For a polished shipment, you can only cancel the shipment if none of the diamonds have been transferred. {% stepper %} {% step %} * On the **Pending shipment** page, select the **Cancel shipment** button. {% endstep %} {% step %} * Read the confirmation message and select the **Confirm** button to cancel the shipment.\ The shipment appears on the **Archived** tab with the status ‘Cancelled’. {% endstep %} {% endstepper %} ### Cancel a polished diamond in a shipment You can cancel (remove) a polished diamond from a shipment. {% hint style="info" %} You can only cancel the transfer of a diamond if its status is ‘Sent’. {% endhint %} {% stepper %} {% step %} * On the **Pending shipment** page, next to the diamond that you want to cancel, in the **Actions** column, select **Cancel**. {% endstep %} {% step %} * To stop transfer of the selected diamond, select the **Confirm** button.\ Tracr removes the diamond from the shipment and changes the status of the diamond to ‘Cancelled’. {% endstep %} {% endstepper %} ### Export an active outbound shipment session report You can export details of a pending shipment as a report (CSV file). * On the **Pending shipment** page, select **Export as CSV**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#transfer-out-session-csv) ## Archived outbound shipments A shipment is considered complete when all diamonds have either been rejected or accepted by the recipient or cancelled by the sender. {% hint style="info" %} Once a shipment is complete it moves from the **Outbound Active** list to the **Outbound Archived** list. {% endhint %} ### View archived diamond shipments The **Archived** tab lists the collections of diamonds (shipments) that have completed, that is, the recipient has either confirmed or rejected the transfer. To view archived diamond shipments: * From the Tracr menu, select **Shipments > Outbound**, then select the **Archived** tab.

Shipments Outbound Archived tab.

## Columns By default, the outbound shipments table displays a standard set of columns. You can customise the display and add additional columns to view more information, as required. > **Note:** Tracr remembers your column selections for inbound and outbound shipments screens when you sign out. {% stepper %} {% step %} ### To display additional columns 1. Select **Columns**. 2. Choose the columns that you want to display. {% endstep %} {% step %} ### To remove additional columns 1. Select **Columns**. 2. Clear the checkbox next to any columns that you do not want to display. {% endstep %} {% step %} ### To reset the columns to default 1. Select **Columns**. 2. Select **Restore columns to default**. {% endstep %} {% endstepper %} #### Archived shipment information For each archived shipment, Tracr displays the following information: * **Recipient** - The name of the recipient, entered when the shipment was created. * **Shipment ID** - The ID assigned to the transfer when it was created. * **Date sent** - The date the shipment was sent. * **Shipment name** - The name of the shipment. * **Total diamonds** - The total number of diamonds in the shipment. * **Total carats** - The total number of carats of the diamonds in the shipment. * **Carat range** - The range in carat values of the diamonds in the shipment. * **Integration** - The integration (Rough or *Polished*) selected when the shipment was created. * **Status** - The status of the archived shipment: * **Cancelled** - The sender cancelled the shipment. * **Complete** - All polished diamonds have been cancelled, transferred, or rejected. For a rough shipment, all diamonds have been uploaded. * **Rejected** - The recipient rejected the shipment. * **Actions** - Select **View** to display the status of each diamond in the archived shipment. ### Filter Shipments The outbound shipments screen includes a search box. Typing in this field will filter the list of outbound shipments by the recipient, shipment ID, or shipment name. ### View archived shipment details You can view more information for each shipment listed on the **Archived** tab. To view archived shipment details: * Next to a shipment on the **Archived** tab, select **View**.\ Tracr displays the **Archived details** page, which shows more information about each diamond in the archived shipment, including the status of each diamond for a polished shipment.

Details for a completed polished shipment. Only one diamond transferred to the recipient, the others were either rejected or cancelled by the sender.

#### Archived shipment details Descriptions of the columns on the **Archived details** page are as follows: * **Total diamonds** - The total number of diamonds in the shipment. * **Total carat weight** - The total number of carats of the diamonds in the shipment. * **Carat range** - The range in carat values of the diamonds in the shipment. * **To** - The name of the recipient, entered when the shipment was created. * **Shipment name** - The name of the shipment. * **Data sent** - The date the shipment was sent. * **Tracr ID** - The ID allocated when Tracr registered the diamond. * **Participant ID** - The ID of the diamond in the participant’s ERP system, which is used to maintain the relationship between a diamond in the ERP and the same diamond in the Tracr platform. * **Shape** - The shape of the diamond. * **Carat** - The physical weight of the diamond. * **Clarity** - The clarity of the diamond, ranging from ‘FL’ (flawless) to ‘P3’ (poor quality). Clarity grades define the quantity, size, and location of inclusions in a diamond. * **Colour** - The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). * **Cut** - The diamond’s proportions, symmetry, and polish, ranging from poor to excellent. * **Status** - The status of the diamond in the archived outbound shipment. Only shown for polished diamonds: * **Cancelled** - The sender cancelled the transfer of the diamond in the shipment. * **Transferred** - The diamond successfully transferred to the recipient's inventory. * **Rejected** - The recipient rejected the diamond in the shipment. #### Export an archived outbound shipment session report You can export details of an archived outbound shipment as a report (CSV file). * On the **Archived details** page, select **Export as CSV**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#transfer-out-session-csv) *** ## Search by Report/Inscription Number We are pleased to announce an upgrade to our search capabilities. You can now search using grading report numbers and inscription numbers across the Tracr Shipments. This enhancement is designed to provide greater flexibility and efficiency in your search process. Recognising that both report and inscription numbers are key identifiers, we've integrated them into our search functionality to streamline your workflow.
### Key benefits * Saves time by using a more common reference number. * Improves search accuracy. * Enhances usability with a more comprehensive search experience. ### Frequently Asked Questions (FAQs)
What is the "Search by Report or Inscription Number" feature? This feature allows users to quickly find diamonds by entering their report number or inscription number.
Where can I use this feature? You can use this feature on the Tracr Shipments.
Will the search results show all diamond details? The search results will display key diamond details. You can click on a result to view the full details.
What if I can't find the diamond I'm looking for? Double-check the report or inscription number for accuracy. Make sure your diamond is polished. If you still can't find it, contact customer support for assistance.
### User Interface Elements * **Search Bar:** now supports diamond searches using report or inscription numbers.

Where to enter the grading report number or inscription number on the shipments page.

* **Results:** will be displayed on the table.

Results of searching for a grading report number or inscription number.

### How It Works {% stepper %} {% step %} ### Enter report or inscription number In the search field, type the diamond's report or inscription number. {% endstep %} {% step %} ### Click Search Press the "Search" button. {% endstep %} {% step %} ### View results The matching diamond(s) will appear in the data table. {% endstep %} {% step %} ### Access details Click the diamond to access the diamond's details. {% endstep %} {% endstepper %}

How to search for diamonds using a grading report number or inscription number in a shipment.

# 8. Shipments Inbound ## Shipments Inbound Read this section to understand how to view, manage and accept a shipment of diamonds. ### Overview As a retailer, you can view a list of pending diamond shipments sent to you from manufacturers. To add the diamonds in a shipment to your inventory, you must accept ownership. > **Note:** When you receive and accept ownership of a diamond in a shipment from a manufacturer, you become the owner and the diamond is transferred to your inventory. If you reject a diamond, the diamond remains in the manufacturer’s inventory. If you are a manufacturer, you can view shipments of diamonds sent from producers. You must then either accept or reject the shipment. If accepted, use the **Integration Tool** to upload diamonds against the shipment. ### Rough or Polished inbound shipments Rough or polished inbound shipments are diamond transfers from a producer or manufacturer where you have been selected as the recipient. #### View active (pending) shipments The **Rough** or **Polished** tabs lists the active shipments sent to you from a producer or manufacturer. Active shipments have diamonds which have not been transferred, rejected, or cancelled. As a manufacturer the **Rough** tab will always be visible, and the **Polished** tab will be visible if there are inbound polished shipments to work on. As a retailer the **Polished** tab will always be available and the **Rough** tab will be available if there are rough shipments to work on. * For a shipment of rough diamonds from a producer, you must either accept or reject the shipment; if accepted, you must then upload diamonds. * For a shipment of polished diamonds from a manufacturer, you must either accept or reject each diamond in the shipment. When you receive and accept ownership of a polished diamond in a shipment, you become the owner and the diamond is transferred to your inventory. To view active shipments: * From the Tracr menu, select **Shipments > Inbound**.\ The **Rough** and **Polished** tabs lists the collections of diamonds (shipments) available for transfer.

Shipments Inbound Active tab, action is required for three shipments of polished diamonds. Select three dots and then View to view details and accept or reject diamonds in the shipments.

## Columns By default, the outbound shipments table displays a standard set of columns. You can customise the display and add additional columns to view more information, as required. > **Note:** Tracr remembers your column selections for inbound and outbound shipments screens when you sign out. {% stepper %} {% step %} ### To display additional columns 1. Select **Columns**. 2. Choose the columns that you want to display. {% endstep %} {% step %} ### To remove additional columns 1. Select **Columns**. 2. Clear the checkbox next to any columns that you do not want to display. {% endstep %} {% step %} ### To reset the columns to default 1. Select **Columns**. 2. Select **Restore columns to default**. {% endstep %} {% endstepper %} **Active shipment information** For each active (pending) shipment, Tracr displays the following information: * **Sender** - The name of the sender. * **Shipment ID** - The ID assigned to the shipment when it was created. * **Date sent** - The date the transfer was sent. * **Shipment name** - The name given to the shipment when it was created. * **Diamonds** - The number of diamonds in the shipment. * **Carats** - The total number of carats for all diamonds in the shipment. * **Carat range** - The range of carat weights for all diamonds in the shipment. * **State** - Displays the integration method (*Rough* or *Polished*) selected when the shipment was created. * **Status** - The status of the shipment. * **Action required** - The shipment contains diamonds that have not been transferred, rejected, or cancelled. You need to accept or reject a rough shipment or select **View** to accept or reject diamonds in a polished shipment. * **Incomplete** - A rough shipment has been accepted and you now need to upload diamonds using the **Integration Tool**. * **Processing** - Tracr is processing one or more diamonds within a polished shipment. * **Actions** - Use one of the following actions to process the shipment: * **Accept** - For rough diamonds, select **Accept** to accept the shipment. * **Reject** - For rough diamonds, select **Reject** to reject the shipment. * **Upload diamonds** - For rough diamonds, select **Upload diamonds** to upload diamonds against the shipment using the Integration Tool. * **View** - For polished diamonds, select **View** to accept ownership of the shipment or reject the transfer of diamonds to your inventory. ### Accept or reject a shipment of rough diamonds For a shipment of rough diamonds from a producer, you must either accept or reject the shipment; if accepted, you must then upload diamonds. * Accepting the shipment starts registration. Once processed by Tracr, you will then need to upload diamond data using the **Integration Tool** or API. * Rejecting the shipment ends the registration process. Tracr notifies the sender that you have rejected the shipment. This process is irreversible. To accept a shipment of rough diamonds: {% stepper %} {% step %} ### Accept a rough shipment Next to the shipment that you want to accept, in the **Actions** column, select **Accept**.\ To confirm that you want to accept the shipment, select the **Confirm** button. {% endstep %} {% step %} ### After accepting Once accepted, you will need to upload the diamonds associated with that shipment using the **Integration Tool** or API. {% endstep %} {% endstepper %} To reject a shipment of rough diamonds: {% stepper %} {% step %} ### Reject a rough shipment Next to the shipment that you want to reject, in the **Actions** column, select **Reject**.\ To confirm that you want to reject the shipment, select the **Confirm** button. {% endstep %} {% endstepper %} ### Accept a shipment of rough diamonds from a non-De Beers producer If you are a manufacturer and want to confirm and upload the diamonds from a shipment sent by a non-De Beers producer, next to a rough shipment with the status 'Action required', select **Accept**, and then select **Confirm**. Once accepted, you will need to upload the diamonds associated with that shipment. To do this, either upload the shipment data using a CSV file and the **Integration Tool** or upload the shipment data via the API, following the same procedure used for De Beers diamonds. > **Important:** When uploading diamonds, instead of providing the box details from De Beers (such as sight, year, and box ID), you will need to provide the **Shipment ID** in the “box\_id” column. The **Shipment ID** appears on the **Active** tab, next to the **Sender**. ### Bulk accept for rough shipments You can accept multiple rough shipments at once by selecting the checkbox against each row. Where any of the shipments you've selected are able to be accepted an Accept button will be available in the action bar. If none of the shipments are able to be accepted the Accept button will not be available. Selecting the checkbox at the top of the page selects all the rows on the page. Choosing **Select All** in the action bar selects all shipments on all pages. If any of the selected shipments are available to be accepted, clicking **Accept** will open the drawer control on the right hand side of the screen. The **Selection** page will show you how many of the selected shipments are ready to be accepted, as well as how many are not ready to be accepted (if any). Clicking on the arrows to the right of each of those groups will show you which shipments are in each category.\ \ Clicking **Continue** will take you to the details page which will give you a summary of the number of shipments that will be accepted, the number of diamonds in those shipments, and the state of the shipments. Clicking **View selection** will take you back to the selection page. Clicking **Accept** will accept those shipments and begin the rough transfer process. ### Accept ownership of polished diamonds To receive polished diamonds into your inventory, you must accept ownership of the shipment. To do this, you must review details of the shipment and choose the diamonds that you want to accept or reject. > **Note:** To help identify the shipment, Tracr displays the name of the sender and shipment, the date and time sent, and the number of diamonds in the shipment on the **Active** tab. #### View shipment details You can view more information for each shipment listed on the **Active** tab prior to accepting or rejecting the shipment. To view pending shipment details: * Next to a shipment on the **Active** tab, select **View**.\ Tracr displays the **Accept Ownership of Diamonds** page, which shows the status of each diamond in the shipment. You can reject or confirm ownership of any diamonds with the status 'Action required'.

Detials for an active polished shipment. The recipient accepted and transferred one diamond and rejected another diamond; one diamond is still available for transfer.

**Pending transfer details** Descriptions of the columns on the **Accept Ownership of Diamonds** page are as follows: * **Diamonds** - The number of diamonds in the shipment. * **From** - The name of the sender. * **Shipment name** - The name assigned to the transfer when it was created. * **Date sent** - The date and time the shipment was sent. * **Tracr ID** - The ID allocated when Tracr registered the diamond. * **Shape** - The shape of the diamond. * **Carat** - The physical weight of the diamond. * **Clarity** - The clarity of the diamond, ranging from ‘FL’ (flawless) to ‘P3’ (poor quality). Clarity grades define the quantity, size, and location of inclusions in a diamond. * **Colour** - The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). * **Cut** - The diamond’s proportions, symmetry, and polish, ranging from poor to excellent. * **Status** - The status of the diamond in the shipment. * **Action required** - Tracr has confirmed the transfer from the manufacturer. You can now accept or reject the diamond. * **Transferred** - You have accepted the diamond and Tracr has transferred it to your inventory. * **Processing** - Tracr is processing your request to accept or reject one or more diamonds. * **Rejected** - You have rejected the diamond. * **Cancelled** - The sender has cancelled the transfer of the diamond. * **Actions (three dots)** - Choose whether to accept or reject the diamond: * **Accept** - Accept the diamond; it is transferred to your inventory. * **Reject** - Reject the diamond; it remains in the sender's inventory. #### Accept a diamond in a shipment You can accept all diamonds in a shipment or choose the ones that you want to accept and then reject the others. > **Note:** You can only accept a diamond if its status is 'Transfer In Confirmed'. Once accepted, the status of the diamond in the shipment changes from 'Action required' to ‘Processing’. Once complete, the status changes to 'Transferred'. {% stepper %} {% step %} ### Accept a single diamond Next to the diamond that you want to accept, in the **Actions** column, select **Accept**.\ To confirm that you want to accept the diamond, select the **Confirm** button. {% endstep %} {% step %} ### Accept multiple or all diamonds Select the checkbox next to the diamonds that you want to accept, and then at the bottom of the page, select **Accept**. To confirm, select the **Confirm** button. {% endstep %} {% endstepper %} #### Reject a diamond in a shipment You can reject a diamond if you do not want to add it to your inventory. > **Note:** You can only reject a diamond if its status is 'Transfer In Confirmed'. Once rejected, the status of the diamond in the shipment changes from 'Action required' to ‘Processing’. Once complete, the status changes to 'Rejected'. {% stepper %} {% step %} ### Reject a single diamond Next to the diamond that you want to reject, in the **Action** column, select **Reject**.\ To confirm that you want to reject the diamond, select the **Confirm** button. {% endstep %} {% step %} ### Reject multiple or all diamonds Select the checkbox next to the diamonds that you want to reject, and then at the bottom of the page, select **Reject**. To confirm, select the **Confirm** button. {% endstep %} {% endstepper %} ### Archived shipments Polished and rough shipments move from the Inbound **Active** to the **Archived** tab when they are complete. * A polished shipment is considered complete when all diamonds have either been accepted, rejected, or cancelled. * A rough shipment is considered complete when you have accepted the shipment and uploaded diamonds, rejected the shipment, or when the sender has cancelled the shipment. #### View archived shipments The **Archived** tab lists the shipments that you have accepted or rejected, and the shipments cancelled by the sender. > **Note:** Accept or reject diamonds in a polished shipment on the **Accept Ownership of Diamonds** page. Accept (and then upload diamonds) or reject a rough shipment on the **Active** tab. To view completed shipments: * From the Tracr menu, select **Shipments > Inbound**, then select the **Archived** tab.

Shipments Inbound Archived tab. Three shipments are complete, one was cancelled by the sender and one was rejected by the recipient.

## Columns By default, the outbound shipments table displays a standard set of columns. You can customise the display and add additional columns to view more information, as required. > **Note:** Tracr remembers your column selections for inbound and outbound shipments screens when you sign out. {% stepper %} {% step %} ### To display additional columns 1. Select **Columns**. 2. Choose the columns that you want to display. {% endstep %} {% step %} ### To remove additional columns 1. Select **Columns**. 2. Clear the checkbox next to any columns that you do not want to display. {% endstep %} {% step %} ### To reset the columns to default 1. Select **Columns**. 2. Select **Restore columns to default**. {% endstep %} {% endstepper %} **Archived shipment details** For each archived inbound shipment, Tracr displays the following information: * **Sender** - The name of the sender. * **Shipment ID** - The ID assigned to the shipment when it was created. * **Date sent** - The date and time the shipment was sent. * **Shipment name** - The name assigned to the shipment when it was created. * **Total diamonds** - The number of diamonds in the shipment. * **Total carats** - The total number of carats for all diamonds in the shipment. * **Carat range** - The range of carat weights for all diamonds in the shipment. * **Integration** - Displays the integration method (*Rough* or *Polished*) selected when the shipment was created. * **Status** - The status of the shipment. * **Cancelled** - The sender cancelled the shipment. * **Complete** - The transfer is complete. For a polished shipment, all diamonds in the shipment have either been transferred, rejected, or cancelled. For a rough shipment, the shipment has been accepted and diamond data has been uploaded. * **Rejected** - The recipient rejected a rough shipment or rejected all diamonds in a polished shipment. * **Actions (three dots)** - Select **View** to display the status of each diamond in the completed transfer. Only for polished shipments. #### View archived shipment details You can view more information for a completed polished shipment listed on the **Archived** tab. {% stepper %} {% step %} ### Open archived shipments From the Tracr menu, select **Shipments > Inbound**. {% endstep %} {% step %} ### View archived details On the **Archived** tab, next to a shipment, select **View**.\ Tracr displays the status of each diamond in the completed shipment. {% endstep %} {% endstepper %}

Details for a completed polished shipment. One diamond has transferred to the recipient, one was rejected and the third was cancelled by the sender.

**Archived shipment details** Descriptions of the columns on the **Archived details** page are as follows: * **Total diamonds** - The number of diamonds in the shipment. * **Total carats** - The total number of carats for all diamonds in the shipment. * **Carat range** - The range of carat weights for all diamonds in the shipment. * **Diamonds** - The number of diamonds in the shipment. * **From** - The name of the sender. * **Shipment name** - The name assigned to the transfer when it was created. * **Date sent** - The date the transfer was created. * **Tracr ID** - The ID allocated when Tracr registered the diamond. * **Participant ID** - The ID of the diamond in the participant’s ERP system, which is used to maintain the relationship between a diamond in the ERP and the same diamond in the Tracr platform. * **Shape** - The shape of the diamond. * **Carat** - The physical weight of the diamond. * **Clarity** - The clarity of the diamond, ranging from ‘FL’ (flawless) to ‘P3’ (poor quality). Clarity grades define the quantity, size, and location of inclusions in a diamond. * **Colour** - The colour of the diamond, ranging from 'D’ (colourless) to ‘Z’ (light yellow). * **Cut** - The diamond’s proportions, symmetry, and polish, ranging from poor to excellent. * **Status** - The status of the diamond in the completed polished shipment. * **Transferred** - The diamond successfully transferred to your inventory. * **Rejected** - You have rejected the diamond. Tracr returns the diamond to the sender's inventory. * **Cancelled** - The sender cancelled the transfer of the diamond. **Export an archived inbound shipment session report** You can export details of an archived shipment as a report (CSV file). To export an inbound shipment report: * On the **Archived details** page, select **Export as CSV**.\ Tracr generates the report which is downloaded and saved in your default downloads folder.\ [**View example report**](broken://pages/c648ce1e22de29247b407f1387b749fb5c45b8a6#transfer-out-session-csv) ### Search by Report/Inscription Number We are pleased to announce an upgrade to our search capabilities. You can now search using grading report numbers and inscription numbers across the Tracr Shipments. This enhancement is designed to provide greater flexibility and efficiency in your search process. Recognising that both report and inscription numbers are key identifiers, we've integrated them into our search functionality to streamline your workflow.
#### Key benefits * Saves time by using a more common reference number. * Improves search accuracy. * Enhances usability with a more comprehensive search experience. #### Frequently Asked Questions (FAQs)
What is the "Search by Report or Inscription Number" feature? This feature allows users to quickly find diamonds by entering their report number or inscription number.
Where can I use this feature? You can use this feature on the Tracr Shipments.
Will the search results show all diamond details? The search results will display key diamond details. You can click on a result to view the full details.
What if I can't find the diamond I'm looking for? Double-check the report or inscription number for accuracy. Make sure your diamond is polished. If you still can't find it, contact customer support for assistance.
#### User Interface Elements * **Search Bar:** now supports diamond searches using report or inscription numbers.

Where to enter the grading report number or inscription number on the shipment page.

* **Results:** will be displayed on the table.

Results of searching for a grading report number or inscription number.

#### How It Works {% stepper %} {% step %} ### Enter Report or Inscription Number In the search field, type the diamond's report or inscription number. {% endstep %} {% step %} ### Click Search Press the "Search" button. {% endstep %} {% step %} ### View Results The matching diamond(s) will appear in the data table. {% endstep %} {% step %} ### Access Details Click the diamond to access the diamond's details. {% endstep %} {% endstepper %} **Example from shipment outbound**

How to search for diamonds using a grading report number or inscription number in a shipment.

# 9. Diamond Fields and Values The following table provides more information for some of the diamond fields in the Tracr Data Dictionary. | Field name | Description | Allowed values | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cut\_grade | The grade of cut. |

I= Ideal, ID
EX = Excellent, EXC
VG = Very Good
G = Good
F = Fair
P = Poor

| | colour |

This field is auto-generated based on the defined colour of the diamond. It cannot be set via the API but will be returned in both the rough and polished data for any given diamond accessed via the API.

For white diamonds the value will be the same as the defined colour (D-Z scale).

For fancy coloured diamonds (those with at least fancy\_colour and fancy\_colour\_intensity) the value will be a human readable representation of the diamonds fancy colour (e.g. Fancy Dark Greenish Blue).

|

Examples:

White Diamond: D

Fancy Colour: Fancy Dark Greenish Blue

| | colour | The colour of the non-fancy polished diamond. |

D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
For fancy colours, use the fancy colour columns.

| | clarity | The relative absence of inclusions and blemishes. |

FL, IF, LC, VVS1, VVS2, VS1, VS2, SI1, SI2, SI3, I1, I2, I3, P1, P2, P3
For fancy coloured stones without clarity, enter "N" for none.

| | symmetry | The symmetry of the polished diamond. |

I = I, ID
EX = Excellent, X
VG-EX = Very Good to Excellent, VGEX
VG = Very Good, V, V. Good, V.G
G-VG = Good to Very Good
G = Good
F-G = Fair to Good
F = Fair
P= Poor

| | polish\_quality | The quality of the polished diamond. |

I = I, ID
EX = Excellent, X
VG-EX = Very Good to Excellent, VGEX
VG = Very Good, V, V. Good, V.G
G-VG = Good to Very Good
G = Good
F-G = Fair to Good
F = Fair
P= Poor

| | fluorescence\_intensity | The colour of the diamond when viewed under long-wave ultraviolet light. |

B = Blue, BL
W = White, WH
Y = Yellow, YL
O = Orange, OR
R = Red
G = Green, BG
N = None, NIL, NON

| | fancy\_colour | The colour of the diamond if fancy. |

BK = Black
B = Blue
BN = Brown
CH = Chameleon
CM = Champagne
CG = Cognac
GY = Gray, Grey
G = Green
O = Orange
P = Pink
PL = Purple
R = Red
V = Violet
Y = Yellow
W = White, WH
X =Other, OT

| | fancy\_colour\_intensity | The intensity of fancy colour. |

F = Faint
VL = Very Light
L = Light
FCL, FL = Fancy Light
FC = Fancy, FC
FCD = Fancy Dark
I = Fancy Intense
FV = Fancy Vivid
D = Fancy Deep, DP, Deep

| | girdle\_condition | The condition of the girdle. |

P = Polished
F = Faceted
B = Bruted
The girdle is the section of a diamond that separates the top part of the diamond (the crown) from the bottom part (the pavilion).

| | culet\_size | The size of the culet. |

EL = Extremely Large
VL = Very Large
L = Large
SL = Slightly Large
M = Medium
S = Small
VS = Very Small
N = None
The culet is the facet at the very bottom of the diamond.

| | culet\_condition | The condition of the culet. |

P = Pointed
A = Abraded
C = Chipped

| # 10. Example Reports ## Inventory: Export report
## Integration Tool: Missing files report
## Integration Tool: Failed files report
## Integration Tool: Unexpected files report
## Integration Tool: Transaction report
## Integration Tool: Full transaction report
## Integration monitoring report
## Transfer out session CSV
# 11. Tracr Loader Tracr Loader is a command line tool to upload diamond data to Tracr using the same CSV files as the Integration Tool. ## Install and configure Tracr Loader {% stepper %} {% step %} ### Deploy the executable file The executable file is available in the Integration toolkit (go to **Tracr Management Portal > Integration > Integration Tool > Integration toolkit**). Once downloaded, move the file to the target folder. For example, on Windows: {% code title="Windows example" %} ``` C:\tools\tracr ``` {% endcode %} {% endstep %} {% step %} ### Setup the environment variables #### Add Tracr Loader to the PATH On Windows, open a **Command Prompt** and type: {% code title="Add to PATH (Windows)" %} ```bat setx PATH "%PATH%;C:\tools\tracr\" ``` {% endcode %} #### Declare the following variables * TRACR\_TC\_APPROVAL\ You must set this variable to yes. It means you accept and agree to the Terms and Conditions (). * TRACR\_SECRET\ Authentication Token. Please contact for more details. * TRACR\_URL\ The URL to the Data Integration Tool service. Please contact for more details. On Windows, open a **Command Prompt** and type: {% code title="Set required variables (Windows)" %} ```bat setx TRACR_TC_APPROVAL "yes" setx TRACR_SECRET "" setx TRACR_URL "" ``` {% endcode %} {% endstep %} {% endstepper %} ## Usage On Windows, open a **Command Prompt** and type: {% code title="Basic usage" %} ``` tracer-loader.exe --integration --csv --batch --session_id ``` {% endcode %} Command-line arguments Required: * -i, --integration \[rough,split,polished,transfer] * -c, --csv full path to the csv file Optional: * -h, --help show this help message and exit * -v, --version show program's version number and exit * -b BATCH, --batch BATCH * -s SESSION\_ID, --session\_id SESSION\_ID ## Upload new data with Tracr Loader {% stepper %} {% step %} #### Prepare the data Like the Data Integration Tool, create a CSV file to declare all the metadata of the diamonds to register. Create the CSV file in a folder per session. The folder needs to contain all the additional files to be submitted (images, scans, reports, videos, and so on). You can organise the additional files in subfolders, or place all files together in the main folder. {% endstep %} {% step %} #### Call Tracr Loader For example, on Windows, open a **Command Prompt** and type: {% code title="Upload example" %} ``` tracr-loader.exe --csv C:\data\tracr\box_341\rough_box_341.csv --integration rough ``` {% endcode %} Where: * C:\data\tracr\box\_341 is the folder which contains the CSV file and the additional files for rough diamonds. * rough\_box\_341.csv is the CSV file. {% endstep %} {% endstepper %} ## Logs and output Once a job is completed, the logs will be available in the subfolder **tracr\_output**. For example: {% code title="Log file example" %} ``` C:\data\tracr\box_341\tracr_output\tracr-loader-.log ``` {% endcode %} ## Recover a failed session If Tracr Loader is interrupted when uploading files to Tracr, you can call Tracr Loader in recovery mode. {% stepper %} {% step %} #### Find the session ID of the failed attempt Open the logs of the jobs in the **tracr\_output** subfolder and identify the line with the session ID. For example: {% code title="Log excerpt" %} ``` .\tracr_output\tracr-loader_20201204-131417.log ... 04-Dec-20 13:14:18 - INFO - Tracr session id for new loader run is 44c978ad-957a-4bf6-9ce8-e2b63ddac305 ... ``` {% endcode %} {% endstep %} {% step %} #### Pass the session ID Tracr Loader accepts an additional parameter --session\_id to recover a previous run. {% code title="Recover command" %} ``` tracer-loader.exe --csv --integration --session_id 44c978ad-957a-4bf6-9ce8-e2b63ddac305 ``` {% endcode %} Once Tracr Loader starts in recovery mode, it will identify the files to upload and complete the process. When all files are uploaded, Tracr Loader submits the session automatically. {% endstep %} {% endstepper %} # 12. Editing Assets Every diamond registered on Tracr can have multiple associated assets, including images, videos, scans and plans. The 1.35 release introduced a more flexible way to manage these assets: they can now be added, updated or removed at any point in the diamond’s lifecycle, rather than only while the diamond is in the lifecycle stage to which the asset relates. For example, rough stage images can be managed after the diamond has moved beyond the rough stage. Scans used for objective verification are the exception. While a diamond is rough, changing or removing a scan removes its rough objective verification state, and adding a new scan causes that state to be recalculated. Once the diamond has been split or polished, its rough scan cannot be changed. Each asset can be assigned to a gallery. For example, images can be displayed in the rough, split or polished gallery on the diamond details page in the Portal, and in the appropriate gallery in Diamond Experience once the diamond is polished, inscribed and unlocked. An asset can also be marked as the hero asset. This image or video appears at the top of the diamond details page and on the Your Diamond page in Diamond Experience. An asset does not have to be assigned to a gallery. If no gallery is set, the asset is not displayed, but it remains attached to the diamond, is returned by the API and is transferred with the diamond. When you add an asset to the top rough diamond, it is shared with the child diamonds created from that rough. The asset appears in the rough gallery for all child diamonds that are held by the participant who added the asset at the time it is added. If you later remove the asset from the top rough, it is removed from those child diamonds’ rough galleries, unless a child diamond has already been transferred and retains its own copy. When you add an asset directly to a child diamond and choose the rough gallery, the asset is specific to that child diamond. It appears in that child diamond’s rough gallery only. It does not appear for other diamonds made from the same rough, including child diamonds that already exist or are created later. ### Example API flows The following examples show the main asset-management operations. Replace \, \ and the IDs with values from your environment. ### Add an image asset To add an image to a diamond you use the /v2/diamond-asset/image end point with multipart/form-data. The diamond\_stage describes the lifecycle stage the asset relates to, while gallery controls where it is displayed. Diamond stage can be one of: rough, or polished.\ Image Type can be one of: default, 3d, b2b, heart, arrow, aset\_scope, plot, face\_up, dark\_field, ideal\_scope, fluorescence, inclusion\_map, diagram, or other #### **Request** Make a request to `/v2/diamond-asset/image` with the required and recommended fields > **Required Fields** > > * Diamond ID > * File > > **Recommended Fields** > > * Diamond Stage > * Gallery > * Gallery Priority > * Image Type > * Is Hero > * Label {% tabs %} {% tab title="Response" %} | Key | Value | | ----------------- | -------------------------- | | **diamond\_id** | c5scudab4autgb1dhpagyg5l | | **file** | /diamonds/defaultimage.jpg | | diamond\_stage | rough | | gallery | rough | | gallery\_priority | 10 | | image\_type | default | | is\_hero | true | | label | Default Image | | {% endtab %} | | {% tab title="Response" %} {% code title="Response (201)" %} ```json { "asset_type": "image", "content_hash": "string", "created_at": "2026-09-02T14:30:17.158Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "avif", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "image_type": "default", "is_hero": false, "label": "string", "updated_at": "2026-09-02T14:30:17.158Z" } ``` {% endcode %} {% endtab %} {% endtabs %} If is\_hero is true, the asset becomes the diamond’s hero asset and any other hero asset for that diamond is unset. #### HTTP response status code | Code | Descriptions | | ---- | ------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource. | | 401 | Forbidden: The application does not have sufficient permissions for this operation. | | 422 | Unprocessable Entity, request JSON body is not as per specification | | 500 | Internal Server Error. If this error persists please contact the Platform Admin team. | ### List assets Retrieve all non-deleted assets, optionally filtering the results by diamond, asset type, gallery, lifecycle stage, hero status or creation and update dates. Call `/v2/diamond-asset/` with any combination of the below filter parameters > **Recommended Fields** > > * diamond\_id\_\_in > * asset\_type\_\_in > * is\_hero > * diamond\_stage\_\_in > * diamond\_stage\_\_isnull > * gallery\_\_in > * gallery\_\_isnull > * created\_at\_\_gte > * created\_at\_\_lt > * updated\_at\_\_gte > * updated\_at\_\_lt > * page > * size Call `/v2/diamond-asset/` {% tabs %} {% tab title="Request" %} `/v2/diamond-asset/?diamond_id__in=&asset_type__in=image,video&gallery__in=rough&is_hero=true` {% endtab %} {% tab title="Response" %} {% code title="Response (200)" %} ```json { "next": "string", "page": 1, "pages": 0, "previous": "string", "results": [ { "asset_type": "image", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "avif", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "image_type": "default", "is_hero": false, "label": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "video", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "mov", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "scan", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "ply", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "scan_device_manufacturer": "string", "scan_device_model": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "scan_report", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "string", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "scan_device_manufacturer": "string", "scan_device_model": "string", "scan_software_name": "string", "scan_software_version": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "plan", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "mme", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "plan_software_manufacturer": "string", "plan_software_name": "string", "plan_software_version": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "plan_report", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "string", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "plan_software_manufacturer": "string", "plan_software_name": "string", "plan_software_version": "string", "scan_device_manufacturer": "string", "scan_device_model": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "inscription_number", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "json", "filename": "string", "gallery": "rough", "gallery_priority": 0, "graded_date": "string", "grader_inscription_no": "string", "grading_lab": "string", "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "three_d_plan", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "polished_three_d_plan_content_hash": "string", "polished_three_d_plan_extension": "string", "polished_three_d_plan_filename": "string", "rough_three_d_plan_content_hash": "string", "rough_three_d_plan_extension": "string", "rough_three_d_plan_filename": "string", "updated_at": "2026-09-03T14:48:35.682Z" }, { "asset_type": "supplementary", "content_hash": "string", "created_at": "2026-09-03T14:48:35.682Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "string", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "is_hero": false, "label": "string", "updated_at": "2026-09-03T14:48:35.682Z" } ], "total": 0 } ``` {% endcode %} {% endtab %} {% endtabs %} #### HTTP response status codes | Code | Description | | ---- | ------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource. | | 403 | Forbidden: The application does not have sufficient permissions for this operation. | | 422 | Unprocessable Entity, request JSON body is not as per specification | | 500 | Internal Server Error. If this error persists please contact the Platform Admin team. | ### Get one asset To retrieve an asset, use the `/v2/diamond-asset/` end point to retrieve the ID of the asset you want to retrieve, and then use that ID to retrieve to the asset. Call `/v2/diamond_asset/{diamond_asset_id}` > **Required Fields** > > * diamond\_asset\_id {% tabs %} {% tab title="Request" %} `/v2/diamond-asset/` {% endtab %} {% tab title="Response" %} {% code title="Response (200)" %} ```json { "asset_type": "image", "content_hash": "string", "created_at": "2026-09-03T15:35:19.813Z", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "diamond_stage": "polished", "extension": "avif", "filename": "string", "gallery": "rough", "gallery_priority": 0, "id": "e1mv3nn4n10kd1lw6mde6sums", "image_type": "default", "is_hero": false, "label": "string", "updated_at": "2026-09-03T15:35:19.813Z" } ``` {% endcode %} {% endtab %} {% endtabs %} #### HTTP Response Status Codes | Code | Description | | ---- | ------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource. | | 403 | Forbidden: The application does not have sufficient permissions for this operation. | | 422 | Unprocessable Entity, request JSON body is not as per specification | | 500 | Internal Server Error. If this error persists please contact the Platform Admin team. | If the asset does not exist or has been deleted, the API returns 404 Not Found. ### Delete an asset To delete an asset, send its asset ID to the bulk-delete endpoint. Although the endpoint supports multiple assets in one request, this example deletes one asset. A successful request returns a result for each asset. If the asset has already been deleted, the response still reports success. Call `/bulk/diamond-asset/delete` > **Required Fields** > > * asset\_id {% tabs %} {% tab title="Request" %} | Key | Value | | ------------ | ------------------------- | | asset\_id | e1mv3nn4n10kd1lw6mde6sums | | {% endtab %} | | {% tab title="Response" %} {% code title="Response (200)" %} ```json { "results": [ { "diamond_asset_id": "string", "diamond_id": "e1mv3nn4n10kd1lw6mde6sums", "errors": [ { "error_code": "diamond_asset_not_found", "message": "string" } ], "status": "success" } ] } ``` {% endcode %} {% endtab %} {% endtabs %} The API may return a different status when the asset cannot be deleted, for example if it does not exist, belongs to an archived or transferred diamond, is currently in a transfer, is a legacy asset, or has an unsupported asset type. | Code | Description | | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource. | | 403 | Forbidden: The application does not have sufficient permissions for this operation. | | 409 | The request was unable to be processed due to one of the diamond assets in the request (or the asset's related diamond) being updated by another process. | | 422 | Unprocessable Entity, request JSON body is not as per specification | | 500 | Internal Server Error. If this error persists please contact the Platform Admin team. | # Lab Eligibility {% hint style="warning" %} Lab Eligibility has been updated from Release 1.32. **This is the correct documentation.** {% endhint %} ## Overview Tracr has been working on integrations with trusted grading labs which will allow you to submit a diamond to a grading lab with a Tracr ID to link your grading report to the Tracr digital record. There is also the option with some labs (GIA, IoD) to add your Tracr provenance to the grading report. A diamond needs to have a few requirements met to be eligible for grading through one of our integrations. These include: being a polished diamond and having a supported scan report that Tracr can process. The Portal and Tracr API includes the `LAB ELIGIBLE` status and the breakdown of the eligibility requirements. ## How do I work out if my diamond is eligible for grading? ### Inventory Tracr has provided a column with a `LAB ELIGIBLE` status in the inventory. You are also able to filter on the status and export the result. #### Column There is a column within the inventory, labelled `LAB ELIGIBLE`. Within the column, each polished diamond will have a parent status icon. The parent status icons have been designed to quickly identify diamonds that are either Eligible, or require user input. The options are: 1. Eligible 2. Missing report 3. Missing data 4. Invalid report 5. Not processable
**How will I know what I need to add to the diamond to make it eligible?** If a diamond has a badge with a green checkmark and the word `Eligible` your diamond is eligible for grading. If a diamond has a Error icon or a Warning icon, you will be required to add a scan report that is processable. The badges are hoverable and will give you a popover with more information into what you need to do to fix the diamond record for grading. Below shows an example of the popover for each status. {% tabs %} {% tab title="Eligible" %}
{% endtab %} {% tab title="Missing report" %}
{% endtab %} {% tab title="Missing data" %}
{% endtab %} {% tab title="Invalid report" %}
{% endtab %} {% tab title="Not processable" %}
{% endtab %} {% endtabs %} #### Filtering You will be able to filter your inventory by the `LAB ELIGIBLE` status.
#### How will the Lab eligible column show on the Export Report? There will be a column `Lab Eligible`, with status options: 1. Eligible 2. Missing report 3. Missing data 4. Invalid report 5. Not processable ### Diamond Details The `LAB ELIGIBLE` status is available on the diamond details. ## Lab Eligible Requirements ### Polished Diamond A diamond needs to be polished in your Tracr inventory to be eligible for grading. #### How to upload a polished diamond? Please follow the guidelines detailed [here](https://docs.tracr.com/docs/user-documentation/hm71l585o5ed3-integration#prepare-a-polished-diamond-dataset) to correctly upload a polished diamond. ### Supported Scan Report A diamond needs a supported scan report to be eligible for grading. Tracr currently supports Sarine XML scan reports and Helium HTM and HTML scan reports. > We support Helium Carbon versions that generate a .Ox2z file extension, beginning with Carbon version 1.0.\ > For the latest version, please visit the [official Helium Website](https://lexusindia.in/#software). Example scan reports: * [Sarine XML](https://jcpackages.tracr.network/integration/demo_polished_1.xml) * [Helium HTML](https://jcpackages.tracr.network/integration/example_helium.html) #### Prepare a polished diamond dataset Follow these steps to prepare polished diamond data for upload to Tracr. **Sarine Instructor** If you are using **Sarine Instructor** to provide a scan for polished diamonds, you need to generate an XML report and an STL export. Use the template provided by Tracr to export the report for each diamond. In the CSV file, Tracr needs the STL file in the column **scan**, and the XML report in the column **scan\_report**. [Download Sarine export templates](https://jcpackages.tracr.network/integration/Polished_Diamond_Sarine_Instructor_Export_Template.zip) **Sarine Instructor: Extracting data for polished diamonds** Extracting the required traceability data for polished diamonds using Sarine Instructor software is compatible with the following hardware: * DiaMension * DiaMension HD * DiaMark HD * DiaMark™ HD Once a polished diamond is scanned and the file loaded onto the Instructor software, you can extract the following data points: * Diamond Measurements (using a provided template) * Diamond 3D Model The following instructions describe how to extract the required data. **1. Install the Tracr templates for polished diamonds** * Place the Tracr template file, e.g. ‘TracrPolishedTemplate.txt’, within the Sarine Instructor Export folder:\ Sarine Technologies/Instructor/Export/ **2. Export diamond measurements** 1. Open the stone .srn file in Sarine Instructor. 2. Point to the **Export** icon, and select the corresponding Tracr template, for example, ‘TracrPolishedTemplate.txt’. 3. In the **Save As** dialog box, save the measurements as ‘YourStoneName.xml’. **3. Export the mesh** 1. Open the stone .srn file. 2. Point to the **Save** icon, and select **Save as**. 3. In the **Save As** dialog box, select ‘\*.stl’ as the file type and save the mesh with the stone's name. **Helium software** If you are using **Helium software** to provide a scan for polished diamonds, you need to generate an HTM/HTML report and an STL export. Use the template provided by Tracr to export the report for each diamond. There are two types of Helium template: * Specific shape, only for a handful of shapes with additional information. * Generic, less information but you can use this template for all shapes. | Shape | Recommended template | | -------- | --------------------------------- | | Princess | HTML\_REPORT\_FOR\_PRINCESS | | Radiant | HTML\_REPORT\_FOR\_RADIANT | | Heart | HTML\_REPORT\_FOR\_Any\_Cut | | Pear | HTML\_REPORT\_FOR\_Any\_Cut | | Oval | HTML\_REPORT\_FOR\_OVAL\_MARQUISE | | Marquise | HTML\_REPORT\_FOR\_OVAL\_MARQUISE | | Cushion | HTML\_REPORT\_FOR\_CUSHION | | Emerald | HTML\_REPORT\_FOR\_STEP\_CUT | In the CSV file, Tracr needs the STL file in the column **scan**, and the HTM/HTML report in the column **scan\_report**. For more information about exporting using a Helium Polish Scanner, please refer to the [Helium Polish Scanner - Settings for Export (PDF)](https://www.lexusindia.in/download/download-files/HELIUMPOLISH_SETTINGS_FOR_EXPORTS.pdf). [Download Helium templates](https://jcpackages.tracr.network/integration/helium_templates.zip) {% hint style="warning" %} **Please note:** * Before uploading polished diamond data, please make sure that you register the parent diamond on Tracr. * To verify the polished diamond, a 3D scan and the report of the scan of the diamond are crucial. * Providing the images and videos is optional, however, this will greatly improve the Diamond Experience. * Add the grading document to complete the polished digital asset. {% endhint %} To populate a polished diamond CSV file: 1. Download the polished CSV file template (**Integration Tool > Integration toolkit > CSV Templates**). 2. Populate the CSV file - one row per diamond. 3. It is recommended that you download and use the Data Dictionary (**Integration Tool > Integration toolkit > Data dictionary**) to help you to populate the CSV file. Filter the Data Dictionary by "Stone State = Polished". Ensure that you populate fields with the column "Required = true". ### Processing Scan Report A diamond needs a supported scan report that Tracr can **process** for the shape submitted to be eligible for grading. > What the process checks:\ > \ > **Shape:** It verifies that the declared shape is a supported shape.\ > \ > **Scan Report:** It confirms that the uploaded scan report is valid for the shape submitted. We need specific fields from the scan report to compare to the measurements the grading lab submits. If a diamond's scan report is processable, it **does not** ensure a diamond will be successfully graded. ## FAQs
How can I tell if my diamond is eligible for grading? You will be able to know if your diamond is eligible for grading if it has a checkmark.
# Grading your diamonds How to send a diamond with a Tracr ID to a grading lab using the Grading Integration Service ("GIS") to access additional features and efficiency. The Grading Integration Service was designed to provide greater efficiency in the grading process by working directly with the labs to provide third party verified grading data to your Tracr record. ## Participating grading labs * GIA * Institute of Diamonds (formally IIDGR) ## Why should I send my Tracr ID to the grading lab? * Grading labs will directly update your Tracr record with the grading report, inscription number(s) and all grading data including proportions, measurements and inclusion plotting (if applicable). * Attach Tracr provenance to partner grading reports by accessing services such as GIA Prov-T. * Only diamonds sent to participating labs will receive the additional grading page on Tracr.\ Please see this sample of the grading page for a GIA Prov-T graded diamond: ## How does the Grading Integration Service work? The integration works through three key steps: Verification, Validation, Update. We do this to ensure there are enough touchpoints between Tracr and the grading lab to be confident it is the same diamond before the grading lab updates the grading data on your behalf. {% stepper %} {% step %} ### Verification The verification step allows the lab to check that the diamond that you have submitted to the lab is the same diamond you have registered on Tracr. This is done using the data (shape, carat weight) that you upload onto Tracr. {% endstep %} {% step %} ### Validation The validation step compares your uploaded scan report on Tracr against the lab measurements. If a diamond **passes validation**, the diamond record can be updated. If a diamond **fails validation** you can decide to: * request the diamond be returned for you to rescan, and to resubmit following the same steps, * continue with grading service without the update to Tracr and you upload the grading details manually post grading, or, * remove the diamond from the grading process. {% endstep %} {% step %} ### Update Once a diamond has passed the validation step, and the grading lab has provided you with the results, the lab can then upload the grading report, inscription number(s) and supporting metadata associated with the diamond. {% endstep %} {% endstepper %} ## How to upload your polished diamonds to Tracr for grading? {% stepper %} {% step %} Upload your polished diamond using the current process ensuring to include the shape, carat weight and a processable scan report. {% endstep %} {% step %} Submit the polished Tracr ID in the correct place when ordering the lab service. Example scan reports: * [Sarine XML](https://jcpackages.tracr.network/integration/demo_polished_1.xml) * [Helium HTML](https://jcpackages.tracr.network/integration/example_helium.html) {% endstep %} {% endstepper %} > You may need to select additional services from the laboratory. ## Partner Labs ### Gemological Institute of America (GIA) The Gemological Institute of America (GIA) is a nonprofit institute based in Carlsbad, California. It is dedicated to research and education in the field of gemology and the jewelry arts. Founded in 1931, GIA's mission is to protect buyers and sellers of gemstones by setting and maintaining the standards used to evaluate gemstone quality. #### Prov-T, powered by Tracr™ GIA provides a direct link to Tracr provenance data via a QR code on their Dossier or Diamond Grading Report - an add on service called Provenance, powered by Tracr™ (GIA Prov-T). [Tracr diamond experience example](https://search.tracr.com/nt3jg0wxt72dx5uuz145cb6p/diamond) [GIA Report Check](https://www.gia.edu/report-check?reportno=2231666850) **GIA Submission Instructions** Submitting via CSS API Web Service to GIA {% stepper %} {% step %} * You must request PROV-T in addition to DG or DOSS services. * You must provide a valid Tracr\_ID as part of the create job query. * Complete Job Creation as usual. {% endstep %} {% endstepper %} Submitting via Excel Import File to GIA {% stepper %} {% step %} * You must request PROV-T in addition to DG or DOSS services. * You must provide a valid Tracr\_ID in the correct column. {% endstep %} {% endstepper %} **Known Issues and Workarounds** 1. Lab Eligibility 2. Unsupported Shapes **1. Lab Eligibility** A diamond needs to be a live polished diamond, with a polished scan report in a format Tracr can process. **2. Unsupported Shapes** For the particular diamond shapes listed below in the "Actual Shape" column, the integration requires the participant to submit the shape to Tracr and GIA in the specific format described in the table below. We're actively working to support these additional shapes so that you won't need to follow this table in future. The shapes currently supported by the integration are: Cushion, Emerald, Heart, Marquise, Oval, Pear, Princess, Radiant, Round. If your diamond is not one of the supported shapes above, please follow the guidelines below to submit the diamond to the lab: | Actual Shape | Upload it to Tracr as | Upload it to GIA as | Graded Shape will appear as | | -------------- | --------------------- | ------------------- | -------------------------------------- | | Modified Round | Round | Round | Modified Round | | Princess | Princess | Square | Princess | | Asscher | Emerald | Emerald | Asscher | | Radiant | Radiant | Square | Radiant | | Rectangle | Princess | Rectangle | Rectangle | | European Cut | Round | Round | Old European Brilliant | | Square | Princess or Radiant | Square | Square | | Square | Princess or Radiant | Square | Cut-cornered Square Modified Brilliant | ### De Beers Institute of Diamonds (IoD) Utilising over 130 years of experience, De Beers Institute of Diamonds exclusively grade only natural and untreated diamonds. Their grading combines 21st century technology and techniques with the leading industry standards. This combination of innovative grading systems and transparent published standards, ensures unparalleled accuracy and global consistency in their grading. #### Submitting via Excel Import File to IOD {% stepper %} {% step %} 1. Login to IoD Client Portal to download the updated Import file: {% endstep %} {% step %} 2\. Fill in the Import file and make sure to provide a valid Tracr\_ID. {% endstep %} {% endstepper %} ## Frequently Asked Questions (FAQs)
What is "GIS"? The Grading Integration Service (GIS) allows grading labs to upload grading data to a diamond record on Tracr.
What is required to claim Tracr provenance on a grading report? Diamonds need to be polished and unlocked on Tracr by you prior to the grading lab retrieving provenance for a Tracr diamond.
What grading labs is Tracr partnered with? GIA\ IoD
What makes a diamond eligible for grading through GIS? A diamond needs to be polished, with a scan report Tracr can process. We do not support grading deleted diamonds, or the grading of rough or split diamonds.
What scan reports can Tracr process? * [Sarine XML](https://jcpackages.tracr.network/integration/demo_polished_1.xml) * [Helium HTML/HTM](https://jcpackages.tracr.network/integration/example_helium.html)
Do I need to unlock my diamond on Tracr to access this service? Yes, in order for the grading lab to retrieve the provenance on Tracr the diamond needs to be unlocked.
When do I need to unlock my diamond? Tracr recommends to unlock the diamond before submission to the grading lab to ensure a smooth and efficient process.
Why am I seeing 'Processing Scan Report' status as failed? This could be because the shape declared in Tracr isn't on our supported list, or the uploaded scan report isn't valid for the shape submitted, or a combination of both.
# Tracr Rough Check Read this article to learn more about Tracr Rough Check. ## You need to know * Rough Check determines whether there is a match between a scan of a rough diamond uploaded by a producer and a scan of a rough diamond a manufacturer uploads to Tracr. * Rough Check matching is performed using Diamond ID, a core service in the Tracr platform ecosystem primarily tasked with validating, verifying, and identifying diamonds. * The results of a Rough Check appear in the Tracr Inventory and the Diamond Details page and in data about a diamond returned using the Tracr API once the diamond is polished and unlocked. * A successful Rough Check is mandatory to be able to split and polish a rough diamond over 2cts. * Rough Check status is carried downstream from the original rough diamond to later diamond lifecycle states. ## What is Rough Check? Rough Check provides additional confidence in the provenance of a diamond recorded on the Tracr platform. The Rough Check process uses Diamond ID to evaluate whether the information about a rough diamond recorded by one party (for example, a manufacturer) matches, within a given tolerance, a rough diamond recorded by another party (for example, a producer). ## Where do the results of Rough Check appear? You will be able to see a Rough Check against a diamond in your Inventory once a diamond is polished and unlocked. Prior to the diamond being polished and unlocked Rough Check will be shown as `Restricted` in the inventory, and `false` in the API. Once the diamond is polished and unlocked the outcome of Rough Check will be available. ### Inventory All Tracr inventory screens display a **Rough Check** column. #### Rough and Split Inventory For rough which don't yet have a scan `Missing Scan` is displayed. Once a scan is uploaded the rough check process is performed, the outcome of which is `Restricted`. #### Polished Inventory Once the diamond is polished and unlocked the Rough Check value is displayed. A green tick in the **Rough Check** column indicates that a scan was uploaded to Tracr by the manufacturer with the diamond, which Tracr has checked and matched against the producer's scan of that diamond before it was transferred to the manufacturer. Rough Check status is carried downstream from the original rough diamond to later diamond lifecycle states. The following example shows a Rough Check against two diamonds in the Polished Inventory. The other diamonds have not been matched.

Rough Check in the polished inventory.

### Diamond Details The Diamond Details page also shows the result of a Rough Check for diamonds which are polished and unlocked. Open the Diamond Details page for a diamond and scroll down to the **Rough** section.

Rough Check in the Diamond Experience.

A green tick next to **Rough Check** indicates a match between a manufacturer’s and producer’s scan of that diamond. Rough and split diamonds will always show `Restricted` as the **Rough Check** value. Note that if a rough diamond is matched, then split, then polished and transferred, the Rough Check mark appears at every point in the chain, in the **Rough** lifecycle state section of the Diamond Details page. ### Tracr API Rough Check status is exposed as a `rough_check` field in PCS-API. Pass the Tracr Diamond ID to the `/diamonds` endpoint to return data about a diamond. The `rough_check` field in the response indicates whether that rough diamond has been verified by Tracr Rough Check. Prior to the diamond being polished and unlocked the `rough_check` field will show `false` regardless of the Rough Check state. ## How does Rough Check work? Rough Check uses advanced Machine Learning algorithms to understand features and accurately identify and compare diamond characteristics between a rough diamond received by a manufacturer and a rough diamond recorded by a producer. Central to this process is a detailed scan of the surface of each diamond, which provides a unique digital fingerprint. Rough stone matching primarily consists of the following sequence: {% stepper %} {% step %} ### Filtering by producer batch/lot/box number This provides a set of diamonds to be matched against the manufacturer’s diamond. Where more than one diamond is provided, the algorithm searches the available diamonds to find the best match. {% endstep %} {% step %} ### Filtering by weight and structural features Carat measurement errors can occur due to inconsistency between participant scanning machines or other factors such as machine calibration and location, and the algorithm adaptively targets stones within specific ranges to further reduce the search set. {% endstep %} {% step %} ### Surface alignment checks A surface alignment check determines how well two scans overlap geometrically, providing a clear measure of similarity. Usually, if the scans are generated with high-accuracy machines then a much better alignment is observed. {% endstep %} {% endstepper %} ## What is required to get a Rough Check? Rough Check matching requires 3D scans of diamonds uploaded when a producer and manufacturer register diamonds on Tracr. Tracr requires high-quality scans that are sufficiently detailed to allow matching and identification. Where a match is found within a given tolerance, the Rough Check is shown. {% hint style="warning" %} Important: To ensure sufficient scan quality for accurate matching, scans must be uniform and have at least 6000 vertices. {% endhint %} Note that Tracr cannot always guarantee a match when the data provided by participants is suboptimal. Factors such as significant weight discrepancies, physical alterations before scanning, or low-quality 3D scans can reduce confidence in a match, leading the match to fail. One of the key metrics for assessing matching success is the matching rate, which represents the number of diamonds successfully identified compared to the total number provided. While Tracr will accept licensed 3D scans in standard formats from any scanner meeting Tracr’s minimum requirements, different types of scanners and their settings can affect the matching rate, and every stone, box or shipment has its own particularities. # Video and image assets ## Requirements | Rough | Split | Polish | | --------------- | ----------- | ------------------ | | Rough Scan | Split Image | Polish Scan File | | Rough Image | | Polish Scan Report | | Rough 360 Video | | Polish Image | | | | Polish 360 Video | {% hint style="info" %} Note: Asset feasibility may vary depending on size. We recommend collaborating closely with your suppliers to ensure a rich and engaging asset experience. {% endhint %} ## Acceptable diamond photography and videos Please refer to the manufacturer’s website for examples of how to create videos of your diamonds. ### 360 video direction When taking the video select the ‘ideal’ option as the speed for the video.

Recommended view rough, vertical 360, Right: Recommended view polished, vertical 360.

### Crop Try to ensure that the crop is as close to the diamond edges as possible otherwise the machinery will appear in the video.
## Not acceptable diamond photography and videos | Issue | Example | | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Polished asset taken under a UV light; it must be taken under a white light. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2FF3Bfqk0A74XUcdbUNNve%2F685970a1-1999-4640-95ae-67a70c606738.png?alt=media\&token=8eb5376c-2d72-4897-a820-76839a930f99) | | Polished video on a platform instead of a 360 side view. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2FRe8rBLrri5IFEULrrl0w%2F83453778-cbe7-4993-9005-71921345d2b3.png?alt=media\&token=8e60a6c6-5c89-4560-a63f-80a09f9167c6) | | Rough video with planning/pen marks, orientated on a platform instead of 360 side view. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2Fgx9F7BueOABZ0AvNyBVt%2Fb4befd77-e24d-4c21-9656-50018257e9b2.png?alt=media\&token=73d520c8-cad2-40cc-809a-6b3884feceda) | | Rough video orientated on a platform instead of 360 side view, with dirt visible. The video is also off centre. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2F4ZIOdBx0E4nStxuCK7kG%2Fd73cc64d-5cef-41de-82ee-30eda8588cef.png?alt=media\&token=9cd24f14-564e-4dbb-ae67-daa674cb889c) | | The diamond should not have a high glare, showing colour in the asset. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2FRQEFjdBDT22cQHl6PlnB%2Fd16c1b3f-a493-4489-9e0a-15e769d61e1f.png?alt=media\&token=dd7f0a0c-e9e2-4474-90f5-0f246d13365f) | | Off centre rough image. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2F8VSwyLkLfep8MkTHTJiB%2F1c466322-ff58-4204-881d-b23dd5d092f3.png?alt=media\&token=ae1005ba-c8db-40fe-b1f0-c118c828fcf0) | | Poorly cropped rough image. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2FptxmjItvksx7fMQ6njQv%2F40369028-64dd-49da-a619-e80abebdb76f.png?alt=media\&token=5155f0b9-33f3-491c-ba82-6a532e379ffa) | | Poorly lit rough image. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2FmhRXCp8dPQbAofEaMeDJ%2F6ad2f6fe-ceaf-4af6-912b-91064651eded.png?alt=media\&token=c05727d5-12d9-40b1-ab56-b55a3120062c) | | Sarine screenshot is not allowed. | ![](https://174689295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdxsd3IyWOYfN3nRPyMfr%2Fuploads%2F8YyjWeoBB5grV6edwOx8%2F83617062-4644-4a3d-9051-ed8355173205.png?alt=media\&token=c42492bb-fb42-40dd-9675-60990e82a90a) | ## Tracr uploads ### Steps for uploading diamond’s images and video Tracr provides two methods to upload images and video assets to your diamond. {% stepper %} {% step %} ### Data Integration Tool Please refer to this article to upload additional assets when registering a diamond in Tracr. {% endstep %} {% step %} ### Tracr API Please refer to this article to upload additional assets to automate the upload using the Tracr API. {% endstep %} {% endstepper %} ### Media files format & compression #### Tracr images JPG, JPEG, BMP, PNG formats are accepted. #### Tracr videos * Format - .MP4 * Rotation - At least one full 360° rotation horizontally (clockwise or anticlockwise). * Number of frames - At least 30. * Resolution - At least 400 x 400 pixels. * Good contrast between the stone and the background. * Unobscured background, clean without clamps. * (Optional) Additional video in fluorescence. #### Scan reports In the Tracr Portal, upload the polished scan report using the ‘scan\_report’ field. Please make sure you provide a scan report in XML, HTML, or HTM format. ## Additional information If you require any additional information relating to any of the above, please contact Tracr support: # Diamond Experience ## Locked Diamond Page We have made an update to the Tracr platform designed to improve the user journey for all diamonds that are registered as polished on Tracr but currently in a "locked" state. Previously, searching for a locked diamond resulted in a "not found" page. We are replacing this with a new, informative landing page. Users will now be greeted by a page that clearly explains the diamond’s locked status and showcases the value of Tracr’s provenance and verification capabilities. {% hint style="info" %} *We currently require a diamond to be inscribed to appear; whether locked or unlocked.* {% endhint %} The locked diamond page includes a few features: * Subset of diamond data; Tracr ID, inscription number, and report number. * A form which users can optionally fill out if they are interested in unlocking the diamond (this information will be used to determine whether Tracr pursues a feature to enable downstream unlocking). * A demo of an unlocked diamond experience. * A video describing what Tracr is, and does.
#### **Impact and Benefits** * **Clearer Communication:** Rather than encountering a perceived error, you will now be able to confirm that the diamond is registered on Tracr but requires unlocking. * **Lead Generation:** The new page includes a simple interest-capture funnel, allowing us to better understand market demand and intent for unlocking specific diamonds downstream. * **Enhanced Value Proposition:** By viewing a "demo" experience of a fully unlocked diamond, users can better appreciate the benefits of the Tracr ecosystem, reinforcing trust and verification standards. ## Search by Report/Inscription Number We are pleased to announce an upgrade to our search capabilities. You can now search using grading report numbers and inscription numbers on Diamond Experience. This enhancement is designed to provide greater flexibility and efficiency in your search process. Recognising that both report and inscription numbers are key identifiers, we've integrated them into our search functionality to streamline your workflow.

Tracr Diamond Experience

### Key benefits * Saves time by using more common reference number. * Improves search accuracy. * Enhances usability with a more comprehensive search experience. ### Frequently Asked Questions (FAQs)
What is the "Search by Report or Inscription Number" feature? This feature allows users to quickly find diamonds by entering their report number or inscription number.
Where can I use this feature? You can use this feature on Diamond Experience.
Will the search results show all diamond details? The search results will display key diamond details. You can click on a result to view the full details.
What if I can't find the diamond I'm looking for? Double-check the report or inscription number for accuracy. Make sure your diamond is polished. If you still can't find it, contact customer support for assistance.
*** ### User Interface Elements * **Search Bar:** now supports diamond searches using report or inscription numbers.

Tracr Diamond Experience

* **Card view results:** helps you quickly scan and visually compare your options, particularly when multiple diamonds share the same report number from different laboratories.

Card view results when multiple diamonds can be found.

### How It Works {% stepper %} {% step %} ### Enter Report/Inscription Number In the search field, type the diamond's report number or inscription number. {% endstep %} {% step %} ### Click Search Press the "Search" button. {% endstep %} {% step %} ### View Results (Card Display) Matching diamond(s) associated with the searched number will appear as individual cards. {% endstep %} {% step %} ### View Diamond Click "View Diamond" to access the diamond experience. {% endstep %} {% endstepper %}

How to search for diamonds using a grading report number or inscription number.

# Diamond Search ## Search by Report/Inscription Number We are pleased to announce an upgrade to our search capabilities. You can now search using grading report numbers and inscription numbers on Diamond Search. This enhancement is designed to provide greater flexibility and efficiency in your search process. Recognising that both report and inscription numbers are key identifiers, we've integrated them into our search functionality to streamline your workflow.
{% hint style="info" %} Key benefits * Saves time by using more common reference number. * Improves search accuracy. * Enhances usability with a more comprehensive search experience. {% endhint %} ### Frequently Asked Questions (FAQs)
What is the "Search by Report or Inscription Number" feature? This feature allows users to quickly find diamonds by entering their report number or inscription number.
Where can I use this feature? You can use this feature on Diamond Search.
Will the search results show all diamond details? The search results will display key diamond details. You can click on a result to view the full details.
What if I can't find the diamond I'm looking for? Double-check the report or inscription number for accuracy. Make sure your diamond is polished. If you still can't find it, contact customer support for assistance.
### User Interface Elements * **Search Bar:** now supports diamond searches using report or inscription numbers.
* **Card view results:** helps you quickly scan and visually compare your options, particularly when multiple diamonds share the same report number from different laboratories.
### How It Works {% stepper %} {% step %} ### Enter Report/Inscription Number In the search field, type the diamond's report number or inscription number. {% endstep %} {% step %} ### Click Search Press the "Search" button. {% endstep %} {% step %} ### View Results (Card Display) Matching diamond(s) associated with the searched number will appear as individual cards. {% endstep %} {% step %} ### View Diamond Click "View Diamond" to access the diamond experience and see full details. {% endstep %} {% endstepper %}
# Updated Provenance Structure To better and more accurately support a diamond’s provenance and additional metadata we need to make some changes to the way we return provenance information. Below is a table that summarises the key use cases and shows the current data structure, and how the data will be structured in the future.
ProducerLifecycleLockedCountryPIJSON
De BeersRough-SingleTrueExample
De BeersRough-SingleFalseExample
De BeersRough-MultiTrueExample
De BeersRough-MultiFalseExample
De BeersPolishedYesSingleTrueExample
De BeersPolishedYesSingleFalseExample
De BeersPolishedYesMultiTrueExample
De BeersPolishedYesMultiFalseExample
De BeersPolishedNoSingleTrueExample
De BeersPolishedNoSingleFalseExample
De BeersPolishedNoMultiTrueExample
De BeersPolishedNoMultiFalseExample
Non De BeersRough-Single-Example
Non De BeersPolishedYesSingle-Example
Non De BeersPolishedNoSingle-Example
#### Current Response, De Beers Rough {% tabs %} {% tab title="Single Country, With PI" %} {% code title="" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Single Country, Without PI" %} {% code title="" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Multi Country With PI" %} {% code title="" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": False } } ``` {% endcode %} {% endtab %} {% tab title="Multi Country Without PI" %} {% code title="" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": False } } ``` {% endcode %} {% endtab %} {% endtabs %} #### New Response, De Beers Rough {% tabs %} {% tab title="Single Country, With PI" %} {% code title="" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Single Country, Without PI" %} {% code title="" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Multi Country With PI" %} {% code title="" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Multi Country Without PI" %} {% code title="" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% endtabs %} #### Current Response, De Beers Polished {% tabs %} {% tab title="Locked, Single Country, With PI" %} {% code title="Locked, Single Country, With PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Locked, Single Country, Without PI" %} {% code title="Locked, Single Country, Without PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Locked, Multi Country, With PI" %} {% code title="Locked, Multi Country, With PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": False } } ``` {% endcode %} {% endtab %} {% tab title="Locked, Multi Country, Without PI" %} {% code title="Locked, Multi Country, Without PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": False } } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country, With PI" %} {% code title="Unlocked, Single Country, With PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "BW", "country_code": None, "mine_name": None, "is_locked": False, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country, Without PI, " %} {% code title="Unlocked, Single Country, Without PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "BW", "country_code": None, "mine_name": None, "is_locked": False, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Multi Country, With PI" %} {% code title="Unlocked, Multi Country, With PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "DTC", "country_code": None, "mine_name": None, "is_locked": False, "is_country_code_available": False } } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Multi Country, Without PI" %} {% code title="Unlocked, Multi Country, Without PI" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "BW", "country_code": None, "mine_name": None, "is_locked": False, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% endtabs %} #### New Response, De Beers Polished {% tabs %} {% tab title="Locked, Single Country, With PI" %} {% code title="Locked, Single Country, With PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Locked, Single Country, Without PI" %} {% code title="Locked, Single Country, Without PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Locked, Multi Country, With PI" %} {% code title="Locked, Multi Country, With PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Locked, Multi Country, Without PI" %} {% code title="Locked, Multi Country, Without PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country, With PI" %} {% code title="Unlocked, Single Country, With PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": ["BW"], "mine_name": None, "is_locked": False }, "compliance": [ { "name": "DTC", "description": "This diamond was manufactured by a party who held Pipeline Integrity status through the entire process", "metadata": {} } ] } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country, Without PI" %} {% code title="Unlocked, Single Country, Without PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": ["BW"], "mine_name": None, "is_locked": False }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Multi Country, With PI" %} {% code title="Unlocked, Multi Country, With PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": ["BW", "CA", "NA", "ZA"], "mine_name": None, "is_locked": False }, "compliance": [ { "name": "DTC", "description": "This diamond was manufactured by a party who held Pipeline Integrity status through the entire process", "metadata": {} } ] } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Multi Country, Without PI" %} {% code title="Unlocked, Multi Country, Without PI" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "multi_country", "country_codes": ["BW", "CA", "NA", "ZA"], "mine_name": None, "is_locked": False }, "compliance": [] } ``` {% endcode %} {% endtab %} {% endtabs %} #### Current Response, Non-De Beers Rough {% tabs %} {% tab title="Single Country" %} {% code title="" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% endtabs %} #### New Response, Non-De Beers Rough {% tabs %} {% tab title="Single Country" %} {% code title="Single Country" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% endtabs %} #### Current Response, Non-De Beers Polished {% tabs %} {% tab title="Locked, Single Country" %} {% code title="Locked, Single Country" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "country_code": None, "mine_name": None, "is_locked": True, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country" %} {% code title="Unlocked, Single Country" overflow="wrap" %} ```json { "provenance": { "provenance_type": "Country", "provenance_name": "CA", "country_code": None, "mine_name": None, "is_locked": False, "is_country_code_available": True } } ``` {% endcode %} {% endtab %} {% endtabs %} #### New Response, Non-De Beers Polished {% tabs %} {% tab title="Locked, Single Country" %} {% code title="Locked, Single Country" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": [], "mine_name": None, "is_locked": True }, "compliance": [] } ``` {% endcode %} {% endtab %} {% tab title="Unlocked, Single Country" %} {% code title="Unlocked, Single Country" overflow="wrap" %} ```json { "display_provenance": { "provenance_type": "country", "country_codes": ["CA"], "mine_name": None, "is_locked": False }, "compliance": [] } ``` {% endcode %} {% endtab %} {% endtabs %} # Inventory The diamonds in your inventory are distributed by lifecycle state. Access each diamond lifecycle state from the Tracr menu under **Inventory**: * **Rough** – Includes only rough diamonds. * **Split** – Includes split and any other intermediary steps before the diamond is polished. * **Polished** – Includes only polished diamonds. * **Graded** – Includes only graded diamonds (polished diamonds with a grading certificate). You can upload a grading certificate either during upload of polished data or by updating a polished diamond that you have already uploaded. Within each inventory, diamonds will either be active (listed on the **Active** tab) or archived (listed on the **Archived** tab). Refer to [Archive and unarchive diamonds in your inventory](broken://pages/192dc8a9f91c8f05bf595497f647d2deea78f45d#archive-and-unarchive-diamonds) for more information on archiving and unarchiving diamonds. ## View diamonds The Diamond Details page is a visual representation of a diamond's journey through its lifecycle, and it is available for all diamonds in your inventory. To open the Diamond Details page for a diamond, do one of the following: * Select the row in the table corresponding to the diamond that you want to view. * In the **Action** column, select the ellipsis, and then select **View**. To view more than one diamond: * Select the checkbox next to all the diamonds that you want to view. At the bottom of the page, select **View**. ## Share diamonds Tracr allows you to send the details of one or more diamonds to an external party. To share diamonds from your inventory, select the checkbox next to the diamonds that you want to share and, at the bottom of the page, select [**Share**](https://tracr.stoplight.io/docs/user-documentation/1jg37a2vjdy8k). {% hint style="info" %} If any of the selected diamonds are locked, you cannot share them until they are unlocked. To do this, select **Unlock selected diamonds** and then select **Confirm**. Note that when you unlock a diamond you will incur an unlocking fee. {% endhint %} Provide an email address, subject, and message, and then select **Send**. Recipients receive an email containing a link to view the diamond(s) that you shared. Note that the link is active for seven days. ## Unlock diamonds Polished diamonds can only be shared or transferred if they are unlocked. You can unlock one or more locked diamonds from your inventory or from the Diamond Details Page. {% hint style="warning" %} To make sure that stones that are unlocked are accessible for future use, you will not be able to delete an unlocked stone. Please make sure you are happy with the stone you are unlocking and that it has all the necessary assets. {% endhint %} {% embed url="" %} {% stepper %} {% step %} ### Select diamonds Select the checkbox next to the diamond(s) that you want to unlock. {% endstep %} {% step %} ### Open unlock action At the bottom of the page, select **Unlock**. {% endstep %} {% step %} ### Verify selection Check that you have selected the correct diamond(s) to unlock. {% endstep %} {% step %} ### Keep any diamonds locked To keep a diamond locked, select **Remove from list** next to the diamond that you want to keep locked. {% endstep %} {% step %} ### Unlock Select **Unlock selected diamonds**. {% endstep %} {% step %} ### Confirm To confirm that you want to unlock, select **Confirm**. {% endstep %} {% endstepper %} ## Archive and unarchive diamonds To help you to keep your inventories up-to-date, Tracr separates each inventory into **Active** and **Archived** sections. * If you sell a diamond or remove it from the Tracr process, you can archive the diamond so that it no longer appears in your **Active** inventory but instead appears in your **Archived** inventory. * If you later withdraw a diamond for sale, or the buyer of the diamond becomes a Tracr participant and you want to transfer the digital asset to them, you can unarchive the diamond so that it moves back to your **Active** inventory. {% hint style="info" %} On the **Archived** tab you can only view or unarchive a diamond. You cannot edit, share, or unlock an archived diamond. {% endhint %} {% hint style="warning" %} You cannot archive diamonds that are in the 'Transferring' status (in the Transfer process). If your selection includes diamonds in this status, Tracr asks you to confirm that you want to archive the other diamonds in the selection or cancel the archive process. {% endhint %} ### To archive diamonds {% stepper %} {% step %} ### Choose inventory Select the inventory containing the diamond(s) that you want to archive. {% endstep %} {% step %} ### Open Active tab Select the **Active** tab. {% endstep %} {% step %} ### (Optional) Filter If you want to archive only diamonds of interest in the selected inventory, apply the required filters. {% endstep %} {% step %} ### Archive selection Then do one of the following: * To archive a single diamond, in the **Actions** column, select the ellipsis, and then select **Archive**. To confirm, select **Confirm**. * To archive more than one diamond, select the diamonds that you want to archive, and at the bottom of the page, select **Archive**. To confirm, select **Confirm**. {% endstep %} {% step %} ### Result Archived diamonds move from the **Active** tab to the **Archived** tab. {% endstep %} {% endstepper %} ### To unarchive diamonds {% stepper %} {% step %} ### Choose inventory Select the inventory containing the diamond(s) that you want to unarchive. {% endstep %} {% step %} ### Open Archived tab Select the **Archived** tab. {% endstep %} {% step %} ### (Optional) Filter If you want to unarchive only diamonds of interest in the selected inventory, apply the required filters. {% endstep %} {% step %} ### Unarchive selection Then do one of the following: * To unarchive a single diamond, in the **Actions** column, select the ellipsis, and then select **Unarchive**. To confirm, select **Confirm**. * To unarchive more than one diamond, select the diamonds that you want to unarchive, and at the bottom of the page, select **Unarchive**. To confirm, select **Confirm**. {% endstep %} {% step %} ### Result Unarchived diamonds move from the **Archived** tab to the **Active** tab. {% endstep %} {% endstepper %} ## Export inventory You can export your inventory as a report (xlsx file). When you do this, you can choose to export all diamonds in the selected inventory or apply filters to only export diamonds of interest. Before you begin, select the columns that you want to export and apply filters, if required. * To export all diamonds in the inventory, select **Export inventory** and then select **Export all**. * To export filtered diamonds only, select **Export inventory** and then select **Export filtered**. # Lab Eligibility: Main Issues and How to Fix ## Missing Scan Report If you are missing a scan report and want to grade your diamond through a Tracr intergration, you will need to upload a polished diamond and a supported scan report that Tracr can process. Please follow the guidelines below to help upload a scan report. ## Invalid Scan Report If your scan report is invalid, you have uploaded a scan report that is not .xml, .htm, or .html. Manually renaming a file's extension will not make it valid. Please follow the guidelines below to help upload a valid scan report. ## Scan Report Guide ### Supported Scan Report A diamond needs a supported scan report to be eligible for grading. Tracr currently supports Sarine XML scan reports and Helium HTM and HTML scan reports. > We support Helium Carbon versions that generate a .Ox2z file extension, beginning with Carbon version 1.0.\ > For the latest version, please visit the [official Helium Website](https://lexusindia.in/#software). Example scan reports: * [Sarine XML](https://jcpackages.tracr.network/integration/demo_polished_1.xml) * [Helium HTML](https://jcpackages.tracr.network/integration/example_helium.html) #### Prepare a polished diamond dataset Follow these steps to prepare polished diamond data for upload to Tracr. **Sarine Instructor** If you are using **Sarine Instructor** to provide a scan for polished diamonds, you need to generate an XML report and an STL export. Use the template provided by Tracr to export the report for each diamond. In the CSV file, Tracr needs the STL file in the column **scan**, and the XML report in the column **scan\_report**. [Download Sarine export templates](https://jcpackages.tracr.network/integration/Polished_Diamond_Sarine_Instructor_Export_Template.zip) **Sarine Instructor: Extracting data for polished diamonds** Extracting the required traceability data for polished diamonds using Sarine Instructor software is compatible with the following hardware: * DiaMension * DiaMension HD * DiaMark HD * DiaMark™ HD Once a polished diamond is scanned and the file loaded onto the Instructor software, you can extract the following data points: * Diamond Measurements (using a provided template) * Diamond 3D Model The following instructions describe how to extract the required data. {% stepper %} {% step %} ### Install the Tracr templates for polished diamonds * Place the Tracr template file, e.g. ‘TracrPolishedTemplate.txt’, within the Sarine Instructor Export folder:\ Sarine Technologies/Instructor/Export/ {% endstep %} {% step %} ### Export diamond measurements 1. Open the stone .srn file in Sarine Instructor. 2. Point to the **Export** icon, and select the corresponding Tracr template, for example, ‘TracrPolishedTemplate.txt’. 3. In the **Save As** dialog box, save the measurements as ‘YourStoneName.xml’. {% endstep %} {% step %} ### Export the mesh 1. Open the stone .srn file. 2. Point to the **Save** icon, and select **Save as**. 3. In the **Save As** dialog box, select ‘\*.stl’ as the file type and save the mesh with the stone's name. {% endstep %} {% endstepper %} **Helium software** If you are using **Helium software** to provide a scan for polished diamonds, you need to generate an HTM/HTML report and an STL export. Use the template provided by Tracr to export the report for each diamond. There are two types of Helium template: * Specific shape, only for a handful of shapes with additional information. * Generic, less information but you can use this template for all shapes. | Shape | Recommended template | | -------- | --------------------------------- | | Princess | HTML\_REPORT\_FOR\_PRINCESS | | Radiant | HTML\_REPORT\_FOR\_RADIANT | | Heart | HTML\_REPORT\_FOR\_Any\_Cut | | Pear | HTML\_REPORT\_FOR\_Any\_Cut | | Oval | HTML\_REPORT\_FOR\_OVAL\_MARQUISE | | Marquise | HTML\_REPORT\_FOR\_OVAL\_MARQUISE | | Cushion | HTML\_REPORT\_FOR\_CUSHION | | Emerald | HTML\_REPORT\_FOR\_STEP\_CUT | In the CSV file, Tracr needs the STL file in the column **scan**, and the HTM/HTML report in the column **scan\_report**. For more information about exporting using a Helium Polish Scanner, please refer to the [Helium Polish Scanner - Settings for Export (PDF)](https://www.lexusindia.in/download/download-files/HELIUMPOLISH_SETTINGS_FOR_EXPORTS.pdf). [Download Helium templates](https://jcpackages.tracr.network/integration/helium_templates.zip) {% hint style="info" %} **Please note:** * Before uploading polished diamond data, please make sure that you register the parent diamond on Tracr. * To verify the polished diamond, a 3D scan and the report of the scan of the diamond are crucial. * Providing the images and videos is optional, however, this will greatly improve the Diamond Experience. * Add the grading document to complete the polished digital asset. {% endhint %} To populate a polished diamond CSV file: {% stepper %} {% step %} ### Download the polished CSV file template (**Integration Tool > Integration toolkit > CSV Templates**). {% endstep %} {% step %} ### Populate the CSV file One row per diamond. {% endstep %} {% step %} ### Use the Data Dictionary It is recommended that you download and use the Data Dictionary (**Integration Tool > Integration toolkit > Data dictionary**) to help you to populate the CSV file. Filter the Data Dictionary by "Stone State = Polished". Ensure that you populate fields with the column "Required = true". {% endstep %} {% endstepper %} # Diamond Details The Diamond Details page is a visual representation of a diamond's journey through its lifecycle, and it is available for all diamonds in your inventory. For each diamond, the Diamond Details page displays a photograph of the latest stage of the diamond (if provided), basic information (provenance, carat, shape, colour), and the Tracr ID. Also shown is a summary of the diamond’s stages (Rough > Split (latest version) > Polished) followed by photographs/videos and more details about each stage. You can also view stage-specific details, scan reports, and grading certificates (if provided). {% hint style="info" %} Note: Every time you upload a new session, and the diamonds pass the control process, Tracr adds these diamonds to your inventory and generates the Diamond Details page for each one. If you update diamonds in your inventory, Tracr automatically updates the Diamond Details page. {% endhint %} ## View the Diamond Details page To view the Diamond Details page for a diamond, do one of the following: * Select the row in the table corresponding to the diamond that you want to view. * In the **Action** column, select the ellipsis, and then select **View**. To view more than one diamond: * In your inventory, select the checkbox next to all the diamonds that you want to view (maximum 40 diamonds). At the bottom of the page, select **View**. ## Unlock a diamond Polished diamonds can only be shared or transferred if they are unlocked. You can unlock one or more locked diamonds from the Diamond Details page. {% stepper %} {% step %} ### Open the Diamond Details page View the Diamond Details page for the diamond. {% endstep %} {% step %} ### Start unlocking If the diamond is locked, select the **Unlock this diamond** button. {% endstep %} {% step %} ### Choose action Select **Unlock selected diamond** or select **Cancel** to keep the diamond locked. {% endstep %} {% step %} ### Confirm Select **Confirm** to unlock the diamond. {% endstep %} {% endstepper %} ## Share a diamond Tracr allows you to share the details of one or more diamonds with an external party. You can share diamonds from the Diamond Details page or from your inventory. Note that polished diamonds can only be shared if they are unlocked. You can unlock one or more locked diamonds from the Diamond Details page prior to sharing. To share diamonds from the Diamond Details page: {% stepper %} {% step %} ### Open the Share page Select the **Share** button to display the **Share** page. If a diamond is locked, you will need to unlock it before it can be shared. {% endstep %} {% step %} ### Verify previews Check each preview to ensure you are sharing the correct diamond(s). {% endstep %} {% step %} ### Remove any diamond you don't want to share If you do not want to share a diamond, select the diamond in the **diamonds selected to share** section, and then select **Remove**. {% endstep %} {% step %} ### Provide recipient and message details Provide the following information: * **To** – Enter the email address of each recipient, separated by a comma or space. * **Subject** – Enter the subject of the email. * **Message** – Enter a message to the recipient(s). {% endstep %} {% step %} ### Send Select **Send**. Recipients receive an email containing a link to view the diamond(s) that you shared. Note that the link is active for seven days. {% endstep %} {% endstepper %} ## View a grading report You can view the grading report for any graded diamond in your polished or graded inventory by opening the Diamond Details page for that diamond. Then, select the **VIEW GRADING REPORT** button to display the grading report in a new browser tab. # Share The **Share** page shows a preview of the diamond(s) that you want to share on the left and an email form on the right. If you are sharing more than one diamond, use the arrows to scroll through the previews. The preview displays the information as it will appear when a recipient selects the **View diamond** link in the email that they receive. Recipients can view a grading report if one is available and view diamond details. ## View diamond details To view the diamond information that will be shared with the external party, select **VIEW DIAMOND DETAILS**. If you have more than one diamond selected, use the left and right arrows (which appear above the preview) to scroll through the selected diamonds. ## Remove a diamond If you do not want to share a selected diamond, select the diamond in the **diamonds selected to share** section, and then select **Remove**. ## Share a diamond Tracr allows you to share the details of one or more diamonds with an external party. Note that polished diamonds can only be shared or transferred if they are unlocked. You can unlock one or more locked diamonds from the Diamond Details page prior to sharing. {% stepper %} {% step %} ### Open the Share page Open the **Share** page for the diamonds that you want to share. Note that you may need to unlock diamonds that are locked before you can share. {% endstep %} {% step %} ### Confirm previews Check each preview to ensure you are sharing the correct diamond(s). {% endstep %} {% step %} ### Remove any diamond you don't want to share If you do not want to share a selected diamond, select the diamond in the **diamonds selected to share** section, and then select **Remove**. {% endstep %} {% step %} ### Provide email details Fill in the email form: * **To** – Enter the email address of each recipient, separated by a comma or space. * **Subject** – Enter the subject of the email. * **Message** – Enter a message to the recipient(s). {% endstep %} {% step %} ### Send Select **Send**. Recipients receive an email containing a link to view the diamond(s) that you shared. {% endstep %} {% endstepper %} {% hint style="info" %} The share link in the email is active for seven days. {% endhint %} # Integration # Integration Tool - New Session Use the Integration Tool to upload your data files to your instance of the Tracr Platform. To begin, create a new session from the Session history page by selecting the New session button. Then provide a prepared CSV file containing your diamond data. {% stepper %} {% step %} ### Prepare your diamond data for upload There are templates to help you prepare the CSV file and a Data Dictionary in the Integration toolkit, which describes the information you must include in your CSV file for rough, split, or polished diamond data. * Do not mix different types of data in your CSV file. * It is recommended that you use a text editor to edit the file. {% endstep %} {% step %} ### Upload your CSV file The CSV file contains the diamond data and details of any supporting files you want to upload to Tracr. * Either drag and drop your prepared CSV file onto the page, or select the Or, select from device button to browse for and select the file you want to upload. {% endstep %} {% step %} ### Confirm the integration type It is important that the type you select matches the type defined in your CSV file. If not, you will get an error. Select your integration type, and then select Continue. {% endstep %} {% step %} ### Validation Tracr checks your CSV file. See the validation outcomes below. {% endstep %} {% endstepper %} {% hint style="warning" %} Ensure the integration type you select exactly matches the type declared in your CSV file — mismatches will cause an error during validation. {% endhint %}
Validation outcomes * If validation is successful, Tracr displays the Required files page with the Session overview tab selected. You must then upload the files declared in the CSV file (ensuring that the filenames match) before you can complete the upload. * If validation fails, Tracr displays the Upload failed page. Review the error text and make the appropriate changes to your CSV file. Select Quit and create a new session to upload the changed file.
# Integration Tool - Data Upload Use the **Integration Tool** to upload your data files to your instance of the Tracr Platform. To begin, you need to create a new session. To do this, on the **Session history** page, select the **New session** button. Then, provide a prepared CSV file containing your diamond data. ## Upload data files The **Session overview** tab provides a summary of the information in your CSV file. For each participant ID, Tracr lists the files that it is expecting you to upload. If you are unsure, Tracr lists the names of these files on the **Missing files** tab. Either drag and drop the files onto the page or select the **Or, select from device** button to browse for and select the files that you want to upload. As Tracr accepts the files, you will see a green tick appear under the appropriate file type on the **Session overview** tab. An orange exclamation mark indicates a file is missing. You will not be able to complete your session if there are any files missing.
Missing files The **Missing files** tab lists any files that Tracr is expecting you to provide. You will not be able to complete your session if there are any files missing. To upload any missing files, either drag and drop onto the page or select the **Or, select from device** button to choose the files you want. {% hint style="info" %} Your CSV file specifies the names and types of files, so if any of these are not to be provided, you need to edit your CSV file and start a new session. {% endhint %} **Download a missing files report** To download a report, select **download as .xlsx**. The report lists the participant ID, file name, and file type for each missing file.
Failed files Tracr validates each file as it is uploaded and lists any files that fail validation on the **Failed files** tab. You will not be able to complete your session if any files fail validation. **Download a failed files report** To download a report, select **download as .xlsx**. The report lists the participant ID, file name, file type, and details for each failed file.
Unexpected files The **Unexpected files** tab lists any files that Tracr is not expecting. While these files will not affect the upload, you should check the names and types of any files shown on the **Unexpected files** tab to see whether these should have been included in your CSV file. To help you do this, you can download an Excel file containing the names and types of any unexpected files. **Download an unexpected files report** To download a report, select **download as .xlsx**. The report lists the unexpected file names and file types.
## Submit the session When all files are uploaded, look for this message in the top right corner: ‘Ready to submit. All required files have been accepted and uploaded for this session, submit to continue.’ You can now select the **Submit session** button to continue and submit your session. {% hint style="info" %} Tracr provides you with a summary of your session before you submit for matching and verification: the number of diamonds to submit and the number excluded. Select the **Submit** button to confirm that you want to submit the session. {% endhint %} ## Quit the session When you select **Quit**, Tracr provides you with two options. * **Save and quit** – Tracr saves your session which appears on the **Session history** page with a status of ‘In progress’. Select **Continue session** to resume the session. * **Abandon and quit (all progress will be lost)** – When you abandon a session, it is no longer accessible, and Tracr deletes all progress. # Integration Tool - Session Success The Session success page displays: * the number of diamonds submitted to Tracr * the number of diamonds you excluded from the upload ## Download a session report Select the **Download report** button to export details of the session as a report (XLSX file). {% hint style="info" %} The exported report is an XLSX file containing the session details. {% endhint %} ## View the session in history Select the **View in history** button to open the session on the Session history page. From there you can view the processing status of the session or download session reports. # Integration Tool - Session History To register diamonds on Tracr, you must upload the required data whenever a diamond changes form and/or is passed from one process to another. This includes windowing and unexpected incidents during the manufacturing process. You can also upload optional files like images and videos to enhance the Diamond Experience. Tracr maintains a list of your integration sessions and displays these on the Session history page. If there are no sessions listed, select the **New session** button to create a session and upload your diamonds. Each session has a status that shows whether the session was submitted, is in progress, or was abandoned: * **Submitted** – Data has been uploaded and Tracr is processing the diamonds. * **In progress** – The session was not submitted (the user did not click **Submit** or chose to save and quit). * **Abandoned** – The session was abandoned. Note: you can only abandon a session if the CSV file has passed validation. ## Create a new session To upload a diamond dataset to Tracr, create a session by selecting the **New session** button on the Session history page. This initiates the process for uploading your diamonds. ## Download the integration toolkit The **Integration toolkit** button provides access to: * CSV templates * The Tracr Loader application * The Data Dictionary * Exporter templates and guides You can download individual components of the toolkit or select **Download toolkit** to download the complete toolkit as a single zip file. ## View the verification status of a submitted session To check the verification status of diamonds you have submitted to Tracr: * In the **Action** column, select **Monitoring** to open the Integration monitoring page. * Tracr displays the status of an integration as either **Registered** or **Invalid**.
Verification status details * **Registered** – The diamond is verified and on the Tracr Portal. * **Invalid** – An error has occurred, and Tracr did not register the diamond.
## Continue an in progress session If a session is saved (status = **In progress**), you can continue it: * On the Session history page, in the **Action** column, select **Continue session** to complete and submit the session. ## Export a session report You can export details for a selected session: * In the **Action** column, select the ellipsis and choose one of the export options.
Export options * To download a simple report for the selected session: under **Download a session report as**, select **.xlsx file**. * To download a full report for the selected session: under **Download full session report**, select **.xlsx file**.
# session history ## Navigation From the menu, select **Integration > Integration Tool**. ## Overview The **Session history** page displays a list of your integration sessions. ## Features Read this section to learn more about the filters and columns on the **Session history** page. ### Filters {% stepper %} {% step %} ### Filter by date To filter by date, select **Start date**, choose the date from the calendar, and select **Apply**. Tracr only displays sessions for the selected date. {% endstep %} {% step %} ### Filter by integration type To filter by integration type, select **Integration type**, select the type(s) that you want to display, and select **Apply**. Tracr only displays sessions for the selected integration type(s). {% endstep %} {% step %} ### Filter by status To filter by status, select **Status**, select the status(es) that you want to display, and select **Apply**. Tracr only displays sessions for the selected status(es). {% endstep %} {% endstepper %} ### Columns For each session, Tracr provides the following information: * **Session ID** – The ID allocated to the session by Tracr. * **Session start** – The date and time the session started. You can filter using a start date if you only want to display sessions started on a particular date. * **Session submitted** – The date and time the session was submitted to Tracr. If this is blank, check the **Status** column to see if the session is ‘In progress’ or was ‘Abandoned’. * **Integration type** – The integration type selected when the CSV was uploaded to Tracr. You can filter on integration type if you only want to display sessions of a certain type. * **Diamonds submitted** – The number of diamonds submitted to Tracr. * **Diamonds excluded** – The number of diamonds excluded when the dataset was uploaded to Tracr. * **Status** – The status of the session. You can filter on status if you only want to display sessions at a certain status. * **Details** – Provides more information about the status of the session. * **Action** – The available options depend on the status of the session.\ For a ‘Submitted’ session, select the ellipsis to access the following options: * **Monitoring** – Display the **Monitoring** page for the selected session. * **.xlsx file** – Download a simple or detailed report for the selected session.\ For an ‘In progress’ session, select **Continue session** to complete and submit the session. ### Session status Each session has a status. * **Submitted** – Data has been uploaded and Tracr is processing the diamonds. * **In progress** – The session was not submitted, either because the user did not click **Submit** or chose to save and quit the session, possibly because not all the required files were available. To complete the session, in the **Action** column, select **Continue session**. * **Abandoned** – The session was abandoned. Note that you can only abandon a session if the CSV file has passed validation. ## Actions The following actions are available on the **Session history** page. ### Continue session If a session has been saved (status = ‘In progress’), you can select **Continue session** in the **Action** column on the **Session history** page to complete and submit the session. ### Export a session report You can export details of a selected session displaying on the **Session history** page as a report (xlsx file). {% stepper %} {% step %} ### Step 1 — Display the session(s) Use the filters to display the session(s) that you want to export. {% endstep %} {% step %} ### Step 2 — Export the report In the **Action** column, select the ellipsis and do one of the following: * To download a simple report for the selected session, under **Download a session report as**, select **.xlsx file**. * To download a full report for the selected session, under **Download full session report**, select **.xlsx file**. {% endstep %} {% endstepper %} ### Create a new session To upload a diamond dataset to Tracr, you must create a session. Select the **New session** button on the **Session history** page to create a new session. ### Integration toolkit The **Integration toolkit** button provides you with access to CSV templates, the Tracr Loader application, the Data Dictionary and exporter templates and guides. You can download individual components of the toolkit or select **Download toolkit** to download the complete toolkit in a single zip file. # Integration Monitoring The **Integration monitoring** page displays the verification status of diamonds that you have uploaded to Tracr using the Integration Tool or Tracr Loader. The data is presented in a table with details about each diamond and its status in the integration process. Tracr displays the status of an integration as either “Registered” or “Invalid”: {% hint style="info" %} * **Registered** – The diamond is verified and on the Tracr Portal. * **Invalid** – An error has occurred, and Tracr did not register the diamond. Refer to the **Details** column for more information on the error. {% endhint %} ## Export an event report You can export details of all the events currently displaying on the **Integration monitoring** page as a report (xlsx file). {% stepper %} {% step %} ### Prepare the events to export Use the filters on the Integration monitoring page to display only the events you want to include in the export. {% endstep %} {% step %} ### Export the report Select **Export report**, then choose **xlsx file** to download the report. {% endstep %} {% endstepper %} # Shipments # Shipments Outbound You can use Tracr to send and receive shipments of diamonds. Use the Outbound option to create and manage shipments that you want to send from your inventory to another Tracr account. {% hint style="info" %} If you are a producer, you can only create a shipment of rough diamonds that you have registered on Tracr to send to a manufacturer. If you are a manufacturer, you can only create a shipment of polished diamonds to send to a retailer. {% endhint %} ## Create a new shipment To transfer diamonds to a new recipient, you must create a shipment which specifies the diamonds that you want to transfer from your inventory. {% hint style="info" %} Before you start: Prepare a CSV file with the Tracr IDs of the diamonds you want to transfer. To avoid syntax errors, name the column tracr\_id. [Download transfer CSV template](https://jcpackages.tracr.network/integration/transfer_out_template.csv) {% endhint %} {% stepper %} {% step %} ### Prepare CSV Create a CSV containing the Tracr IDs of the diamonds to transfer. Ensure the column name is exactly: {% code title="transfer.csv" %} ```csv tracr_id ``` {% endcode %} {% endstep %} {% step %} ### Start a new shipment Select the **New shipment** button at the top of the page. {% endstep %} {% step %} ### Upload and specify recipient Upload your CSV file, enter the recipient's Tracr API URL, and provide a shipment ID. {% endstep %} {% step %} ### Track the shipment The shipment you create initially appears on the **Active** tab and then moves to the **Archived** tab when all diamonds in the shipment have either been transferred, rejected, or cancelled. {% endstep %} {% endstepper %} ## Active outbound shipments The **Active** tab lists the collections of diamonds (shipments) that you want to transfer to a selected recipient. To make a diamond eligible for transfer to another Tracr account, select the **New shipment** button and complete the New Shipment process. {% hint style="info" %} When you transfer a diamond out of your inventory, you make it eligible for transfer into the recipient’s Tracr inventory. Tracr sends notifications to the recipient and the diamond appears on the list of eligible diamonds for transfer in. {% endhint %} Each active shipment has a status: * Sent — The recipient has been notified of all the diamonds in the shipment. * In progress — Some, but not all of the diamonds in the shipment have been accepted, cancelled, or rejected. Applies only to polished shipments. * Accepting, Cancelling, or Rejecting — Tracr is processing the shipment. Applies only to rough shipments. ### View active shipment details To view active shipment details and the status of each diamond in the selected shipment, next to a shipment, select **View**. {% hint style="info" %} When viewing active shipment details, you can cancel the shipment of a selected diamond or cancel a complete shipment. Tracr only shows the status of a diamond for polished shipments. {% endhint %} ## Archived outbound shipments The **Archived** tab lists the collections of diamonds (shipments) that have completed — the recipient has either confirmed or rejected the shipment, or the sender has cancelled the shipment. Each completed shipment has a status: * Cancelled — The sender cancelled the shipment. * Complete — The transfer is complete. All diamonds in the shipment have either been transferred, rejected, or cancelled. * Rejected — The recipient rejected the shipment. ### View archived shipment details To view archived shipment details and the status of each diamond in the selected shipment, next to a shipment, select **View**. {% hint style="info" %} Tracr only shows the status of a diamond for polished shipments. {% endhint %} # Shipments Outbound - New Shipment To transfer diamonds to a new recipient, you must create a new shipment which specifies the diamonds that you want to transfer from your inventory. {% hint style="info" %} Only producers can create rough shipments. Only manufacturers can create polished shipments. {% endhint %} ## Create a new shipment {% hint style="info" %} Before you start: Prepare a CSV file with the Tracr IDs of the diamonds you want to transfer. To avoid errors when you upload the file, name the column containing the Tracr IDs, **tracr\_id**. [Download transfer CSV template](https://jcpackages.tracr.network/integration/transfer_out_template.csv) {% endhint %} {% stepper %} {% step %} ### Select New shipment From the Shipments Outbound page, select **New shipment** to begin. {% endstep %} {% step %} ### Choose integration type and upload CSV In the **New Shipment** dialog box: * Select the **Integration type**, either *Rough* or *Polished*. * Either drag and drop your prepared CSV file onto the page or choose **Select from device** to browse for and select the file that you want to upload. * Select **Upload**. Look for ‘CSV uploaded successfully' to confirm that Tracr has accepted the file. {% endstep %} {% step %} ### Review the diamonds in the shipment Review the list of diamonds imported from your CSV. Note that you cannot proceed with the shipment if it contains unavailable diamonds. {% endstep %} {% step %} ### Remove unavailable diamonds If any of the diamonds in the shipment are unavailable: * Select **Remove** next to the unavailable diamond, or * Select **Remove all unavailable diamonds**, then select **Confirm**. {% endstep %} {% step %} ### Remove any available diamonds you don't want to ship To exclude available diamonds from the shipment: * Select **Remove** next to the diamond, or * Select the diamonds to remove and then select **Remove** at the bottom of the page. Then select **Confirm**. {% endstep %} {% step %} ### Continue Select **Continue** to proceed. {% endstep %} {% step %} ### Name the shipment Enter a name to identify the shipment. {% endstep %} {% step %} ### Enter recipient API URL Enter the recipient's Tracr API URL.\ For example: \ {% endstep %} {% step %} ### Send shipment Select **Send shipment**. {% endstep %} {% step %} ### Confirm or cancel Review the displayed shipment information. * To confirm the shipment, select **Confirm**. * To cancel the shipment, select **Cancel**. {% endstep %} {% endstepper %} {% hint style="info" %} You can cancel the shipment after sending until your recipient accepts the shipment. {% endhint %} # Shipments Outbound - Pending Shipment Pending shipment details show more information about each diamond in a selected shipment. To view this information, select **View** next to a shipment on the **Active** tab. For a polished shipment, each diamond has a status: * **Cancelled** — The sender cancelled the transfer of the diamond in the shipment. * **Rejected** — The recipient rejected the diamond in the shipment. * **Sent** — The diamond has been sent; the recipient can now accept or reject the diamond in the shipment. * **Transferred** — The recipient accepted the transfer of the diamond in the shipment. ## Cancel a polished diamond You can cancel individual diamonds in a shipment of polished diamonds if the diamond has not been accepted by the recipient. {% stepper %} {% step %} ### Cancel a single polished diamond 1. In the **Actions** column, select **Cancel**. 2. Select **Confirm**. Once confirmed, Tracr removes the diamond from the shipment. {% endstep %} {% endstepper %} ## Cancel a shipment You can cancel the transfer of all diamonds in a shipment. {% stepper %} {% step %} ### Cancel an entire shipment 1. Select the **Cancel shipment** button. 2. Select **Confirm**. Once confirmed, the recipient will no longer be able to receive the shipment. {% endstep %} {% endstepper %} ## Export shipment data To export all shipment data, select **Export as CSV**. # Shipments Outbound - Archived Details Select **View** next to a shipment of diamonds on the **Archived** tab to show more information about each diamond in the shipment. For polished diamonds, each diamond in the shipment has a status: {% hint style="info" %} * **Cancelled** — The sender cancelled the transfer of the diamond in the shipment. * **Rejected** — The recipient rejected the diamond in the shipment. * **Transferred** — The recipient accepted the transfer of the diamond in the shipment. {% endhint %} # Shipments Outbound - Transfer from Inventory The Transfer from Inventory feature provides a fast and structured way to move diamonds from your available inventory to recipients. This process eliminates the need for manual CSV exports and imports by allowing you to handle transfers directly within the platform.
Key Benefits: * Faster process * Bulk and individual diamond transfer support * Enhanced user experience Frequently Asked Questions
Can I transfer multiple diamonds at once? Yes, the Transfer from Inventory feature supports both single and bulk transfers. You can select multiple diamonds within your inventory and transfer them to a recipient in one action, streamlining the process for larger transfers.
Can I transfer diamonds to multiple recipients at once? No. Each transfer action is limited to a single recipient. If you need to transfer diamonds to multiple recipients, you will need to perform separate transfer actions for each one.
Are there any limits on the number of diamonds I can transfer at once? Yes, the maximum number of diamonds that can be transferred in a single transfer is 1,000.
Can all diamonds be transferred? Some diamonds may not be transferred due to their status or lack of data.
User Interface Elements: **Action Bar:** appears when one or more diamonds are selected. It provides quick access to Transfer action.
**Your Selection Panel:** displays all the diamonds you’ve selected, making it easy to review and manage them before taking further action.
**Details Panel:** will allow you to enter all relevant transfer information, such as shipment name and, the recipient URL.
**Results:** will show if the transfer is successfully completed.
How it Works {% stepper %} {% step %} ### Select diamonds As a producer, from your rough inventory, or as a manufacturer or a retailer, from your polished or graded inventory list, select the diamonds you want to transfer by selecting their checkbox.
If you only want to transfer a single diamond then you can also use the row level action menu. You can use filters or search to refine the list of diamonds.
{% endstep %} {% step %} ### Transfer details page (no issues) If there are no issues to resolve before you’re able to transfer the diamond(s), you will be shown the transfer details page.
{% endstep %} {% step %} ### Selection page with issues If there are any issues to resolve before you can transfer the diamond(s), the process begins on the selection page. A side panel (drawer) will open with the selected diamonds grouped into one of three areas: * Diamonds which are eligible for transfer * Diamonds which are not eligible for transfer, but have actions that can be taken to resolve the issues inline * Diamonds which are not eligible for transfer at all
{% endstep %} {% step %} ### Continue with eligible diamonds Choosing Continue will move you to the details page with the diamonds which are eligible for transfer only.
{% endstep %} {% step %} ### Resolve issues inline Diamonds which are eligible for transfer after resolving issues can be corrected by following the flows without leaving the main transfer screens. Once those flows have been completed the diamonds will move into the "Eligible for transfer now" section. Diamonds in a group can be inspected by selecting the arrow to the right of the group. This action will open a further drawer showing the details of the diamonds in the group. Clicking the X in the top left corner, pressing escape, clicking Done in the bottom right of the drawer, or clicking outside the drawer will return you to the Selection screen.
{% endstep %} {% step %} ### Enter shipment details Once the diamonds you want to transfer are all in the Eligible for transfer group, click Continue. On the Details page you can enter a name for the shipment, and the API URL of the recipient you’re sending the diamonds to. Each shipment name must be unique between you and the recipient.
{% endstep %} {% step %} ### Confirm transfer Click on Confirm transfer to execute the transfer. Once the transfer is complete you can close the drawers to return to the inventory, or you can choose to move to the outbound shipments screen where your new shipment will be visible.
{% endstep %} {% endstepper %} # Shipments Outbound - Details (Complete Transfer) Complete transfer details show more information about each diamond in a completed shipment. Each diamond has a status: * **Transferred** – The diamond successfully transferred to the recipient's inventory. * **Rejected** – The recipient rejected the diamond. * **Cancelled** – You cancelled the transfer of the diamond to the recipient. # Shipments Inbound You can use Tracr to send and receive shipments of diamonds. Use the **Inbound** option to manage shipments of diamonds that you receive from another Tracr account. The shipments that you receive initially appear on the **Active** tab and then move to the **Archived** tab when you accept or reject the diamonds in the shipment, or if the sender cancels the shipment. ## Active The **Active** tab lists the active shipments sent from a producer or manufacturer. * For a shipment of rough diamonds from a producer, you must either accept or reject the shipment; if accepted, you can then upload diamonds against the shipment (up to the bounds of the shipment's count, total carats, carat range). * For a shipment of polished diamonds from a manufacturer, you must either accept or reject each diamond in the shipment. When you receive and accept ownership of a polished diamond in a shipment, you become the owner and the diamond is transferred to your inventory. Each active shipment has a status: * **Action required** — You need to accept or reject a rough shipment or select **View** to accept or reject diamonds in a polished shipment. * **Incomplete** — You have accepted a rough shipment but not yet uploaded diamonds using the **Integration Tool**. * **Processing** — Tracr is processing one or more diamonds within a polished shipment. {% stepper %} {% step %} ### Accept or reject a shipment of polished diamonds To transfer polished diamonds to your inventory, you must first accept ownership of an active shipment. Next to a shipment with the status **Action required**, select **View**. You can then either **Accept** or **Reject** each diamond in the shipment on the **Accept Ownership of Diamonds** page. If you do not want to accept a shipment, next to a shipment with the status **Action required**, select **Reject**, and then select **Confirm**. Doing this ends the registration process. Tracr notifies the sender that you have rejected the shipment. This process is irreversible. {% endstep %} {% step %} ### Accept or reject a shipment of rough diamonds To accept or reject rough diamonds sent by a producer, next to a rough shipment with the status **Action required**, select **Accept** or **Reject**, and then select **Confirm**. If you accept the shipment, you then need to upload diamond data using the **Integration Tool**. To start this process, select **Upload diamonds**. You can also upload diamonds using the Tracr API. If you reject the shipment, Tracr ends the registration process and notifies the sender that you have rejected the shipment. {% endstep %} {% step %} ### Accept a shipment of rough diamonds from a non-De Beers producer If you are a manufacturer and want to confirm and upload the diamonds from a shipment sent by a non-De Beers producer, next to a rough shipment with the status **Action required**, select **Accept**, and then select **Confirm**. Once accepted, you will need to upload the diamonds associated with that shipment. To do this, either upload the shipment data using a CSV file and the **Integration Tool** or upload the shipment data via the API, following the same procedure used for De Beers diamonds. {% hint style="info" %} Important: When uploading diamonds, instead of providing the box details from De Beers (such as sight, year, and box ID), you will need to provide the **Shipment ID** in the `box_id` column. The **Shipment ID** appears on the **Active** tab, next to the **Sender**. {% endhint %} {% endstep %} {% endstepper %} ## Archived shipments The **Archived** tab lists the shipments that you have accepted or rejected, and the shipments cancelled by the sender. * Accept ownership of a shipment or reject diamonds in a polished shipment on the **Accept Ownership of Diamonds** page. * Accept or reject a rough shipment from the **Active** tab. Each complete shipment has a status: * **Complete** — The transfer is complete. All diamonds in the shipment have either been transferred, rejected, or cancelled. * **Rejected** — The recipient rejected the shipment. * **Cancelled** — The sender cancelled the shipment.
View complete transfer details To view complete transfer details for a polished shipment and check whether a diamond was transferred or rejected, next to a shipment, select **View**.
# Shipments Inbound - Accept Ownership of Diamonds To accept ownership of a shipment of polished diamonds you must review details of the shipment and choose the diamonds that you want to accept or reject. Once accepted, Tracr adds the diamonds to your inventory. If you reject a diamond, the diamond remains in the sender's inventory. {% hint style="info" %} To help identify the shipment, Tracr displays the name of the sender and shipment, the date and time sent, and the number of diamonds in the shipment. {% endhint %} ## View the status of a transfer The dashboard at the top of the **Accept Ownership of Diamonds** page clearly shows the status of a transfer. It displays the number of diamonds transferred, processing (being accepted or rejected), rejected or cancelled as well as the number of diamonds yet to be accepted or rejected. You can filter on **Status** to display diamonds that you need to action or those that you have already accepted or rejected. ## Accept a diamond You can accept all diamonds in a shipment or choose the ones that you want to accept and then reject the others. {% hint style="info" %} You can only accept a diamond if its status is "Action required". {% endhint %} To accept a diamond {% stepper %} {% step %} ### Accept a single diamond * Next to the diamond that you want to accept, in the **Actions** column, select **Accept**. * To confirm, select the **Confirm** button. * The status of the diamond in the shipment changes from "Action required" to "Processing". Once complete, the status changes to "Transferred". {% endstep %} {% step %} ### Accept multiple diamonds or all diamonds in a shipment * Select the checkbox next to each diamond that you want to accept. * At the bottom of the page, select **Accept**. * To confirm, select the **Confirm** button. * Selected diamonds move from "Action required" → "Processing" → "Transferred" once the operation completes. {% endstep %} {% endstepper %} ## Reject a diamond You can reject a diamond if you do not want to add it to your inventory. {% hint style="info" %} You can only reject a diamond if its status is "Action required". {% endhint %} To reject a diamond: {% stepper %} {% step %} ### Reject a single diamond * Next to the diamond that you want to reject, in the **Actions** column, select **Reject**. * To confirm, select the **Confirm** button. * The status of the diamond in the shipment changes from "Action required" to "Processing". Once complete, the status changes to "Rejected". {% endstep %} {% step %} ### Reject multiple diamonds or all diamonds in a shipment * Select the checkbox next to each diamond that you want to reject. * At the bottom of the page, select **Reject**. * To confirm, select the **Confirm** button. * Selected diamonds move from "Action required" → "Processing" → "Rejected" once the operation completes. {% endstep %} {% endstepper %} # Shipments Inbound - Archived Details Select **View** next to a shipment of polished diamonds on the **Archived** tab to show more information about each diamond in the shipment. Each diamond has a status: {% hint style="info" %} **Cancelled** — The sender cancelled the transfer of the diamond. {% endhint %} {% hint style="warning" %} **Rejected** — The recipient rejected the diamond. Tracr returns the diamond to the sender's inventory. {% endhint %} {% hint style="success" %} **Transferred** — The recipient accepted the diamond, which has successfully transferred to their inventory. {% endhint %} To export the shipment information as a CSV file, select **Export as CSV**. # Glossary
TermDefinition
Ancestor Diamond

Given a diamond, an ancestor of that diamond is either:

  • the parent diamond,
  • the parent of the parent diamond,
  • and so on…

A diamond’s ancestors are all diamonds satisfying this definition.

APIAn Application Programming Interface (API) is a set of functions and procedures that allow two software applications to communicate.
ApplicationServices which interact with the Diamond Traceability Ecosystem through defined interfaces to provide additional functionality. Applications are not part of the Diamond Traceability Ecosystem.
BlockchainA public ledger which records committed transactions on a chain of blocks. The chain constantly grows, with new blocks appended to the chain to represent new transactions. Blockchain technology possesses certain integral key characteristics: decentralisation, persistence, anonymity and auditability.
BoxProducers sell diamonds in boxes. A box contains similarly sized rough diamonds.
Child Diamond

Given a split diamond, a child diamond is either any:

  • rough diamond generated by the split operation, or
  • rough diamond generated by the split operation that has subsequently been polished.

A diamond’s children are all diamonds satisfying this definition.

Core ServiceA service provided by Tracr’s core Diamond Traceability Ecosystem. For example: Management Portal, DiamondID, and Verification Service.
Cross Participant Search (XPS)An API allowing non-participants to search for diamonds across all of Tracr and return traceability data.
CSV TemplateA file to help create CSV files containing diamond data in the correct format for upload to Tracr. Templates are available as part of the Integration toolkit for rough, split, and polished diamonds.
DataContent that can provide a description, measurement, or even a report on anything relative to an enterprise’s data assets.
Data DictionaryA spreadsheet which gives a comprehensive overview of all data points required for uploading data for a diamond, at any stage of its lifecycle. The Data Dictionary is part of the Integration toolkit.
Data PointThe smallest unit of information about a diamond, used for traceability. It must not contain any personally identifiable information (PII). For example, 4Cs, 3D scan in STL, raw image file, etc.
Data points may be classed as Traceability (level 0) data, Supplementary data (Levels 1-3) or Entity Specific data (Level Z).
Data QualityThe extent to which a diamond's data points are correct based on surface level checks, and simple heuristics, without any external references.
DBASDe Beers Auction Sales
Descendant Diamond

Given a diamond, a descendant of that diamond is either:

  • a child of that diamond,
  • a child of a child of that diamond,
  • and so on…

A diamond’s descendants are all diamonds satisfying this definition.

Diamond AncestryThe current version of every ancestor diamond of a given diamond, and the diamond itself, ordered by diamond hierarchy.
Diamond Details pageA visual representation of a diamond's journey through its lifecycle. It is available for all diamonds in a participant’s inventory. Tracr automatically updates the Diamond Details page if any updates are made to a diamond.
Diamond History

A collection of data comprising:

  • every version of every ancestor of a given diamond, and
  • every version of the given diamond itself.

Order firstly by diamond hierarchy, then the version’s system_timestamp.
Note that a diamond’s ancestry and versions are always contained in the diamond’s history.

Diamond IDA core service in the Tracr Platform Ecosystem primarily tasked with validating, verifying, and identifying diamonds.
Using a combination of data, including images, videos, and reports, it is the way Tracr is able to assure that the diamond being presented to the platform is, in fact, the diamond that the holder is suggesting.
Diamond Integration Tool (DIT)The system which allows participants to add and change data in their instance. By creating a simple data file and uploading it, new records are added to the instance.
Diamond LookupA tool that can be used by platform participants to view a diamond using a time-limited URL.
Diamond RecordA collection of data points associated with a single diamond organised in accordance with the schema.
Diamond RegistryA directory that identifies on which platform(s) all or some of the associated diamond record is stored.
Diamond UIDThe globally unique ID generated by Diamond ID for a single, validated, and verified diamond at a specific time.
Diamond VersionA diamond and all its attributes at a given point in time (the system_timestamp).
Diamond VersionsAll versions of a given diamond, ordered by system_timestamp.
Diamonds from DTCA ‘source of origin claim’ that sightholders and accredited buyers can apply to their sight-sourced diamonds and pass it on with a diamond as it moves down the value chain.
All DTC diamonds are sourced in alignment with the OECD’s Due Diligence Guidance, are fully compliant with the Kimberley Process, and originate from Botswana, Canada, Namibia, or South Africa.
Digital AssetAnything that exists in a digital form that comes with a distinct usage right. Digital assets can include any form of digital information—videos, images, animations, and graphics—that is stored in computers, smartphones, digital media, or clouds.
For Tracr, each diamond on the platform is represented by a digital asset. All data and accompanying metadata that Tracr possesses on each individual diamond on the platform is amalgamated to produce a digital asset that forms a holistic representation of each diamond registered on the platform.
Entity-Specific DataParticipant-specific data to which only that participant has access. This data cannot be shared with other Tracr participants.
False Match Rate (FMR)Used in the context of the Diamond ID service, it represents the ratio of false positive matching results to accurate matches.
False Non-Match Rate (FNMR)Used in the context of the Diamond ID service, it represents the ratio of false negative matching results to accurate matches.
Diamond ExperienceA search that allows you to retrieve details of any diamond within the Trace network using its Tracr ID.
The URL of the search page is https://search.tracr.com/
Grading Integration Service (GIS)A service that allows grading labs to upload a grading certificate and/or inscription number to a diamond record on Tracr.
Individual Tracr InstanceEach participant is given their own Tracr instance when onboarded through which they can access the Tracr platform. Each individual instance will only allow a participant access to their own diamonds and not those of other participants.
Integration ToolSee Diamond Integration Tool.
Integration ToolkitA collection of scanner templates, CSV templates, and supporting documentation. The Data Dictionary is also part of the Integration toolkit.
Integration Monitoring

Part of the Tracr Management Portal that displays the verification status of diamonds uploaded to Tracr. Each integration has a status, which can be:

  • Registered – The diamond is verified, and on the Tracr Portal.
  • Error – An error has occurred, and Tracr did not register the diamond.
InventoryPart of the Tracr Management Portal that shows a list of diamonds uploaded to Tracr distributed by lifecycle state.
Lineage IntegrityThe extent to which the provenance / parentage of a diamond can be verified.
Locked DiamondA polished diamond that has not been unlocked by the participant. The diamond will not appear on the Diamond Experience, Share, Participant API and Participant Search.
MetadataA set of data that describes and gives more information about other data.
OperationA change to a diamond record triggering a blockchain transaction.
Parent DiamondGiven a child diamond, the parent diamond is the diamond that was split to generate that child. If a parent exists, then it is unique.
ParticipantA legal entity that interacts with a single instance of the Tracr platform. Participants are DeBeers sightholders who have been onboarded onto the Tracr platform.
Participant Search (B2B)A search that allows you to retrieve details of a participant’s diamond using its Tracr ID. Typically used to retrieve details of one or more diamonds shared with you by a participant.
The URL of the search page is https://search.[participant].tracr.com/
PathThe route to a data point within a diamond record. For example, the producer’s rough stone authentication scan may be represented by the path: ‘producer/rough/authentication_scan’.
PlatformThe platform performs operations on behalf of the participant as directed by application(s) or core services.
RegistryCentral store of authoritative collections: DiamondRegistry, UserRegistry, PlatformRegistry, ApplicationRegistry.
REST APIA Representational State Transfer (REST) API is a way for two computer systems to communicate over the Internet using the HTTP technologies. REST defines a set of functions like GET, PUT, and DELETE that a client can use to access data on a server.
SchemaThe structural definition of the diamond record.
ShardA portion of the diamond record held on a single instance of the platform.
SharePart of the Tracr Management Portal that allows you to share the details of one or more diamonds with an external party. Recipients receive an email containing a link to view the diamond(s) that you shared.
Shared InstanceA multi-tenant instance where multiple logins access the same instance but see different content based on their logins.
SightSights are sales that take place ten times per year. During the sales period, customers (sightholders and accredited buyers) can inspect the rough diamonds offered to them before deciding what to buy. A sight is identified by the calendar year and the number of that sight within the year.
SightholderA select group of diamantaires who have demonstrated outstanding business performance and ethical accountability. Each sightholder is selected following a rigorous procedure where the firm in question’s abilities in the core areas of business, strategic planning, manufacturing excellence, business reputation and strict adherence to a code of ethical accountability.
Supplementary DataData points relating to a diamond in addition to the traceability data. A participant can optionally share supplementary data with other participants.
Traceability Data

Mandatory data required to use Diamond Traceability Ecosystem. Traceability data constitutes both of:

  • Primary data - The data used to trace the diamond along the diamond supply chain through the Diamond Traceability Ecosystem.
  • Verification data - The data provided to the Diamond Traceability Ecosystem to permit the performance of diamond identification and verification.

Ownership of the primary data transfers with the ownership of the associated diamond. A participant can optionally share verification data with other participants.

TracrTracr is an advanced technology platform developed by De Beers Group to underpin trust in diamond provenance. Using leading-edge technologies, including blockchain, artificial intelligence, the internet of things and advanced security and privacy technologies, Tracr enables confidence in a diamond's source throughout the diamond value chain.
Tracr IDThe unique ID allocated when Tracr registers a diamond.
Tracr Management PortalA web-based tool to enable participants to upload, share and transfer their diamonds. The portal provides live feedback to participants on uploads, organises diamonds in a virtual inventory and displays the Diamond Details page.
TransactionAn update to a diamond record. This may consist of a single or multiple operations.
Transfer InReceive and accept ownership of a diamond in Tracr transferred from a manufacturer.
Transfer OutPrepare a shipment of diamonds in Tracr for transfer to a retailer.
UniquenessThe extent to which a diamond has not been seen/registered before in the Diamond ID database.
Unlocked DiamondA polished diamond that has been unlocked by a participant. The diamond will appear on the Diamond Experience, Share, Participant API and Participant Search.
ViewA permissioned subset of data points from a diamond record.
# tracr 1.34.0 #### **Diamond Experience - Improved Tracr Verification and Error Messages (Locked Diamond Page)** * Users can now verify if a diamond exists on Tracr, even if it is locked. * Users are informed if a diamond has not met the requirements to have a Diamond Experience page, i.e. if it is not inscribed. * Users can register interest in downstream unlocking (which the Tracr Product team will assess desirability to bring on as a feature in the future). #### **GIS V1 Deprecation** * We have now fully deprecated the V1 GIS API and removed the Alpha tag from V2 API after communication with final users. #### **GIS V2** * Fixed an unhandled exception in GIS `validate-json` API when an incorrect file type is uploaded * Fixed a server error on GIS when an incorrect file type is uploaded. * Fixed an issue where Grading Lab shows the default value "Other" when using correct abbreviations in non-uppercase letters. #### **XPS** * Resolved an HTTP 500 error on the `/xps/` endpoint when hitting a diamond with an `inscription_number` asset. * Users can now verify if a diamond exists on Tracr, even if it is locked. * Users are informed if a diamond has not met the requirements to be accessed , i.e. if it is not inscribed. #### Portal * Added an Action Bar to Inbound Shipments * Split out active shipments tabs into distinct, organised views * Fixed gallery arrow display defects occurring when one or more media files are present in the Share view * Fixed a frontend pagination bug where applying a filter on the last page failed to reset the user to the first page * Fixed a layout defect where the wrong tab was displayed after closing the Eligible to Share drawer/table * Resolved an error preventing users from removing all shipments from the 'Eligible to accept' drawer * Fixed a defect where the default date range filter was not applied automatically on Monitoring * Fixed a UI glitch where the Details tab shows 0 immediately after accepting a shipment * Fixed a bug preventing the ineligible diamond table from opening inside the transfer drawer * Fixed the "Export All" functionality on the Monitoring page to ensure it downloads all records instead of filtered sets * Fixed a frontend issue preventing the Transfer drawer from opening when selecting or deselecting locked diamonds * Resolved horizontal scrollbar issues on the selection drawer table appearing after resizing columns * Prevented the Rough Check provider filter from mistakenly rendering on the producer view * Fixed a bug where file type labels were missing for BMP images on the Diamond Details view * Fixed a frontend defect where an "Unknown" status was displayed on the Accept Diamonds page following action completion * Fixed a regression causing broken interface behaviour when removing all eligible diamonds out of a drawer * Implemented validation guardrails to prevent polished diamonds from being accepted in the Accept Drawer * Fixed a UI issue where the share drawer unexpectedly closed when clicking 'Done' inside the share preview window * Handled parsing edge-cases to support commas inside the Recipients email field within Share flows * Implemented constraints prohibiting users from sharing a diamond while leaving the subject line and descriptions blank #### Tracr API * Optimised database queries to fix slow response times on the inventory diamond endpoint * Resolved an HTTP 500 error triggered when uploading a diagram file to `graded_measurement` without sending a specific `file_type` * Corrected sample data values provided inside the producer rough template within DIT # tracr 1.33.0 ### Portal * Display warning dialog when navigating between tabs in inventory when diamonds are selected; * Reinstate “new shipment” button in the outbound shipment list header; * Update terms & conditions links; * Add Petra Diamond Experience theme; * Prevent inbound and outbound shipment tables from scrolling to the top when refreshing data; * Fix bug preventing toast messages from being closed; * Use consistent formatting for Portal / Participant search / Diamond Experience footer items; * Updated shipments dialog copy for inbound/outbound rough and polished shipments; * Fix Sight year and Sight number display on Share and Archive/Unarchive drawers; * Fix bug resulting in sort criteria being dropped in the inventory when returning from diamond details; * Show a dash in the inventory when a diamond does not have a Participant ID; * Ensure date filter is persisted in inventory when page is refreshed; * Update all references to a diamonds colour to use a human readable representation of the colour. This will include the intensity, overtone and base colour for fancy coloured diamonds. For white coloured diamonds the standard D-Z colour scale will be used; ### API * Fixed issue which caused 422 when trying to get diamonds where versioned\_plaintext\_record.polished data is stored as a JSON null; * Fixed an issue where the POST /files/inscription-numbers endpoint incorrectly returned a 422 error for valid JSON payloads; * Ensure colour and fancy\_colour fields are mutually exclusive when creating and updating diamonds; * Ensure colour and fancy\_colour fields are mutually exclusive when uploading a grading certificate; * Expose a new field (display\_colour) in the rough and polished data returned from the PCS APIs that return diamond data; * Expose a new field (display\_colour) in data returned from the GIS and XPS APIs that return diamond data; * Removed the requirement for producers to provide a colour when registering diamonds at rough; ### GIS * Migration of centralised services to use Pydantic v2 models; ### XPS * Migration of centralised services to use Pydantic v2 models; # tracr 1.31.0 ### Tracr API Added the ability to accept, reject, or cancel an entire shipment through the API. ### Tracr Portal Improved tool tip interactions. ### Tracr Diamond Experience Improved tool tip interactions. # tracr 1.30.0 ## ### Tracr API * Implemented restrictions on diamonds registered by Sarine * The following attributes cannot be modified: * Rough carat weight * Rough scan * Implemented restrictions on diamonds polished by Sarine * The following attributes cannot be modified: * Polished carat weight * Polished shape * Polished scan * Polished scan report * Grading certificates can only be uploaded through GIS ### Portal * Implemented new archive flow * Implemented new unarchive flow * Added support for Polished Check ### Diamond Experience * Added support for Polished Check ### Grading Integration Service * Fixed and issue preventing GIS from working for diamonds that only have a carat weight and shape ### Integrations * Support split rough diamonds being registered by Sarine * Support polished diamonds being registered by Sarine # tracr 1.29.0 {% hint style="info" %} Release notes for Tracr Version 1.29.0 {% endhint %} ### Tracr Portal Release Notes * Implemented new share flow * Implemented tab redesign * Implemented multi-value search * Implemented new diamond unlock drawer * Optimisation of diamond inventory queries resulting in faster page load times * Fixed table responsiveness issues * Fixed bug resulting in wrong height for the last shape image when diamond has more than 3cts * Added default date selection to the monitoring page * Implemented new header component * Fixed issue resulting in the image for a rough diamond appearing differently on search and portal * Fixed issue resulting in lifecycle and archive status filters being cleared on page refresh * Fixed issue resulting in temporary display of irrelevant error when searching for an unlocked diamond after searching for a locked diamond * Fixed typo on ODC diamond experience page. Changed 32+ Billion Years Ago to 3.2+ Billion Years Ago * Updated the copy of the rough check tooltip of rough diamonds with a missing scan * Fixed bug resulting in the label for free text fields being shown when the field contains only spaces * Fixed bug that prevented sorting by Grading inscription number from working on diamond inventory pages * Fixed bug that prevented columns in the new table from being resized * Renamed “diamond experience” to “diamond details” ### Tracr API * Added 'registered\_by' filter to v2/diamonds API endpoint * Fixed issue resulting in only one identification\_candidate being sent if two rough\_identification sarine events are sent in quick succession * Exposed rough and polished objective verification through the API * Refactor API Export to Use Streaming and mitigate OOM Errors # tracr 1.28.0 ## Tracr Portal — Release Notes * Add new navigation component * Add Assurance page to support section of portal * Fix bug where the continue to share button is displayed when all diamonds are removed from the selection * Fix bug where no Rough child create event is displayed when splitting parent and child in the same CSV * Allow transfer page export to work with both the full and filtered list * Fix sorting arrows on the column headers where shown the wrong way around * Fix bug where opening the Diamond Experience page removes the search filter * Fix bug resulting in the wrong diamonds being displayed for a short time after opening an integration session In progress * Fix bug making it impossible to drag a wide column to be the first column in tables * Fix issue resulting in blank page being displayed when trying to access a diamond directly via URL * Fix wrong filter values order in Carat filter drop-down * Fix inconsistent formatting for labels in Key to Symbols section * Fix issue where symbols are not displayed when there is no space or extra space between them * Update table column for rough inventory with new status and add tooltips * Update diamond details page with new Objective Verification statuses * Update share preview page with new Objective Verification statuses * Update diamond experience page with new Objective Verification statuses * Update filters for status and rough-check * Add missing GIS status column name casting due to api refactoring ## Tracr API * Fix bug that prevented deletion of diamond where the same participant id is also used for another diamond * Fix bug where reports and links are opened in the same tab on global search * Add Rectangle as new shape in Tracr # tracr 1.27.0 ## Tracr Portal Release Notes * Add GIS Lab Eligibility feature. * Allow diamonds to be transferred out from inventory. * Improved performance when sorting by status column in diamond inventory pages. * Fix bug where removing unselected diamonds from list only removes one unselected diamond. * Fix bug where the Grading Date date format in the report is not consistent with the format in the table on Inventory. * Fix bug where clicking on the right side of the table does not open Diamond Experience. * Fix wrong colour used for Rough/Split/Polished status icon and label. * Fix issues with clicking on View button after unarchiving a diamond. ## Tracr API * Allow participants to update the participant id (ERP ID) of existing diamonds. # tracr 1.26.0 ## Tracr Portal Release Notes * Fix incorrect casing used for "Learn more" button. ## Tracr API * Enable search for inscription number and report number in application API. # tracr 1.25.0 ## Tracr Portal Release Notes * Improved performance when using a direct link to a diamond. * Fixed bug preventing available diamonds from being shared when the selection includes at least one locked diamond. * Fixed bug resulting in pop-up with 0 diamonds being shown for a short period after closing the Archive or Unarchive pop-up. * Added missing shape icons to filters on the inventory list. * Fixed bug resulting in split section not displaying correctly on mobile and tablet. * Fixed bug resulting in polished gallery being truncated when resizing the window. * Fixed incorrect help docs link on outbound shipments list. * Allow diamonds to be shared regardless of whether they're being transferred or not. * Prevent drag mode from being entered for long press on sort button. ## Tracr API * Fixed bug where two different participants using the same name for shipments being sent to a single recipient results in one of those shipments failing to transfer. * Added participant id to error message indicating that the diamond is already registered in the platform. # tracr 1.24.0 ## Tracr Portal Release Notes * Enable Cross ID search. * Expose diamond grader report number on the "Your Diamond" section in participant search. * Where multiple matches are found in global search and participant search, present all matches and allow the user to select which diamond they want to view details for. * Show report numbers and inscription numbers for polished diamonds on shipment screens. * Add report numbers and inscription numbers to polished shipment exports. * Ensure consistent display of missing grader\_report\_no. * Add tooltip icon and text inside Search boxes across Inventory and Shipment pages. * Display report number in diamond details section. * Fix bug that prevented space characters from being entered into the search bar. ## Tracr API * Diamonds can now be filtered by outbound shipment id, or whether they are in an outbound shipment more generally. * Inbound and outbound shipments can now be filtered by status and diamond\_id. # tracr 1.23.0 ## Tracr Portal Release Notes * Improved XPS response times when searching for locked diamonds. * Added support for archived diamonds: * Introduced a new Archived tab in inventory. * Allow diamonds to be archived/unarchived. * “Transferring” status is displayed for both rough and polished diamonds. ## Tracr API * Prevent updates to diamonds, including associated files, which no longer have a possession state of HELD. * Added `is_country_code_available` datapoint to diamond provenance. * Exposed inscription numbers through inbound shipment endpoints. # tracr 1.22.0 ## Tracr Portal Release Notes * Extended Tracr Rough Check to non-De Beers diamonds. * Removed the card view from inventory screens. * Various bug fixes and UI improvements. ## Tracr API * Added a new `/v2/diamond` endpoint for listing diamonds matching search criteria. # tracr 1.21.0 ## Tracr Search * Made search.tracr.com available to inscribed, unlocked diamonds only. * Surface inscribed, unlocked, Mountain Province diamonds on search.tracr.com. ## Tracr Portal * Fixed an issue whereby certain STL files were not visible on the Diamond Experience. * Ensured carat weights are displayed to 3 decimal places when viewing an inbound rough shipment, in line with the precision displayed elsewhere. ## Tracr API * Added a new `v2/diamonds/{diamond_id}/rough` endpoint for updating the attributes of rough diamonds. This new endpoint allows users to set `NULL`-able fields to `NULL`. * Added new `country_code` field to provenance, expressing the diamond’s single country of origin (if this exists) as an ISO-3166 compliant country code. * General bug fixes and efficiency improvements. # tracr 1.20.0 ## Portal * Fixed an issue whereby the wrong unlock diamonds pop-up is displayed on Inventory Card View - Continue without locked diamonds button was not displayed. * Fixed an issue where the rough check badge is displayed on Share Preview but not on the Shared Diamond Experience. * Fixed an issue where some diamonds are not visible in the grid on Shipments Overview. * Fixed an issue where total carat weight was not shown on the Outbound Shipments Overview page. * Fixed an issue where “Provenance” filter is displayed as both primary and secondary filter in the Inventory. * Fixed an issue preventing diamonds from being selected on Inventory Card View. * Fixed an issue resulting in blank page being displayed on Inventory Card View. * Fixed an issue resulting in a resumed session always opening on the Overview tab regardless of the latest tab accessed. * Fixed an issue resulting in “Certificate No” label being displayed when the field is not populated. * Fixed an issue whereby the Download as .xlsx button in the Integration Tool is clickable and a report is downloaded when no files are present in the tabs. * Updated the Global Search error message to account for not found and locked diamonds. * Updated the terms and conditions. * Updated the rules for display of carat weights on the Global Search Grading page. * Added a URL link to the GIA Grading Page on the Global Search Grading page. ## API * Implementation of the first phase of integration with Sarine Cloud. # tracr 1.19.0 ## API * Allow nullable polished fields to be set to null when updating a polished diamond via a new /v2 endpoint (see the API documentation for guidance). * Performance and efficiency improvements.
Notes on the /v2 endpoint * Use the new /v2 endpoint when you need to set previously nullable polished fields to null during an update. * Refer to the API documentation for exact request/response formats and any migration guidance.
## Portal * Fixed an issue where diamonds could not be transferred back to the participant that sent them. * Fixed an issue with Tracr Rough Check not being transferred. ## Search * Fixes and improvements to the GIA Grading page on search.tracr.com. # tracr 1.18.0 * Tracr now displays a GIA-branded grading page on search.tracr.com for diamonds with certificates uploaded to Tracr by the GIA after 13th August 2024. * General bug fixes and improvements. # tracr 1.17.0 ## Polishing diamonds * Mandated that carats and shape must be specified when polishing a diamond or when updating a diamond that has already been polished. ## Grading data management * Fixed the permissible values for `girdle_condition` when uploading a grading certificate. Permissible values for girdle condition are now: B, F, and P. ## Miscellaneous * General bug fixes and improvements. # tracr 1.16.0 * General fixes to inventory. * General fixes to Global Search. * Delete API bug fixes. * Platform performance fixes. # tracr 1.15.0 ## Shipment checks * Initial release of the ability for Tracr to scale to additional producers. * Introduction of the concept of shipments for diamonds sold outside of the DB box/sight processes. ## Rough Check Downstream * Ensure Tracr Rough Check status is transferred downstream to the receiving Tracr participant. ## Portal * Redirect users to the polished inventory on logging into retailer Portal instances. * Display a diamond’s country of origin in the Portal inventory and search screens. * Only display a diamond’s latest grading data in the Portal inventory and search screens. # tracr 1.14.0 ## Tracr Rough Check We are happy to announce the release of Rough Check in the portal. Rough Check is a check against the rough diamond uploaded by the producer and the rough diamond a manufacturer uploads. This check is performed using Diamond ID, a core service in the Tracr platform ecosystem primarily tasked with validating, verifying and identifying diamonds. You will be able to see a Rough Check against your diamond in the Rough Inventory section and the diamond details page. {% hint style="info" %} We will be following up this release with the ability to transfer the Rough Check downstream. {% endhint %} ## Tracr Portal Release Notes * Fixed a bug with the Export Inventory button. ## Tracr API Release Notes * Disabled modification of `box_id`, `box_description`, `sight_year` and `sight_no` fields when polishing a rough diamond or updating a polished diamond. These fields are now ignored if sent in a request to the following endpoints: {% code title="Endpoints" %} ``` POST v1/diamonds/polish PATCH /v1/diamonds/polished ``` {% endcode %} # tracr 1.13.0 ## Tracr Portal — Release Notes * Modified the flow for accepting transfers of polished diamonds so that inscription numbers no longer need to be provided. * Minor changes to URL formats in the Portal. ## Tracr API — Release Notes * Updated the way in which Tracr IDs are generated when registering new diamonds or splitting existing ones. * Database maintenance work for platform stability. # tracr 1.12.0 ## Tracr API Release Notes * Fixed sporadic 404s when uploading files for diamonds created in the same session with the Integration Tool. * Bug fixes and improvements. # tracr 1.11.0 ## Tracr Portal Release Notes * Fixed an issue with splitting/polishing diamonds that were created or last updated prior to 2023. ## Tracr API Release Notes * Fixed an issue with fetching diamonds via the `/diamonds` endpoint when they were created or last updated prior to 2023. * Gracefully handle deletion of diamonds unlocked after 1st January 2024 by making the error explicit. # tracr 1.10.0 ## Tracr Portal Release Notes This release brings changes to the Tracr portal in preparation for diamond unlocking charges that will apply from 1st January 2024. Please see for a comprehensive overview of the changes. Alongside these changes, this release contains some UI improvements and bug fixes: * Fixed an issue whereby transferred diamonds are still visible in the sender’s Participant Search. * Fixed an issue whereby diamonds destroyed via a split operation are still visible in Participant Search. * Ensured diamond measurements are displayed to two decimal places, e.g., 1.00 carat instead of 1 carat. ## Tracr API Release Notes * Bug fixes and improvements to the diamond deletion endpoint. * Added new endpoint: {% code title="New endpoint" %} ``` POST /bulk/diamonds/unlock ``` {% endcode %} # tracr 1.10.1 ## Tracr API Release Notes * Fixed an authentication issue with Cross-Participant Search (XPS). # tracr 1.9.0 ## Tracr Portal Release Notes * In the Inventory section, the single country of origin of a diamond is now displayed where this information exists. * Bug fixes in Share screens. ## Tracr API Release Notes * Added an endpoint to delete diamonds in bulk (see below). * Removed the /destroy endpoint. ## Delete endpoint It is now possible to delete diamonds (up to 50 at a time, including children) via the `/bulk/diamonds/delete` endpoint. This operation can only be performed for certain eligible diamonds. Please refer to the Getting Started section of the API docs for more information on how to use this endpoint and the criteria those diamonds must satisfy: # tracr 1.9.1 ## Tracr API Release Notes * Fixed a bug in the `bulk/diamonds/delete` endpoint. # tracr 1.8.0 ## Tracr Portal Release Notes * Added borders to gallery images in the Diamond Experience and Share screens. * Fixed an issue whereby destroyed diamonds were still visible in the Diamond Experience. * Improved the efficiency and response times of loading Integration Events on the Monitoring Page. * Bug fixes for diamond transfer and diamond search. # tracr 1.7.0 ## Tracr Portal Release Notes * Fixed an issue with selecting and sorting diamonds in the Inventory page. * Added the ability for integration events on the Monitoring page to be filtered for diamonds with "Error" status. * Improvements to Inventory screen user interface. * Fixed discrepancies between the number of images on the Inventory screen and the Diamond Experience. * Added box ID checks against sight year and number when uploading a CSV via the Diamond Integration Tool (see note below). * Improvements to UI consistency. ## Tracr API Release Notes * Added box ID checks against sight year and number when creating a diamond via the API (see note below). {% hint style="info" %} Note on box checks In addition to box ID, the Tracr API and Diamond Integration Tool now check sight year and sight number when verifying a diamond’s box on upload. A diamond which has a valid box ID but an incorrect corresponding sight year and/or number will be rejected. In addition to the existing checks, a diamond can now only be added to the inventory if these fields align. {% endhint %} # tracr 1.7.1 ## Tracr Portal Release Notes * Fixed an issue preventing new integration events from being created and displayed on the Monitoring page. # tracr 1.6.0 ## Tracr Portal Release Notes In the Inventory section: * Fixed an issue where the wrong video is shown when multiple diamonds are shared as a set. * Fixed an issue where a shared diamond was only sent to the last email in the list in some situations. * Fixed an issue where sorting by certain fields would cause errors. * Fixed an issue where the count of diamonds would not match the number of diamonds shown. ## Tracr API Release Notes * Improvements to the handling of weight data in GIS. # tracr 1.5.0 ## Tracr Portal Release Notes ### Diamond Experience * Show diagrams in the Gallery * Additional support for BMP images * Aligned grading certificate display with Global Search (show the latest grading certificate) * Fixes to file uploads * Other bug fixes and improvements ### Participant Search * Show all inscription numbers * Fixes to align with Global Search ## Tracr API Release Notes * Improvements to data handling routines * Improvements to the grading lab integration processes * Improvements to the handling of weight data # Get Started with Tracr Search Authenticated\_copy > **Who is this document for?** > > 3rd Party Blockchain Integrations Tracr Search V1 Authenticated is an API allowing non-Tracr participants to search for a diamond across all of Tracr's instances and return traceability data for both locked and unlocked diamonds. There is no transferring of a digital asset {% hint style="warning" %} **You need to know** The Tracr Search API V1 Authenticated is only available for authenticated users. For more details please contact . {% endhint %} ## Before you start * Contact Tracr Support () to obtain authentication credentials. * Obtain the Tracr ID of the diamond that you want to look up. {% hint style="info" %} ### API security The API use OAuth 2.0 authentication. Tracr Support will provide a Client ID and Client Secret during the technical onboarding. {% endhint %} ### Generate a JWT token Call `POST https://auth.tracr.com/oauth/token` {% tabs %} {% tab title="Request" %} ```json { "client_id":"", "client_secret":"", "audience":"https://search.tracr.network/v1", "grant_type":"client_credentials" } ``` {% endtab %} {% tab title="Response" %} ```json { "access_token": "", "token_type": "Bearer" } ``` {% endtab %} {% endtabs %} ### Pass the token to the endpoint To pass the token to the API, provide it in the Authorization header. ``` Authorization: ``` ## Look up a diamond in Tracr ### [Retrieve single diamond details](broken://pages/220ec9d6f7a84841bd6a72e7f4fde3ca1f29ef16) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "unlocked_status": "unlocked", "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } } ``` {% endtab %} {% endtabs %} Here the API returns an object called a **diamond record**. A diamond record represents the current version of the digital asset in Tracr. **Diamond ID** – Each diamond on the platform has a unique `diamond_id` (or tracr id). **Diamond Parent ID** – The identifier of the parent diamond. **Lifecycle State** – The current state of a diamond. Tracr has four lifecycle states: * `rough` * `split` * `polished` * `destroyed` **Rough** – The object related to the rough state of the diamond before being polished. For a rough diamond having multiple cuts, the rough section represents one of the cuts. The parent diamond will represent the original rough diamond. **Polished** – The object related to the polished state of the diamond. ### [Retrieve diamond ancestors](broken://pages/14f94d3c706966a518d6b202d4adc4a10f746d7d) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/history` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "content": { "current": { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "unlocked_status": "unlocked", "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } }, "snbp04qev51mz7whoz1ttmjhy": { "diamond_id": "snbp04qev51mz7whoz1ttmjhy", "diamond_parent_id": null, "lifecycle_state": "split", "current_stage": "rough", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 129.71, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-rough-206-1.jpg", "description": null, "hash": "60505ac214dda6a8b72a6ded5da32dc1a15bc0480f26027909d786ce510511c4", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": [ { "filename": "demo-rough-206-1.mp4", "description": null, "hash": "5ce066c86dfcdc245f1985199a59fd1fbf62f046303eb06d88ce9fd8f7549691" } ] }, "polished": { "carats": null, "clarity": null, "colour": null, "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": null, "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": null, "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "shape": null, "silhouettes": null, "symmetry": null, "table_percent": null, "supplementary_files": null, "width": null, "images": null, "videos": null } } } } ``` {% endtab %} {% endtabs %} ### [Retrieve a file](broken://pages/558fac70a5d950cf70b4406f1e9ed3a6c75a0625) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/files/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ``` HTTP Code : 302 Headers: location: https://5aa4ed9b-c04a-45b0-82fb-b09c771600dd.tracr.com/diamond-assets/87f7a020-09fe-4c59-a5b0-74942ca57fae/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce ``` {% endtab %} {% endtabs %} # Introduction Tracr Search allows non-participants, for example, marketplaces, to search for a diamond or multiple diamonds across all of Tracr and return traceability data. The Tracr Search API provides endpoints to search a single diamond in Tracr. Diamonds are returned anonymously. A [bulk search API](/api-reference/references/tracr-xps-api-v1#post-v1-bulk-traceability-ancestry) endpoint is also available for restricted users only. This endpoint can search for a list of diamonds. Please contact for more details. ### What is Tracr? Tracr is an advanced technology platform developed by De Beers Group to underpin trust in diamond provenance. Using leading-edge technologies, including blockchain, artificial intelligence, the internet of things and advanced security and privacy technologies, Tracr enables confidence in a diamond's source throughout the diamond value chain. The Tracr platform combines distributed ledger technology with advanced data security and privacy, ensuring that participants control the use of and access to their own data. Each participant on Tracr has their own distributed version of the platform, meaning that their data can only be shared with their permission, and only they choose who can access their information. The advanced privacy technologies used by Tracr reinforce data security on the platform. The immutable nature of each transaction on the platform ensures that the data cannot be tampered with when the diamond progresses through the value chain. The decentralised nature of the platform ensures its speed and scalability, with the ability to register one million diamonds a week onto the platform. With centralised platforms, dealing with large volumes of data can cause bottlenecks, but the decentralised model used by Tracr avoids such issues and enables rapid scaling. # Get Started with the Tracr Search API Tracr Search is an API allowing non-participants to search for a diamond across all of Tracr and return traceability data. ## Before you start Obtain the Tracr ID of the diamond that you want to look up. ## Look up a diamond in Tracr ### [Retrieve single diamond details](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } } ``` {% endtab %} {% endtabs %} Here the API returns an object called a **diamond record**. A diamond record represents the current version of the digital asset in Tracr. **Diamond ID** – Each diamond on the platform has a unique `diamond_id` (or tracr id). **Diamond Parent ID** – The identifier of the parent diamond. **Lifecycle State** – The current state of a diamond. Tracr has four lifecycle states: * `rough` * `split` * `polished` * `destroyed` **Rough** – The object related to the rough state of the diamond before being polished. For a rough diamond having multiple cuts, the rough section represents one of the cuts. The parent diamond will represent the original rough diamond. **Polished** – The object related to the polished state of the diamond. ### [Retrieve diamond ancestors](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id-history) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/history` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "content": { "current": { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } }, "snbp04qev51mz7whoz1ttmjhy": { "diamond_id": "snbp04qev51mz7whoz1ttmjhy", "diamond_parent_id": null, "lifecycle_state": "split", "current_stage": "rough", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 129.71, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-rough-206-1.jpg", "description": null, "hash": "60505ac214dda6a8b72a6ded5da32dc1a15bc0480f26027909d786ce510511c4", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": [ { "filename": "demo-rough-206-1.mp4", "description": null, "hash": "5ce066c86dfcdc245f1985199a59fd1fbf62f046303eb06d88ce9fd8f7549691" } ] }, "polished": { "carats": null, "clarity": null, "colour": null, "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": null, "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": null, "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "shape": null, "silhouettes": null, "symmetry": null, "table_percent": null, "supplementary_files": null, "width": null, "images": null, "videos": null } } } } ``` {% endtab %} {% endtabs %} ### [Retrieve a file](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id-files-file_hash) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/files/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ``` HTTP Code : 302 Headers: location: https://5aa4ed9b-c04a-45b0-82fb-b09c771600dd.tracr.com/diamond-assets/87f7a020-09fe-4c59-a5b0-74942ca57fae/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce ``` {% endtab %} {% endtabs %} # Get Started with Tracr Search -Authenticated Tracr Search V1 Authenticated is an API allowing non-participants to search for a diamond across all of Tracr and return traceability data for both locked and unlocked diamonds. {% hint style="info" %} **You need to know** The Tracr Search API V1 Authenticated is only available for authenticated users. For more details please contact . {% endhint %} ## Before you start * Contact Tracr Support () to obtain authentication credentials. * Obtain the Tracr ID of the diamond that you want to look up. {% hint style="info" %} ### API security The API use OAuth 2.0 authentication. Tracr Support will provide a Client ID and Client Secret during the technical onboarding. {% endhint %} ### Generate a JWT token Call `POST https://auth.tracr.com/oauth/token` {% tabs %} {% tab title="Request" %} ```json { "client_id":"", "client_secret":"", "audience":"https://search.tracr.network/v1", "grant_type":"client_credentials" } ``` {% endtab %} {% tab title="Response" %} ```json { "access_token": "", "token_type": "Bearer" } ``` {% endtab %} {% endtabs %} ### Pass the token to the endpoint To pass the token to the API, provide it in the Authorization header. ``` Authorization: ``` ## Look up a diamond in Tracr ### [Retrieve single diamond details](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "unlocked_status": "unlocked", "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } } ``` {% endtab %} {% endtabs %} Here the API returns an object called a **diamond record**. A diamond record represents the current version of the digital asset in Tracr. * **Diamond ID** – Each diamond on the platform has a unique `diamond_id` (or tracr id). * **Diamond Parent ID** – The identifier of the parent diamond. * **Lifecycle State** – The current state of a diamond. Tracr has four lifecycle states: * `rough` * `split` * `polished` * `destroyed` * **Rough** – The object related to the rough state of the diamond before being polished. For a rough diamond having multiple cuts, the rough section represents one of the cuts. The parent diamond will represent the original rough diamond. * **Polished** – The object related to the polished state of the diamond. ### [Retrieve diamond ancestors](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id-history) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/history` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ```json { "content": { "current": { "diamond_id": "sm9og0cgxhpqy78vvo51btem1", "diamond_parent_id": "snbp04qev51mz7whoz1ttmjhy", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 23.42, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-split-206-1F.jpg", "description": null, "hash": "7c869b7844242c3355c9333d6444ae3883df9cff5e7f9343e4cb68c4ad35ca3e", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 10.1, "clarity": "FL", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "EX", "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": [ { "filename": "5212039959.pdf", "description": null, "hash": "476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce", "grading_lab": "GIA", "graded_date": null, "grader_certificate_no": null, "grader_report_no": "5212039959", "grader_inscription_no": null } ], "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo-polished-206-1F.stl", "description": null, "hash": "cf32f03ad4230538cdc195a024f3c126133c8228386b89348f0063f0b81f56f6", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo-polished-206-1F.html", "description": null, "hash": "275eab5473a8d5845256f99e375f650e29cb2abe2b55a53a01f9018e9b823495", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Emerald", "silhouettes": null, "symmetry": "EX", "table_percent": null, "supplementary_files": null, "unlocked_status": "unlocked", "width": null, "images": [ { "filename": "demo-polished-206-1F_P.jpg", "description": null, "hash": "d3d3db369db95f944bf7f153622d933971eb3622ce435ab9cfd95149a8ea0db5", "image_type": "default" } ], "videos": null } }, "snbp04qev51mz7whoz1ttmjhy": { "diamond_id": "snbp04qev51mz7whoz1ttmjhy", "diamond_parent_id": null, "lifecycle_state": "split", "current_stage": "rough", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 129.71, "colour": "D", "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": "N", "images": [ { "filename": "demo-rough-206-1.jpg", "description": null, "hash": "60505ac214dda6a8b72a6ded5da32dc1a15bc0480f26027909d786ce510511c4", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": [ { "filename": "demo-rough-206-1.mp4", "description": null, "hash": "5ce066c86dfcdc245f1985199a59fd1fbf62f046303eb06d88ce9fd8f7549691" } ] }, "polished": { "carats": null, "clarity": null, "colour": null, "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": null, "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": null, "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "shape": null, "silhouettes": null, "symmetry": null, "table_percent": null, "supplementary_files": null, "width": null, "images": null, "videos": null } } } } ``` {% endtab %} {% endtabs %} ### [Retrieve a file](/api-reference/references/tracr-xps-api-v1#get-v1-diamonds-diamond_id-files-file_hash) Call `GET /v1/diamonds/sm9og0cgxhpqy78vvo51btem1/files/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce` {% tabs %} {% tab title="Request" %} ```json ``` {% endtab %} {% tab title="Response" %} ``` HTTP Code : 302 Headers: location: https://5aa4ed9b-c04a-45b0-82fb-b09c771600dd.tracr.com/diamond-assets/87f7a020-09fe-4c59-a5b0-74942ca57fae/476da635d609cd9fd113bb1a916d7e650a5440140f2ec81fa83719386377ccce ``` {% endtab %} {% endtabs %} # Get Started with Tracr Search Bulk The Tracr Search Bulk API allows to search for up to 1000 diamonds from multiple participants of Tracr and retrieve the history of the diamond up to the original rough. {% hint style="info" %} **You need to know** The Tracr Search Bulk API is only available for authenticated users. For more details please contact . {% endhint %} ## Before you start * Contact Tracr Support () to obtain authentication credentials. * Collect the platform ID (UUID - the participant's unique identifier) and the Tracr ID of the polished diamond(s) from the owner of the diamond(s) that you want to query. {% hint style="info" %} **Platform ID** You will need the platform ID to be able to search other user's Tracr instances. This can be collected from the URL in either UAT or Prod: `{platform_id}.uat.tracr.com` or `{platform_id}.tracr.com` {% endhint %} ## API security The API use OAuth 2.0 authentication. Tracr Support will provide a Client ID and Client Secret during the technical onboarding. ### Generate a JWT token Call `POST https://auth.tracr.com/oauth/token` {% tabs %} {% tab title="Request" %} ```json { "client_id":"", "client_secret":"", "audience":"https://search.tracr.network/v1", "grant_type":"client_credentials" } ``` {% endtab %} {% tab title="Response" %} ```json { "access_token": "", "token_type": "Bearer" } ``` {% endtab %} {% endtabs %} ### Pass the token to the endpoint To pass the token to the API, provide it in the Authorization header. ``` Authorization: ``` ## Get the ancestry for bulk diamonds Call `POST /v1/bulk/traceability-ancestry` {% tabs %} {% tab title="Request" %} ```json { "data": [ { "diamonds": [ { "diamond_id": "clitz8x970000m7yt0pu8u74e" }, { "diamond_id": "clismtsp20001lzyt6072ut87" }, { "diamond_id": "cli3lpy2i00003tzqdso2bxke" } ], "platform_id": "11111111-1111-1111-1111-111111111111", "modified_since": "2023-06-26T00:00:00+01:00" } ] } ``` {% endtab %} {% tab title="Response" %} ```json { "results": [ { "status": "success", "platform_id": "11111111-1111-1111-1111-111111111111", "diamonds": { "cli3lpy2i00003tzqdso2bxke": [ { "diamond_id": "cli3lpjf400003oytprcxdhh8", "diamond_parent_id": null, "lifecycle_state": "split", "current_stage": "rough", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 8.0, "colour": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "images": [ { "filename": "demo_rough_1.jpg", "description": "Rough Diamond Picture", "hash": "32a1c0b50e7724684a96f2661bf70f67a465fd479a2e34833aedd003958bbe9d", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": [ { "filename": "demo_rough_1.mp4", "description": "Rough Diamond Video", "hash": "c9806fdcfbd144eebb8a79d52956bd79bcc4dba34794a5a16294840fc6a485c0" } ] }, "polished": { "carats": null, "clarity": null, "colour": null, "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": null, "depth": null, "depth_percent": null, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": null, "girdle_thickness_to": null, "grading_certificates": null, "length": null, "model": null, "pavillion_angle": null, "pavillion_percent": null, "polish_quality": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "shape": null, "silhouettes": null, "symmetry": null, "table_percent": null, "supplementary_files": null, "width": null, "images": null, "videos": null } }, { "diamond_id": "cli3lpy2i00003tzqdso2bxke", "diamond_parent_id": "cli3lpjf400003oytprcxdhh8", "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 5.123, "colour": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "images": [ { "filename": "split_demo_1.jpg", "description": "Split Diamond Picture", "hash": "9a76d5afceba756d7c1d9b26e8a654abd87c7f102878a2ab0e21a043a9d8dfcc", "image_type": "default" } ], "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 1.815, "clarity": "VVS2", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "VG", "depth": 4.23, "depth_percent": 62.9, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": "N", "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": "Slightly Thin", "girdle_thickness_to": null, "grading_certificates": [ { "filename": "demo_polished_1.pdf", "description": null, "hash": "1a9cbfaed6dc9fa95203a02dc3ba6ff5939a0e02ad2f433e63f3a24eaf1a0dc4", "grading_lab": "GIA", "graded_date": "2023-05-25T21:43:41", "grader_certificate_no": "GIA 215296640", "grader_report_no": "215296640", "grader_inscription_no": "GIA 215296640" } ], "length": 6.84, "model": null, "pavillion_angle": 40.8, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo_polished_1.stl", "description": null, "hash": "7c3d05c6b1303ee0bf3ee8c2c5ae5b6a5ab3f82928d2e8b3c4d53c8b691dfdf4", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo_polished_1.xml", "description": null, "hash": "feb55eba3edc6805d7f36f9b9bd540d4134fdd82d7a62fedcc504cffa4be1e03", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Round", "silhouettes": null, "symmetry": "VG", "table_percent": 57.0, "supplementary_files": null, "width": 6.83, "images": [ { "filename": "demo_polished_1.jpg", "description": "Polished Diamond Picture", "hash": "092aa374cec6e846874ba5bdabc2cf03ad3002eaccc55e0eb8b61697763238b0", "image_type": "default" }, { "filename": "demo_polished_1_Arrows.jpg", "description": "Polished Diamond Picture", "hash": "8eefc0aac8a7ab1b723b207c1984e8d36e4aee5f1df33b7289a480eb6339cf10", "image_type": "arrow" }, { "filename": "demo_polished_1_heart.jpg", "description": "Polished Diamond Picture", "hash": "602a3a79417a7502936ddbbb9b5384f7f65f26ab70ca91f1a0ed7d3961e001b4", "image_type": "heart" } ], "videos": [ { "filename": "demo_polished_1.mp4", "description": "Polished Diamond videos", "hash": "515756198048fad606e270521e6f5b09a17e20ef4240ebfb0ac582f715179f1f" } ] } } ], "clismtsp20001lzyt6072ut87": [ { "diamond_id": "clismtsp20001lzyt6072ut87", "diamond_parent_id": null, "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 5.0, "colour": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "images": null, "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 2.159, "clarity": "VVS2", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "VG", "depth": 4.21, "depth_percent": 62.4, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": "N", "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": "Slightly Thin", "girdle_thickness_to": null, "grading_certificates": [ { "filename": "demo_polished_1.pdf", "description": null, "hash": "1a9cbfaed6dc9fa95203a02dc3ba6ff5939a0e02ad2f433e63f3a24eaf1a0dc4", "grading_lab": "GIA", "graded_date": "0001-01-01T00:00:00", "grader_certificate_no": "GIA 215292022", "grader_report_no": "215292022", "grader_inscription_no": "GIA 215292022" } ], "length": 6.86, "model": null, "pavillion_angle": 40.8, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo_polished_1.stl", "description": null, "hash": "bdc971ad48b3d50e93a6796af94391921e8032c62e5850f782c7cf7a60714173", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo_polished_1.xml", "description": null, "hash": "61dec403d00e715e0d3bd8593f9c4b23635943d1ee16113b3d6f8f6fee9e18f3", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Round", "silhouettes": null, "symmetry": "VG", "table_percent": 57.0, "supplementary_files": null, "width": 6.85, "images": [ { "filename": "demo_polished_1.jpg", "description": "Polished Diamond Picture", "hash": "092aa374cec6e846874ba5bdabc2cf03ad3002eaccc55e0eb8b61697763238b0", "image_type": "default" }, { "filename": "demo_polished_1_Arrows.jpg", "description": "Polished Diamond Picture", "hash": "8eefc0aac8a7ab1b723b207c1984e8d36e4aee5f1df33b7289a480eb6339cf10", "image_type": "arrow" }, { "filename": "demo_polished_1_heart.jpg", "description": "Polished Diamond Picture", "hash": "602a3a79417a7502936ddbbb9b5384f7f65f26ab70ca91f1a0ed7d3961e001b4", "image_type": "heart" } ], "videos": [ { "filename": "demo_polished_1.mp4", "description": "Polished Diamond videos", "hash": "515756198048fad606e270521e6f5b09a17e20ef4240ebfb0ac582f715179f1f" } ] } } ], "clitz8x970000m7yt0pu8u74e": [ { "diamond_id": "clitz8x970000m7yt0pu8u74e", "diamond_parent_id": null, "lifecycle_state": "polished", "current_stage": "polished", "assurance_level": "assured", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "mine_name": null }, "rough": { "carats": 5.0, "colour": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": null, "fluorescence_intensity": null, "images": null, "model": null, "plan": null, "plan_reports": null, "quality": null, "scan": null, "scan_reports": null, "silhouettes": null, "stress": null, "supplementary_files": null, "videos": null }, "polished": { "carats": 3.386, "clarity": "VVS2", "colour": "D", "crown_angle": null, "crown_height": null, "culet_condition": null, "culet_size": null, "cut_grade": "VG", "depth": 4.28, "depth_percent": 62.1, "diameter_maximum": null, "diameter_minimum": null, "fancy_colour": null, "fancy_colour_intensity": null, "fancy_colour_overtone": null, "fluorescence_colour": "N", "fluorescence_intensity": null, "girdle_condition": null, "girdle_thickness_from": "Slightly Thin", "girdle_thickness_to": null, "grading_certificates": [ { "filename": "demo_polished_1.pdf", "description": null, "hash": "1a9cbfaed6dc9fa95203a02dc3ba6ff5939a0e02ad2f433e63f3a24eaf1a0dc4", "grading_lab": "GIA", "graded_date": "0001-01-01T00:00:00", "grader_certificate_no": "GIA 215294850", "grader_report_no": "215294850", "grader_inscription_no": "GIA 215294850" } ], "length": 6.83, "model": null, "pavillion_angle": 40.8, "pavillion_percent": null, "polish_quality": "EX", "plan": null, "plan_reports": null, "quality": null, "scan": { "filename": "demo_polished_1.stl", "description": null, "hash": "bdc971ad48b3d50e93a6796af94391921e8032c62e5850f782c7cf7a60714173", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null }, "scan_reports": [ { "filename": "demo_polished_1.xml", "description": null, "hash": "61dec403d00e715e0d3bd8593f9c4b23635943d1ee16113b3d6f8f6fee9e18f3", "scan_device_manufacturer": null, "scan_device_model": null, "scan_software_name": null, "scan_software_version": null } ], "shape": "Round", "silhouettes": null, "symmetry": "VG", "table_percent": 57.0, "supplementary_files": null, "width": 6.85, "images": [ { "filename": "demo_polished_1.jpg", "description": "Polished Diamond Picture", "hash": "092aa374cec6e846874ba5bdabc2cf03ad3002eaccc55e0eb8b61697763238b0", "image_type": "default" }, { "filename": "demo_polished_1_Arrows.jpg", "description": "Polished Diamond Picture", "hash": "8eefc0aac8a7ab1b723b207c1984e8d36e4aee5f1df33b7289a480eb6339cf10", "image_type": "arrow" }, { "filename": "demo_polished_1_heart.jpg", "description": "Polished Diamond Picture", "hash": "602a3a79417a7502936ddbbb9b5384f7f65f26ab70ca91f1a0ed7d3961e001b4", "image_type": "heart" } ], "videos": [ { "filename": "demo_polished_1.mp4", "description": "Polished Diamond videos", "hash": "515756198048fad606e270521e6f5b09a17e20ef4240ebfb0ac582f715179f1f" } ] } } ] } } ] } ``` {% endtab %} {% endtabs %} ### Request The request object is a collection of search items. Each search item is related to a platform ID and a list of Tracr IDs. Example: ```json { "data": [ { "diamonds": [], "platform_id": "platform_id_1", "modified_since": "" }, { "diamonds": [], "platform_id": "platform_id_2", "modified_since": "" } ] } ``` * Diamonds – A list of Tracr IDs from the given platform IDs. * Platform ID - The unique Tracr identifier of the participant. This ID is static. * Modified Since - An optional filter to retrieve only diamonds updated after a specific date. ### Results An array of Result items. *Result item* * Status - The status of the query for the platform. Status can be `success` or `unauthorised`. * Platform ID - The unique Tracr identifier of the participant. * Results - A dictionary with the search results.\ Key : Tracr ID\ Value : A collection of diamonds including ancestors. ### Unauthorised access Each participant needs to authorise the API to access the inventory. If the permission is missing, the API cannot request any diamonds for a platform id. Example: ```json { "status": "unauthorised", "platform_id": "11111111-1111-1111-1111-111111111111", "error": "You are not authorised to request diamonds from this participant." } ``` The participant needs to raise a ticket with Tracr Support () to get the permission set up. # Tracr XPS API V1 ## Get Diamonds > Search for diamonds matching the given query. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"Paginator_CrossIdDiamondSearchResult_":{"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/CrossIdDiamondSearchResult"},"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":"Paginator[CrossIdDiamondSearchResult]","type":"object"},"CrossIdDiamondSearchResult":{"description":"Represents a single diamond in the database, as returned by a cross-id-search.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"description":"The identifier by which this diamond was retrieved.","enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"locked_diamond":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Locked Diamond"}},"required":["identity_type","diamond"],"title":"CrossIdDiamondSearchResult","type":"object"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v1/diamonds/":{"get":{"description":"Search for diamonds matching the given query.","operationId":"get_diamonds_v1_diamonds__get","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Page number","minimum":1,"title":"Page","type":"integer"}},{"in":"query","name":"size","required":false,"schema":{"default":100,"maximum":1000,"minimum":1,"title":"Size","type":"integer"}},{"in":"query","name":"search","required":true,"schema":{"title":"Search","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginator_CrossIdDiamondSearchResult_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamonds","tags":["Tracr XPS API v1","Diamond Search"]}}}} ``` ## Get Diamond > Look up a single diamond in Tracr and return its data if it exists. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"diamond_id":{"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"}],"title":"Diamond Parent Id"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v1/diamonds/{diamond_id}":{"get":{"description":"Look up a single diamond in Tracr and return its data if it exists.","operationId":"get_diamond_v1_diamonds__diamond_id__get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamond","tags":["Tracr XPS API v1","Diamond Search"]}}}} ``` ## Get Diamond File > Fetch a single file's pre-signed URL and return a Response. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v1/diamonds/{diamond_id}/files/{file_hash}":{"get":{"description":"Fetch a single file's pre-signed URL and return a Response.","operationId":"get_diamond_file_v1_diamonds__diamond_id__files__file_hash__get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},{"in":"path","name":"file_hash","required":true,"schema":{"title":"File Hash","type":"string"}}],"responses":{"302":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond or file not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"The file was found in the Tracr network but a pre-signed URL could not be generated."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"An unexpected response was received from the participant's API."}},"summary":"Get Diamond File","tags":["Tracr XPS API v1"]}}}} ``` ## Get Diamond History > Look up a single diamond in Tracr and return its history. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"TraceabilityHistoryReadView":{"description":"A version of FullReadView containing only traceability data.","properties":{"content":{"additionalProperties":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"},"title":"Content","type":"object"}},"required":["content"],"title":"TraceabilityHistoryReadView","type":"object"},"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"diamond_id":{"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"}],"title":"Diamond Parent Id"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v1/diamonds/{diamond_id}/history":{"get":{"description":"Look up a single diamond in Tracr and return its history.","operationId":"get_diamond_history_v1_diamonds__diamond_id__history_get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceabilityHistoryReadView"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamond History","tags":["Tracr XPS API v1","Diamond Search"]}}}} ``` # Tracr XPS API V2 ## Get Diamonds V2 > Multi-value search returning a discriminated union of diamond results.\ > \ > Mirrors v1's pagination and peer-fan-out, but instead of dropping locked\ > diamonds (v1's behaviour), it surfaces them as \`\`RestrictedDiamondSearchResult\`\`\ > entries (\`\`kind: locked\`\`) built from the \`\`locked\_diamond\`\` payload PCS\ > attaches to each locked search row. Ineligible uninscribed diamonds use the\ > same wrapper with \`\`kind: uninscribed\`\` (which takes precedence over \`\`locked\`\`).\ > \`\`data\_access\_event\`\` rows are recorded only for \`\`UnlockedDiamondSearchResult\`\`\ > entries. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"Paginator_Annotated_Union_UnlockedDiamondSearchResult__RestrictedDiamondSearchResult___FieldInfo_annotation_NoneType__required_True__discriminator__kind____":{"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":{"discriminator":{"mapping":{"locked":"#/components/schemas/RestrictedDiamondSearchResult","uninscribed":"#/components/schemas/RestrictedDiamondSearchResult","unlocked":"#/components/schemas/UnlockedDiamondSearchResult"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/UnlockedDiamondSearchResult"},{"$ref":"#/components/schemas/RestrictedDiamondSearchResult"}]},"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":"Paginator[Annotated[Union[UnlockedDiamondSearchResult, RestrictedDiamondSearchResult], FieldInfo(annotation=NoneType, required=True, discriminator='kind')]]","type":"object"},"UnlockedDiamondSearchResult":{"description":"Search-result wrapper for an unlocked diamond.\n\nSame shape as v1's ``CrossIdDiamondSearchResult`` with an explicit\n``kind`` discriminator.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"const":"unlocked","default":"unlocked","title":"Kind","type":"string"}},"required":["identity_type","diamond"],"title":"UnlockedDiamondSearchResult","type":"object"},"RestrictedDiamondSearchResult":{"description":"Search-result wrapper for a reduced ``RestrictedDiamondView``.\n\nUsed for PCS-locked diamonds (``kind: locked``) and for uninscribed diamonds\nrestricted for the caller (``kind: uninscribed``).","properties":{"diamond":{"$ref":"#/components/schemas/RestrictedDiamondView"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"enum":["locked","uninscribed"],"title":"Kind","type":"string"}},"required":["kind","identity_type","diamond"],"title":"RestrictedDiamondSearchResult","type":"object"},"RestrictedDiamondView":{"description":"Minimal public metadata returned for a restricted diamond.\n\nThe restricted view is limited to identifiers + grading source. All other\ngrading fields (carat, colour, clarity, cut, certificate URL, graded_at,\nlab metadata) are intentionally omitted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"default":[],"items":{"$ref":"#/components/schemas/RestrictedGradingEntry"},"title":"Grading","type":"array"},"has_inscription":{"default":false,"title":"Has Inscription","type":"boolean"},"is_locked":{"title":"Is Locked","type":"boolean"}},"required":["diamond_id","is_locked"],"title":"RestrictedDiamondView","type":"object"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v2/diamonds/":{"get":{"description":"Multi-value search returning a discriminated union of diamond results.\n\nMirrors v1's pagination and peer-fan-out, but instead of dropping locked\ndiamonds (v1's behaviour), it surfaces them as ``RestrictedDiamondSearchResult``\nentries (``kind: locked``) built from the ``locked_diamond`` payload PCS\nattaches to each locked search row. Ineligible uninscribed diamonds use the\nsame wrapper with ``kind: uninscribed`` (which takes precedence over ``locked``).\n``data_access_event`` rows are recorded only for ``UnlockedDiamondSearchResult``\nentries.","operationId":"get_diamonds_v2_v2_diamonds__get","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Page number","minimum":1,"title":"Page","type":"integer"}},{"in":"query","name":"size","required":false,"schema":{"default":100,"maximum":1000,"minimum":1,"title":"Size","type":"integer"}},{"in":"query","name":"search","required":true,"schema":{"title":"Search","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginator_Annotated_Union_UnlockedDiamondSearchResult__RestrictedDiamondSearchResult___FieldInfo_annotation_NoneType__required_True__discriminator__kind____"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamonds V2","tags":["Tracr XPS API v2","Diamond Search"]}}}} ``` ## Get Diamond History V2 > Look up a diamond's history in Tracr.\ > \ > Returns the full \`\`TraceabilityHistoryReadView\`\` for a diamond with full\ > access, or a reduced \`\`RestrictedDiamondView\`\` (HTTP 200) when the diamond\ > exists but full data is restricted for the caller. Returns HTTP 404 if the\ > diamond cannot be found on any peer.\ > \ > Data-access events are recorded only when the response is the full\ > history view; reduced responses do not record an event. ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"security":[{"Auth0JWTAuth":[]}],"components":{"securitySchemes":{"Auth0JWTAuth":{"scheme":"bearer","type":"http"}},"schemas":{"TraceabilityHistoryReadView":{"description":"A version of FullReadView containing only traceability data.","properties":{"content":{"additionalProperties":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"},"title":"Content","type":"object"}},"required":["content"],"title":"TraceabilityHistoryReadView","type":"object"},"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"diamond_id":{"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"}],"title":"Diamond Parent Id"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"},"RestrictedDiamondView":{"description":"Minimal public metadata returned for a restricted diamond.\n\nThe restricted view is limited to identifiers + grading source. All other\ngrading fields (carat, colour, clarity, cut, certificate URL, graded_at,\nlab metadata) are intentionally omitted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"default":[],"items":{"$ref":"#/components/schemas/RestrictedGradingEntry"},"title":"Grading","type":"array"},"has_inscription":{"default":false,"title":"Has Inscription","type":"boolean"},"is_locked":{"title":"Is Locked","type":"boolean"}},"required":["diamond_id","is_locked"],"title":"RestrictedDiamondView","type":"object"},"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"},"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/v2/diamonds/{diamond_id}/history":{"get":{"description":"Look up a diamond's history in Tracr.\n\nReturns the full ``TraceabilityHistoryReadView`` for a diamond with full\naccess, or a reduced ``RestrictedDiamondView`` (HTTP 200) when the diamond\nexists but full data is restricted for the caller. Returns HTTP 404 if the\ndiamond cannot be found on any peer.\n\nData-access events are recorded only when the response is the full\nhistory view; reduced responses do not record an event.","operationId":"get_diamond_history_v2_v2_diamonds__diamond_id__history_get","parameters":[{"in":"path","name":"diamond_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityHistoryReadView"},{"$ref":"#/components/schemas/RestrictedDiamondView"}],"title":"Response 200 Get Diamond History V2 V2 Diamonds Diamond Id History Get"}}},"description":"Full history for a diamond with full access, or a reduced RestrictedDiamondView when the diamond exists but full data is restricted for the caller."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden: The application does not have sufficient permissions for this operation."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Diamond not found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"It was not possible to determine which Tracr instance holds this diamond."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Diamond History V2","tags":["Tracr XPS API v2","Diamond Search"]}}}} ``` # Models ## The AssuranceLevel object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"}}}} ``` ## The Clarity object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"}}}} ``` ## The Colour object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The CrossIdDiamondSearchResult object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"CrossIdDiamondSearchResult":{"description":"Represents a single diamond in the database, as returned by a cross-id-search.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"description":"The identifier by which this diamond was retrieved.","enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"locked_diamond":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Locked Diamond"}},"required":["identity_type","diamond"],"title":"CrossIdDiamondSearchResult","type":"object"}}}} ``` ## The CuletCondition object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"CuletCondition":{"enum":["P","A","C"],"title":"CuletCondition","type":"string"}}}} ``` ## The CuletSize object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"CuletSize":{"enum":["EL","VL","L","SL","M","S","VS","N"],"title":"CuletSize","type":"string"}}}} ``` ## The CutGrade object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","type":"string"}}}} ``` ## The DiamondAssetGallery object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"}}}} ``` ## The DiamondAssetV2ImageResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"}}}} ``` ## The DiamondAssetV2InscriptionNumberResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"}}}} ``` ## The DiamondAssetV2PlanReportResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"}}}} ``` ## The DiamondAssetV2PlanResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"}}}} ``` ## The DiamondAssetV2ScanReportResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"}}}} ``` ## The DiamondAssetV2ScanResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"}}}} ``` ## The DiamondAssetV2SupplementaryResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## The DiamondAssetV2ThreeDPlanResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"}}}} ``` ## The DiamondAssetV2VideoResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"}}}} ``` ## The DiamondUnlockStatus object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The EnrichedTraceabilityReadView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"diamond_id":{"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"}],"title":"Diamond Parent Id"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ErrorResponse":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"ErrorResponse","type":"object"}}}} ``` ## The FancyColour object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"FancyColour":{"enum":["BK","B","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","W","X"],"title":"FancyColour","type":"string"}}}} ``` ## The FancyColourIntensity object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"FancyColourIntensity":{"enum":["F","VL","L","FL","FC","FCD","I","FV","D"],"title":"FancyColourIntensity","type":"string"}}}} ``` ## The FileRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"required":["hash"],"title":"FileRef","type":"object"}}}} ``` ## The FluorescenceColour object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"FluorescenceColour":{"enum":["B","W","Y","O","R","G","N"],"title":"FluorescenceColour","type":"string"}}}} ``` ## The FluorescenceIntensity object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"FluorescenceIntensity":{"enum":["VS","S","M","F","SL","VSL","N"],"title":"FluorescenceIntensity","type":"string"}}}} ``` ## The GirdleCondition object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"GirdleCondition":{"enum":["P","F","B"],"title":"GirdleCondition","type":"string"}}}} ``` ## The GirdleThickness object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"GirdleThickness":{"enum":["Extremely Thick","Very Thick","Thick","Slightly Thick","Medium","Thin","Slightly Thin","Very Thin","Extremely Thin"],"title":"GirdleThickness","type":"string"}}}} ``` ## The GisStatus object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"}}}} ``` ## The GradedMeasurementSource object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"GradedMeasurementSource":{"description":"The source of graded measurement data.","enum":["gis","user"],"title":"GradedMeasurementSource","type":"string"}}}} ``` ## The GradingCertificateRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The GradingDataView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"}}}} ``` ## The GradingLab object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The HTTPValidationError object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## The ImageFileExtension object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","type":"string"}}}} ``` ## The ImageFileExtensionV2 object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","type":"string"}}}} ``` ## The ImageRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ImageRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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"}}}} ``` ## The ImageType object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The LifecycleState object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"}}}} ``` ## The ObjectiveVerificationData object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The ObjectiveVerificationDataSource object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ObjectiveVerificationDataSource":{"enum":["diadna","diamondid","sarine","restricted"],"title":"ObjectiveVerificationDataSource","type":"string"}}}} ``` ## The ObjectiveVerificationDataStatus object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ObjectiveVerificationDataStatus":{"enum":["in_progress","success","restricted"],"title":"ObjectiveVerificationDataStatus","type":"string"}}}} ``` ## The Paginator\_Annotated\_Union\_UnlockedDiamondSearchResult\_\_RestrictedDiamondSearchResult\_\_\_FieldInfo\_annotation\_NoneType\_\_required\_True\_\_discriminator\_\_kind\_\_\_\_ object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"Paginator_Annotated_Union_UnlockedDiamondSearchResult__RestrictedDiamondSearchResult___FieldInfo_annotation_NoneType__required_True__discriminator__kind____":{"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":{"discriminator":{"mapping":{"locked":"#/components/schemas/RestrictedDiamondSearchResult","uninscribed":"#/components/schemas/RestrictedDiamondSearchResult","unlocked":"#/components/schemas/UnlockedDiamondSearchResult"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/UnlockedDiamondSearchResult"},{"$ref":"#/components/schemas/RestrictedDiamondSearchResult"}]},"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":"Paginator[Annotated[Union[UnlockedDiamondSearchResult, RestrictedDiamondSearchResult], FieldInfo(annotation=NoneType, required=True, discriminator='kind')]]","type":"object"},"UnlockedDiamondSearchResult":{"description":"Search-result wrapper for an unlocked diamond.\n\nSame shape as v1's ``CrossIdDiamondSearchResult`` with an explicit\n``kind`` discriminator.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"const":"unlocked","default":"unlocked","title":"Kind","type":"string"}},"required":["identity_type","diamond"],"title":"UnlockedDiamondSearchResult","type":"object"},"RestrictedDiamondSearchResult":{"description":"Search-result wrapper for a reduced ``RestrictedDiamondView``.\n\nUsed for PCS-locked diamonds (``kind: locked``) and for uninscribed diamonds\nrestricted for the caller (``kind: uninscribed``).","properties":{"diamond":{"$ref":"#/components/schemas/RestrictedDiamondView"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"enum":["locked","uninscribed"],"title":"Kind","type":"string"}},"required":["kind","identity_type","diamond"],"title":"RestrictedDiamondSearchResult","type":"object"},"RestrictedDiamondView":{"description":"Minimal public metadata returned for a restricted diamond.\n\nThe restricted view is limited to identifiers + grading source. All other\ngrading fields (carat, colour, clarity, cut, certificate URL, graded_at,\nlab metadata) are intentionally omitted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"default":[],"items":{"$ref":"#/components/schemas/RestrictedGradingEntry"},"title":"Grading","type":"array"},"has_inscription":{"default":false,"title":"Has Inscription","type":"boolean"},"is_locked":{"title":"Is Locked","type":"boolean"}},"required":["diamond_id","is_locked"],"title":"RestrictedDiamondView","type":"object"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"}}}} ``` ## The Paginator\_CrossIdDiamondSearchResult\_ object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"Paginator_CrossIdDiamondSearchResult_":{"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/CrossIdDiamondSearchResult"},"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":"Paginator[CrossIdDiamondSearchResult]","type":"object"},"CrossIdDiamondSearchResult":{"description":"Represents a single diamond in the database, as returned by a cross-id-search.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"description":"The identifier by which this diamond was retrieved.","enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"locked_diamond":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Locked Diamond"}},"required":["identity_type","diamond"],"title":"CrossIdDiamondSearchResult","type":"object"}}}} ``` ## The PlanFileExtensionV2 object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"}}}} ``` ## The PlanRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"PlanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}}}} ``` ## The Provenance object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"}}}} ``` ## The RestrictedDiamondSearchResult object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"RestrictedDiamondSearchResult":{"description":"Search-result wrapper for a reduced ``RestrictedDiamondView``.\n\nUsed for PCS-locked diamonds (``kind: locked``) and for uninscribed diamonds\nrestricted for the caller (``kind: uninscribed``).","properties":{"diamond":{"$ref":"#/components/schemas/RestrictedDiamondView"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"enum":["locked","uninscribed"],"title":"Kind","type":"string"}},"required":["kind","identity_type","diamond"],"title":"RestrictedDiamondSearchResult","type":"object"},"RestrictedDiamondView":{"description":"Minimal public metadata returned for a restricted diamond.\n\nThe restricted view is limited to identifiers + grading source. All other\ngrading fields (carat, colour, clarity, cut, certificate URL, graded_at,\nlab metadata) are intentionally omitted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"default":[],"items":{"$ref":"#/components/schemas/RestrictedGradingEntry"},"title":"Grading","type":"array"},"has_inscription":{"default":false,"title":"Has Inscription","type":"boolean"},"is_locked":{"title":"Is Locked","type":"boolean"}},"required":["diamond_id","is_locked"],"title":"RestrictedDiamondView","type":"object"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"}}}} ``` ## The RestrictedDiamondView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"RestrictedDiamondView":{"description":"Minimal public metadata returned for a restricted diamond.\n\nThe restricted view is limited to identifiers + grading source. All other\ngrading fields (carat, colour, clarity, cut, certificate URL, graded_at,\nlab metadata) are intentionally omitted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"default":[],"items":{"$ref":"#/components/schemas/RestrictedGradingEntry"},"title":"Grading","type":"array"},"has_inscription":{"default":false,"title":"Has Inscription","type":"boolean"},"is_locked":{"title":"Is Locked","type":"boolean"}},"required":["diamond_id","is_locked"],"title":"RestrictedDiamondView","type":"object"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"}}}} ``` ## The RestrictedGradingEntry object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"RestrictedGradingEntry":{"description":"One reduced grading entry for a restricted diamond, safe to expose publicly.","properties":{"inscription_numbers":{"default":[],"items":{"type":"string"},"title":"Inscription Numbers","type":"array"},"report_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Number"},"source":{"title":"Source","type":"string"}},"required":["source"],"title":"RestrictedGradingEntry","type":"object"}}}} ``` ## The ScanFileExtension object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The ScanFileExtensionV2 object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"}}}} ``` ## The ScanRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ScanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}}}} ``` ## The Shape object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"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"}}}} ``` ## The SilhouetteRef object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"SilhouetteRef":{"additionalProperties":false,"deprecated":true,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"image_height":{"description":"Height of each image (px)","title":"Image Height","type":"integer"},"image_width":{"description":"Width of each image (px)","title":"Image Width","type":"integer"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"scan_hash":{"description":"Hash of the scan this silhouette relates to","title":"Scan Hash","type":"string"}},"required":["hash","scan_hash","image_height","image_width"],"title":"SilhouetteRef","type":"object"}}}} ``` ## The Symmetry object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"Symmetry":{"enum":["I","EX","VG-EX","VG","G-VG","G","F-G","F","P"],"title":"Symmetry","type":"string"}}}} ``` ## The TraceabilityHistoryReadView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"TraceabilityHistoryReadView":{"description":"A version of FullReadView containing only traceability data.","properties":{"content":{"additionalProperties":{"$ref":"#/components/schemas/EnrichedTraceabilityReadView"},"title":"Content","type":"object"}},"required":["content"],"title":"TraceabilityHistoryReadView","type":"object"},"EnrichedTraceabilityReadView":{"description":"Detailed data of a diamond.","properties":{"assets":{"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"},"current_stage":{"$ref":"#/components/schemas/tracr__shared__utils__openapi__CurrentStage"},"diamond_id":{"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"}],"title":"Diamond Parent Id"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}]},"grading":{"anyOf":[{"items":{"$ref":"#/components/schemas/GradingDataView"},"type":"array"},{"type":"null"}],"title":"Grading"},"lifecycle_state":{"$ref":"#/components/schemas/LifecycleState"},"polished":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityPolishedView"},{"type":"null"}]},"polished_objective_verification":{"default":false,"title":"Polished Objective Verification","type":"boolean"},"polished_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Polished Objective Verification Results","type":"array"},"producer_uuid":{"format":"uuid","title":"Producer Uuid","type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance","default":{"is_locked":false}},"rough":{"anyOf":[{"$ref":"#/components/schemas/TraceabilityRoughView"},{"type":"null"}]},"rough_objective_verification":{"title":"Rough Objective Verification","type":"boolean"},"rough_objective_verification_results":{"items":{"$ref":"#/components/schemas/ObjectiveVerificationData"},"title":"Rough Objective Verification Results","type":"array"},"unlock_status":{"$ref":"#/components/schemas/DiamondUnlockStatus"}},"required":["diamond_id","lifecycle_state","current_stage","assurance_level","producer_uuid","rough_objective_verification","unlock_status"],"title":"EnrichedTraceabilityReadView","type":"object"},"DiamondAssetV2ImageResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the image's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The image's file extension.","title":"Extension"},"filename":{"description":"The filename of the image.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"image_type":{"description":"Image type of image."},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"DiamondAssetV2VideoResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the video's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The video's file extension.","title":"Extension"},"filename":{"description":"The filename of the video.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"DiamondAssetV2ScanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The scan's file extension.","title":"Extension"},"filename":{"description":"The filename of the scan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"DiamondAssetV2ScanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the scan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the scan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the scanner used to produce this scan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"description":"The model of the scanner used to produce this scan report.","title":"Scan Device Model"},"scan_software_name":{"description":"The name of the software running on the scanner used to produce this scan report.","title":"Scan Software Name"},"scan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2ScanReportResponse","type":"object"},"DiamondAssetV2PlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The plan's file extension.","title":"Extension"},"filename":{"description":"The filename of the plan.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan.","title":"Plan Software Name"},"plan_software_version":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"DiamondAssetV2PlanReportResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the plan report's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the plan report.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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":{"description":"The manufacturer of the software used to produce this plan report.","title":"Plan Software Manufacturer"},"plan_software_name":{"description":"The name of the software used or produce this plan report.","title":"Plan Software Name"},"plan_software_version":{"description":"The version of the software used to produce this plan report.","title":"Plan Software Version"},"scan_device_manufacturer":{"description":"The manufacturer of the scanner used to produce this plan report.","title":"Scan Device Manufacturer"},"scan_device_model":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2PlanReportResponse","type":"object"},"DiamondAssetV2InscriptionNumberResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the inscription number file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"extension":{"description":"The inscription number file's file extension.","title":"Extension"},"filename":{"description":"The filename of the inscription number file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"graded_date":{"description":"The date on which the diamond was inscribed.","title":"Graded Date"},"grader_inscription_no":{"description":"The inscription number.","title":"Grader Inscription No"},"grading_lab":{"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":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"title":"DiamondAssetV2InscriptionNumberResponse","type":"object"},"DiamondAssetV2ThreeDPlanResponse":{"properties":{"asset_type":{"title":"Asset Type"},"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.","title":"Created At"},"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":{"description":"Whether this asset is associated with the diamond when it was rough, or after it was polished."},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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"},"polished_three_d_plan_extension":{"description":"The polished 3D plan's file extension.","title":"Polished Three D Plan Extension"},"polished_three_d_plan_filename":{"description":"The polished 3D plan's filename.","title":"Polished Three D Plan Filename"},"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"},"rough_three_d_plan_extension":{"description":"The rough 3D plan's file extension.","title":"Rough Three D Plan Extension"},"rough_three_d_plan_filename":{"description":"The rough 3D plan's filename.","title":"Rough Three D Plan Filename"},"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","rough_three_d_plan_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"title":"DiamondAssetV2ThreeDPlanResponse","type":"object"},"DiamondAssetV2SupplementaryResponse":{"properties":{"asset_type":{"title":"Asset Type"},"content_hash":{"description":"The SHA-512 hash of the supplementary file's content.","title":"Content Hash"},"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.","title":"Created At"},"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":{"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"},"filename":{"description":"The filename of the supplementary file.","title":"Filename"},"gallery":{"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":{"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.","title":"Gallery Priority"},"id":{"description":"Uniquely identifies the asset.","pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"is_hero":{"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"},"label":{"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.","title":"Updated At"}},"required":["diamond_id","id","created_at","updated_at","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"},"AssuranceLevel":{"description":"Represents the assurance level for a diamond.","enum":["assured","declared"],"title":"AssuranceLevel","type":"string"},"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","type":"string"},"GradingDataView":{"description":"Represents a single GradedMeasurement row for a diamond.","properties":{"carats":{"title":"Carats"},"clarity":{},"colour":{},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{},"culet_size":{},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{},"fancy_colour_intensity":{},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{},"fluorescence_intensity":{},"girdle_condition":{},"girdle_thickness_from":{},"girdle_thickness_to":{},"graded_date":{"title":"Graded Date"},"grader_certificate_number":{"title":"Grader Certificate Number"},"grader_clarity_characteristics":{"title":"Grader Clarity Characteristics"},"grader_colour":{"title":"Grader Colour"},"grader_inscription_numbers":{"title":"Grader Inscription Numbers"},"grader_report_comments":{"title":"Grader Report Comments"},"grader_report_number":{"title":"Grader Report Number"},"grader_report_type":{"title":"Grader Report Type"},"grader_shape":{"title":"Grader Shape"},"grading_certificate_description":{"title":"Grading Certificate Description"},"grading_certificate_filename":{"title":"Grading Certificate Filename"},"grading_certificate_hash":{"title":"Grading Certificate Hash"},"grading_lab":{},"id":{"title":"Id"},"is_active":{"title":"Is Active"},"is_selectable":{"title":"Is Selectable"},"length":{"title":"Length"},"measurement_text":{"title":"Measurement Text"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"polish_quality":{},"shape":{},"source":{},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{},"table_percent":{"title":"Table Percent"},"validation_level":{},"width":{"title":"Width"}},"required":["id","is_active","is_selectable","source"],"title":"GradingDataView","type":"object"},"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","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"},"Provenance":{"properties":{"country_code":{"anyOf":[{"pattern":"^[A-Z]{2}$","type":"string"},{"type":"null"}],"title":"Country Code"},"is_locked":{"default":false,"title":"Is Locked","type":"boolean"},"mine_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine Name"},"provenance_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance Name"},"provenance_type":{"anyOf":[{"const":"Country","type":"string"},{"const":"Entity","type":"string"},{"type":"null"}],"title":"Provenance Type"}},"title":"Provenance","type":"object"},"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","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"}}}} ``` ## The TraceabilityPolishedView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"TraceabilityPolishedView":{"description":"A Polished model containing only traceability data.","properties":{"carats":{"title":"Carats"},"clarity":{"title":"Clarity"},"colour":{"title":"Colour"},"crown_angle":{"title":"Crown Angle"},"crown_height":{"title":"Crown Height"},"culet_condition":{"title":"Culet Condition"},"culet_size":{"title":"Culet Size"},"cut_grade":{},"depth":{"title":"Depth"},"depth_percent":{"title":"Depth Percent"},"diameter_maximum":{"title":"Diameter Maximum"},"diameter_minimum":{"title":"Diameter Minimum"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"girdle_condition":{"title":"Girdle Condition"},"girdle_thickness_from":{"title":"Girdle Thickness From"},"girdle_thickness_to":{"title":"Girdle Thickness To"},"grading_certificates":{"title":"Grading Certificates"},"images":{"title":"Images"},"length":{"title":"Length"},"model":{"title":"Model"},"pavillion_angle":{"title":"Pavillion Angle"},"pavillion_percent":{"title":"Pavillion Percent"},"plan":{},"plan_reports":{"title":"Plan Reports"},"polish_quality":{"title":"Polish Quality"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"shape":{"title":"Shape"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"supplementary_files":{"title":"Supplementary Files"},"symmetry":{"title":"Symmetry"},"table_percent":{"title":"Table Percent"},"videos":{"title":"Videos"},"width":{"title":"Width"}},"title":"TraceabilityPolishedView","type":"object"}}}} ``` ## The TraceabilityRoughView object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"TraceabilityRoughView":{"description":"A Rough model containing only traceability data.","properties":{"carats":{"title":"Carats"},"colour":{"title":"Colour"},"display_colour":{"title":"Display Colour"},"fancy_colour":{"title":"Fancy Colour"},"fancy_colour_intensity":{"title":"Fancy Colour Intensity"},"fancy_colour_overtone":{"title":"Fancy Colour Overtone"},"fluorescence_colour":{"title":"Fluorescence Colour"},"fluorescence_intensity":{"title":"Fluorescence Intensity"},"images":{"title":"Images"},"model":{"title":"Model"},"plan":{},"plan_reports":{"title":"Plan Reports"},"quality":{"title":"Quality"},"scan":{},"scan_reports":{"title":"Scan Reports"},"silhouettes":{"deprecated":true,"title":"Silhouettes"},"stress":{"title":"Stress"},"supplementary_files":{"title":"Supplementary Files"},"videos":{"title":"Videos"}},"title":"TraceabilityRoughView","type":"object"}}}} ``` ## The UnlockedDiamondSearchResult object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"UnlockedDiamondSearchResult":{"description":"Search-result wrapper for an unlocked diamond.\n\nSame shape as v1's ``CrossIdDiamondSearchResult`` with an explicit\n``kind`` discriminator.","properties":{"diamond":{"additionalProperties":true,"title":"Diamond","type":"object"},"identity_type":{"enum":["diamond_id","grader_report_number","grader_inscription_number","grader_certificate_number"],"title":"Identity Type","type":"string"},"kind":{"const":"unlocked","default":"unlocked","title":"Kind","type":"string"}},"required":["identity_type","diamond"],"title":"UnlockedDiamondSearchResult","type":"object"}}}} ``` ## The ValidationError object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## The ValidationLevel object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"ValidationLevel":{"enum":["validation","verification"],"title":"ValidationLevel","type":"string"}}}} ``` ## The VideoFileExtension object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"VideoFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["avi","mov","mp4","mpeg","mpg"],"title":"VideoFileExtension","type":"string"}}}} ``` ## The VideoFileExtensionV2 object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"}}}} ``` ## The tracr\_\_shared\_\_utils\_\_diamond\_asset\_\_CurrentStage object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"tracr__shared__utils__diamond_asset__CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"}}}} ``` ## The tracr\_\_shared\_\_utils\_\_openapi\_\_CurrentStage object ```json {"openapi":"3.1.0","info":{"title":"Cross-participant Search API","version":"development"},"components":{"schemas":{"tracr__shared__utils__openapi__CurrentStage":{"enum":["bruting","planning","polished","polishing","rough","sawing"],"title":"CurrentStage","type":"string"}}}} ``` # Introduction Welcome to the Tracr API Reference. Here you will find information on how to use the API to create, manage and transfer diamonds on the Tracr network. * [Security](/api-reference/tracr-api/security) * [Register Rough](/api-reference/tracr-api/register_rough) * [Split](/api-reference/tracr-api/split) * [Polish](/api-reference/tracr-api/polish) * [Inventory](/api-reference/tracr-api/inventory) * [Unlock](/api-reference/tracr-api/unlock) * [Shipments outbound](/api-reference/tracr-api/shipments_outbound) * [Shipments inbound](/api-reference/tracr-api/shipments_inbound) * [Delete](/api-reference/tracr-api/delete) * [Grading data management](/api-reference/tracr-api/grading_data_management) * [References](/api-reference/tracr-api/references/bulk) # Security The Tracr API uses OAuth 2.0 authentication. Tracr Support will provide a Client ID and Client Secret during the technical onboarding. > #### MTLS support > > For integrations done before 30/06/2023, please note that Tracr will continue to support mTLS until further notice. New integrations will be provided with OAuth 2.0 credentials only. ## Generate a JWT token Call `POST https://auth.tracr.com/oauth/token` {% tabs %} {% tab title="Request" %} ```json { "client_id":"", "client_secret":"", "audience":"", "grant_type":"client_credentials" } ``` {% endtab %} {% tab title="Response" %} ```json { "access_token": "", "token_type": "Bearer" } ``` {% endtab %} {% endtabs %} ## Pass the token to the endpoint To pass the token to the API, provide it in the Authorization header. ``` Authorization: ``` This token must be sent in every request to the API. # Register rough > **Please note** > > * Rough diamonds can only be registered on Tracr by producers and manufacturers. Retailers should use the transfer endpoints to accept polished diamonds from manufacturers on the Tracr network. > * Rough diamonds registered via the API won't appear in the Integration Monitoring section of the Tracr Portal. ## Register a De Beers diamond To register a diamond from a De Beers sight box, call the `/diamonds/rough/create` endpoint with the De Beers box ID, along with the sight year and number: Call `POST /diamonds/rough/create` {% tabs %} {% tab title="Request" %} ```json { "box_id": "demo_box", "participant_id": "demo_1", "participant_timestamp": "2024-05-31T11:38:38.206655+00:00", "rough": { "carats": 2.16 }, "sight_no": 2, "sight_year": 2024 } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "is_current": true, "lifecycle_state": "rough", "participant_id": "demo_1", "participant_timestamp": "2024-05-31T11:38:38.206655+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "", "provenance_type": "Entity", "is_locked": true, "is_country_code_available": true }, "rough": { "carats": 2.16 }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T11:41:25.525000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "hyfyv1o484li32aof6af5fbr", "verification_status_modified_at": "2024-05-31T11:41:26.068930+00:00" } ``` {% endtab %} {% endtabs %} If the registration failed then the reason for the failure will be given in the response, for example: ```json { "message": "Diamond is not unique" } ``` ## Register a diamond from another producer Non-De Beers diamonds are sent from the producer's Tracr instance as shipments. These will appear in the Inbound Shipments screen of the Tracr Portal when ready. The shipment needs to be accepted before any of the diamonds can be registered - see [Transfer In](https://gitlab.com/tracr/pcs/platform/pcs/-/blob/gitbook/docs/tracr-api/o2w4ljppvzatu-transfer-in/README.md) for how to accept a shipment of rough diamonds. > **Important:** When uploading diamonds, instead of providing the box details from De Beers (such as sight, year, and box ID), you will need to provide the **Shipment ID** in the “box\_id” column. The **Shipment ID** appears on the **Active** tab, next to the **Sender**. Once accepted, call the `/diamonds/rough/create` endpoint, passing the shipment ID assigned by Tracr as the box ID: Call `POST /diamonds/rough/create` {% tabs %} {% tab title="First Tab" %} ```json { "box_id": "b66ei4prxlp3fx1lwd2zps7x", "participant_id": "erp_id_123456", "participant_timestamp": "2023-03-31T18:23:08.283000+00:00", "rough": { "carats": 1.42 } } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "b66ei4prxlp3fx1lwd2zps7x", "current_stage": "rough", "diamond_id": "c4tr1cr9hcozhhy0czqeywd1", "entity_specific_tags": {}, "id": "df5a4c50-5a0e-425c-83c1-86007bca8ef4", "is_current": true, "lifecycle_state": "rough", "participant_id": "erp_id_123456", "participant_timestamp": "2024-05-31T10:27:56.283000+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", "provenance": { "provenance_name": "", "provenance_type": "Country", "is_locked": true, "is_country_code_available": true }, "rough": { "carats": 1.42 }, "schema_version": "1.1.0", "system_timestamp": "2024-05-31T10:28:33.284000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "cnj0gs40aszwepxtn7j41btj", "verification_status_modified_at": "2024-05-31T10:28:33.775828+00:00" } ``` {% endtab %} {% endtabs %} Tracr checks the weight and number of diamonds registered against each shipment. If these don't align then an error will be returned: ```json { "message": "Shipment checks failed. The diamond is heavier than the heaviest diamond in the shipment." } ``` ## Register a diamond as a producer Diamond producers register rough diamonds via the same endpoint, but can specify provenance information when doing so: Call `POST /diamonds/rough/create` {% tabs %} {% tab title="Request" %} ```json { "box_id": "demo_rough_box", "participant_id": "rough_1", "participant_timestamp": "2024-05-31T11:20:12.015648+00:00", "provenance": { "provenance_name": "BW", "provenance_type": "Country" }, "rough": { "carats": 2.57 } } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "demo_rough_box", "current_stage": "rough", "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "entity_specific_tags": {}, "id": "e1fda76b-e46e-4956-aca8-b18577ac25e2", "is_current": true, "lifecycle_state": "rough", "participant_id": "rough_1", "participant_timestamp": "2024-05-31T11:20:12.015648+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", "provenance": { "provenance_name": "BW", "provenance_type": "Country", "is_locked": false, "is_country_code_available": true }, "rough": { "carats": 2.57 }, "schema_version": "1.1.0", "system_timestamp": "2024-05-31T11:22:29.647000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "fq94xt0wh4yhls5c82msr6p8", "verification_status_modified_at": "2024-05-31T11:22:30.203316+00:00" } ``` {% endtab %} {% endtabs %} > **An important note regarding provenance** > > Only a diamond producer can declare the provenance of a diamond. Once a manufacturer registers a rough diamond in Tracr, the provenance is updated by Tracr after verification of the traceability data. ## Upload additional assets Once the diamond has been created, additional assets can be attached. Tracr can append the following files: * Scan * Images * Videos For example, to add an image of the rough diamond: Call `POST /diamonds/wemz3zvg7cvr5uugivhib1z0/files/image` {% tabs %} {% tab title="Form-data" %} | Key | Value | | ----------- | ------------------- | | file | demo\_1\_rough.jpeg | | description | Rough Image | | image\_type | default | ```json Content-Type: multipart/form-data; boundary=8317046c4dac35881b333a4c43b41d64 --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="description" Rough Image --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="image_type" default --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="file"; filename="demo_rough_1.jpg" ``` {% endtab %} {% tab title="Reponse" %} ```json { "hash":"cf02abefba1b4837b35f45b7f578251046b3bb100d129ff5adc77342d7e0f8a9" } ``` {% endtab %} {% endtabs %} # Split When more than one polished diamond is created from a single rough diamond, each piece (or split) to be polished needs to be registered as a child diamond from the parent diamond. As a prerequisite, the parent diamond must have a `verification_status` set to `Verified`. Tracr will reject any modification operation on a diamond if Tracr did not previously verify the diamond. Tracr supports many iterations of split where a rough parent diamond may have multiple generations of children. > **An important note regarding split** > > Once a diamond is marked as `split`, it is considered as `destroyed` in Tracr inventory, and won’t be visible anymore in the portal or API. Therefore, any subsequent operations like 'polish' on this diamond will be rejected by Tracr. ## Step 1 – Set the parent diamond’s lifecycle to split The parent diamond must be marked as `split` before you can create child rough diamonds. Call `POST /wemz3zvg7cvr5uugivhib1z0/split` {% tabs %} {% tab title="Request" %} ```json { "participant_timestamp": "2024-05-31T11:57:06.304594" } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "is_current": true, "lifecycle_state": "split", "participant_id": "demo_1", "participant_timestamp": "2024-05-31T11:57:06.304594+00:00", "polished": {}, "possession_state": "destroyed", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "", "provenance_type": "Entity", "is_locked": false, "is_country_code_available": false }, "rough": { "carats": 2.16, "images": [ { "filename": "demo_1_rough.jpeg", "description": "Rough Image", "hash": "cf02abefba1b4837b35f45b7f578251046b3bb100d129ff5adc77342d7e0f8a9", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T11:58:04.763000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "jwzorn6beors6zusvw2drklg", "verification_status_modified_at": "2024-05-31T11:41:26.068930+00:00" } ``` {% endtab %} {% endtabs %} Once the diamond is split, the `lifecycle_state` is `split` and the `possession_state` is `destroyed`. ## Step 2 – Create a child rough diamond A child diamond is always considered as a rough diamond when created in Tracr. It's declared by passing the `diamond_id` of the parent rough diamond in the call. **A child diamond inherits all the traceability data from its parent.** When declaring a child diamond against a parent diamond, Tracr retrieves all the children already registered then uses a control to check that the sum of carat weights of the children doesn't exceed the carat weight of the parent. If the control fails, the registration of the child diamond is rejected. Each child receives a new Tracr `diamond_id`. Call `POST /diamonds/wemz3zvg7cvr5uugivhib1z0/rough/create` {% tabs %} {% tab title="Request" %} ```json { "participant_id": "demo_1_split_1", "participant_timestamp": "2024-05-31T11:59:52.456810+00:00", "rough": { "carats": "1.52" } } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "a2uj544df5t5awu5v792wyj6", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "14fe49ae-df4b-49f6-93c3-9a712016977e", "is_current": true, "lifecycle_state": "rough", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_split_1", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T11:59:52.456810+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "", "provenance_type": "Entity", "is_locked": true, "is_country_code_available": false }, "rough": { "carats": 1.52 }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T12:00:34.343000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "m39wcutwn0vtvf1dy1s7ai9p", "verification_status_modified_at": "2024-05-31T12:00:34.365391+00:00" } ``` {% endtab %} {% endtabs %} The child diamond is linked to its parent. The field `diamond_parent_id` contains the Tracr ID `diamond_id` from the parent. The field `participant_parent_id` contains the ERP `participant_id` from the parent. Once the child diamond is created, you can attach additional assets like images, videos, and scans. For example, Call `POST /diamonds/a2uj544df5t5awu5v792wyj6/file/images` {% tabs %} {% tab title="Form-data" %} | Key | Value | | ----------- | ------------------ | | description | Split Image | | image\_type | default | | file | split\_demo\_1.jpg | 
Content-Type: multipart/form-data; boundary=8317046c4dac35881b333a4c43b41d64
--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="description"
Split Image

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="image_type"
default

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="file"; filename="split_demo_1.jpg"
{% endtab %} {% tab title="Reponse" %} ```json { "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986" } ``` {% endtab %} {% endtabs %} # Polish The lifecycle state `polished` is the final state on the Tracr platform. A polished diamond is created from a rough diamond (parent or child diamonds). The polished diamond inherits all the traceability details from the rough diamond and will keep the same `diamond_id` as the rough diamond. ## Step 1 – Transition the diamond to polished Call the polish endpoint by passing the Tracr `diamond_id` of the rough diamond to polish. Call `POST /diamonds/a2uj544df5t5awu5v792wyj6/polish` {% tabs %} {% tab title="Request" %} ```json { "participant_id": "demo_1_polished_1", "polished": { "carats": 1.01, "clarity": "SI1", "colour": "F", "cut_grade": "EX", "shape": "Round" } } ``` {% endtab %} {% tab title="Response" %} ```json { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "polished", "diamond_id": "a2uj544df5t5awu5v792wyj6", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "14fe49ae-df4b-49f6-93c3-9a712016977e", "is_current": true, "lifecycle_state": "polished", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_polished_1", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T11:59:52.456810+00:00", "polished": { "carats": 1.01, "cut_grade": "EX", "shape": "Round", "colour": "F", "clarity": "SI1" }, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "is_locked": false, "is_country_code_available": false }, "rough": { "carats": 1.52, "images": [ { "filename": "demo_1_split_1.jpeg", "description": "Split Image", "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T12:22:44.675000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "zx5ag50jvj0xnqvppmokpppq", "verification_status_modified_at": "2024-05-31T12:22:44.693059+00:00" } ``` {% endtab %} {% endtabs %} If the operation is successful, the `lifecycle_state` field transitions to `polished`. The field `participant_id` updates with the new value given in the polish operation. When retrieving the diamond record, please note the section `rough` is still available but read only. ## Step 2 – Attach a scan report The scan report comes from the polished scanner and provides all the measurement points of the polished diamond. The scan report is required to make the diamond eligible to the Grading Integration Service. Please consult [this article](https://gitlab.com/tracr/pcs/platform/pcs/-/blob/gitbook/docs/gis-api/9ox122viaaq7t-gis-introduction/README.md) for more information. Please consult the list of supported technologies [here](https://gitlab.com/tracr/pcs/platform/pcs/-/blob/gitbook/docs/user-documentation/hm71l585o5ed3-integration/README.md#prepare-a-polished-diamond-dataset) Call `POST /diamonds/a2uj544df5t5awu5v792wyj6/files/scan/reports` {% tabs %} {% tab title="Form-data" %} | Key | Value | | -------------------------- | ---------------------------- | | description | Polished diamond scan report | | file | demo\_polished\_scan.xml | | scan\_device\_manufacturer | Sarine | | scan\_device\_model | DiaMension | ``` Content-Type: multipart/form-data; boundary=8317046c4dac35881b333a4c43b41d64 --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="description" Polished diamond scan report --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="scan_device_manufacturer" Sarine --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="scan_device_model" DiaMension -8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="file"; filename="demo_polished_scan.xml" ``` {% endtab %} {% tab title="Response" %} ```json { "hash": "c47c21bf48f7fe301de1efdce43a153ddd873d599195f7103bbf5053341b6c69" } ``` {% endtab %} {% endtabs %} ## Step 3 – Attach a grading certificate A grading certificate is a document provided by an independent grading laboratory. It could be a pdf or any other document. The grading certificate can be registered along with the certificate report ID and in the inscription number. > **An important note regarding the inscription number** > > An inscription number is mandatory to make a polished eligible to search in the consumer search portal () as well as transferring the polished diamond to another peer in the platform. Call `POST /diamonds/a2uj544df5t5awu5v792wyj6/files/grading_certificates` {% tabs %} {% tab title="Form-data" %} | Key | Value | | ----------------------- | ----------------------- | | description | GIA Grading report | | file | gia\_sample\_report.pdf | | grading\_lab | GIA | | graded\_date | 2024-05-31 | | grader\_certificate\_no | 2141438167 | | grader\_inscription\_no | GIA 2141438167 | 
Content-Type: multipart/form-data; boundary=8317046c4dac35881b333a4c43b41d64
--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="description"
GIA Grading report

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="grading_lab"
GIA

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="graded_date"
2023-03-31

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="grader_certificate_no"
2141438167

--8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="grader_inscription_no"
GIA 2141438167

-8317046c4dac35881b333a4c43b41d64
Content-Disposition: form-data; name="file"; filename="gia_sample_report.pdf"
{% endtab %} {% tab title="Response" %} ```json { "hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50", "graded_measurement_id": "hpuxljkbhjil53unwyyc11vh" } ``` {% endtab %} {% endtabs %} ## Step 4 – Attach additional files You can attach additional files (for example, images or videos) to polished diamonds in the same fashion as rough diamonds. For example, Call `POST /diamonds/a2uj544df5t5awu5v792wyj6/files/videos` {% tabs %} {% tab title="Form-data" %} | Key | Value | | ----------- | ------------------- | | description | Polished 360 video | | file | polished\_video.mp4 | ``` Content-Type: multipart/form-data; boundary=8317046c4dac35881b333a4c43b41d64 --8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="description" Polished 360 video -8317046c4dac35881b333a4c43b41d64 Content-Disposition: form-data; name="file"; filename="polished_video.mp4" ``` {% endtab %} {% tab title="Response" %} ```json { "hash": "dc897a179788e760b29497dd8ebfeb25051dd961f949e210203a5ae4e15b3dab" } ``` {% endtab %} {% endtabs %} # Inventory ## Individual diamond To return data about a specific diamond, pass the Tracr Diamond ID to the `/diamonds` endpoint: Call `GET /diamonds/a2uj544df5t5awu5v792wyj6` ```json { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "polished", "diamond_id": "a2uj544df5t5awu5v792wyj6", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "14fe49ae-df4b-49f6-93c3-9a712016977e", "is_current": true, "lifecycle_state": "polished", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_polished_1", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T11:59:52.456810+00:00", "polished": { "carats": 1.01, "cut_grade": "EX", "shape": "Round", "colour": "F", "clarity": "SI1", "scan_reports": [ { "filename": "demo_polished_scan.xml", "description": "Polished diamond scan report", "hash": "c47c21bf48f7fe301de1efdce43a153ddd873d599195f7103bbf5053341b6c69", "scan_device_manufacturer": "Sarine", "scan_device_model": "DiaMension" } ], "videos": [ { "filename": "polished_video.mp4", "description": "Polished 360 video", "hash": "dc897a179788e760b29497dd8ebfeb25051dd961f949e210203a5ae4e15b3dab" } ], "grading_certificates": [ { "filename": "gia_sample_report.pdf", "hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50", "grading_lab": "GIA", "graded_date": "2024-05-31", "grader_certificate_no": "2141438167", "grader_inscription_no": "GIA 2141438167" } ] }, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "is_locked": false, "is_country_code_available": false }, "rough": { "carats": 1.52, "images": [ { "filename": "demo_1_split_1.jpeg", "description": "Split Image", "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T13:35:31.094000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "e11im52r7v8nmalm2btmjues", "verification_status_modified_at": "2024-05-31T12:22:44.693059+00:00", "grading": [ { "id": "hpuxljkbhjil53unwyyc11vh", "graded_date": "2024-05-31T00:00:00+00:00", "grader_certificate_number": "2141438167", "grader_inscription_numbers": [ "GIA 2141438167" ], "grading_certificate_filename": "gia_sample_report.pdf", "grading_certificate_hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50", "grading_lab": "GIA" } ], "unlock_status": "locked", "rough_check": false } ``` Here the API returns an object called a **diamond record**. A diamond record represents the latest version of the digital asset in Tracr. **Participant ID** – The participant ID is the unique ID of the diamond in the factory's ERP. This used to keep the relationship between a diamond in the ERP and the same diamond in Tracr. **Participant Timestamp** – The timestamp of the enrolment of the rough diamond in the manufacturing process. **Diamond ID** – Each diamond on the platform has a unique `diamond_id` (or tracr id) assigned by the API. You need to capture and keep this `diamond_id` since this identifier is used by other endpoints of the API. **Version** – Each diamond on the platform is versioned after any data modification (metadata, files, and so on) or change of state (Verification Status, LifecycleState, Possession State, and so on). The field `version_id` contains the current version. **Lifecycle State** - Current state of a diamond. Tracr has 4 lifecycle states * `rough` * `split` * `polished` * `destroyed` **Possession State** - Tracr diamonds have 3 possession states * `held` : Diamond is live and owned by the current instance of Tracr * `known` : Diamond was previously owned by the instance of Tracr but has been transferred to another peer * `destroyed` : Diamond has been destroyed and is no longer live in the inventory **Verification status** – The field `verification_status` provides the current verification status from Tracr based on the traceability data provided during the registration. ## Paginating inventory The Tracr API offers a paginated endpoint to query your entire inventory. Pagination is controlled by two query parameters: **size** - The number of diamonds (between 1 and 1,000) to return per request. Defaults to 100 if not provided. **page** - The page number to return. Defaults to 1 if not provided. Results are ordered by the time when diamond was first added to the Tracr instance (either by rough registration or polished transfer). For example, `GET /diamonds/?size=1&page=2` returns the second diamond added to the inventory: Call `/diamonds/?size=1&page=2` ```json { "next": "https://api.manufacturer.uat.tracr.com/diamonds/?size=1&page=3", "page": 2, "pages": 3, "previous": "https://api.manufacturer.uat.tracr.com/diamonds/?size=1&page=1", "results": [ { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "jo55p0yxbk7slopptdwv0zol", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "7de1eea0-5247-45ad-a372-3bca147d6647", "is_current": true, "lifecycle_state": "rough", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_split_2", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T12:09:31.688604+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity", "is_locked": false, "is_country_code_available": false }, "rough": { "carats": 0.64, "images": [ { "filename": "demo_1_split_2.jpeg", "description": "Split Image", "hash": "5746c01245be9d70becb6d5737e0d9e4caf5f8923d4d9da69586874f53d0de52", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T12:10:07.966000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "a4kaxhi4rns75dgi52msrege", "verification_status_modified_at": "2024-05-31T12:09:46.830574+00:00", "unlock_status": "not_eligible_for_unlock", "rough_check": false } ], "total": 3 } ``` **next** - The url of the next page to query. This field will not appear in the response if there is no such page. **page** - The current page number. **pages** - The total number of pages available. **previous** - The url of the previous page to query. This field will not appear in the response if there is no such page. **results** - The paginated result set. **total** - The total number of diamonds matching the query. ## Query filters Extra query parameters can be applied to the URL to filter the inventory. Some examples are shown below. ### Querying by lifecycle state Call to retrieve all live `rough` diamonds. Call `GET /diamonds/?lifecycle_state=rough` ```json { "page": 1, "pages": 1, "results": [ { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "jo55p0yxbk7slopptdwv0zol", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "7de1eea0-5247-45ad-a372-3bca147d6647", "is_current": true, "lifecycle_state": "rough", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_split_2", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T12:09:31.688604+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 0.64, "images": [ { "filename": "demo_1_split_2.jpeg", "description": "Split Image", "hash": "5746c01245be9d70becb6d5737e0d9e4caf5f8923d4d9da69586874f53d0de52", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T12:10:07.966000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "a4kaxhi4rns75dgi52msrege", "verification_status_modified_at": "2024-05-31T12:09:46.830574+00:00", "unlock_status": "not_eligible_for_unlock", "rough_check": false }, { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "og2jywh0nh5zle5ethsutjp9", "entity_specific_tags": {}, "id": "5fef0ef9-c550-4ce0-812e-b7812845200b", "is_current": true, "lifecycle_state": "rough", "participant_id": "demo_2", "participant_timestamp": "2024-05-31T13:06:37.505656+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 1.24 }, "schema_version": "1.1.0", "sight_no": 3, "sight_year": 2024, "system_timestamp": "2024-05-31T13:16:07.527000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "cchn4g4s7vi0z2vis7t2e8wk", "verification_status_modified_at": "2024-05-31T13:16:07.545936+00:00", "unlock_status": "not_eligible_for_unlock", "rough_check": false } ], "total": 2 } ``` ### Querying by Participant ID (ERP ID) Call `GET /diamonds/?participant_id=demo_1_split_2` ```json { "page": 1, "pages": 1, "results": [ { "assurance_level": "assured", "box_id": "demo_box", "current_stage": "rough", "diamond_id": "jo55p0yxbk7slopptdwv0zol", "diamond_parent_id": "wemz3zvg7cvr5uugivhib1z0", "entity_specific_tags": {}, "id": "7de1eea0-5247-45ad-a372-3bca147d6647", "is_current": true, "lifecycle_state": "rough", "parent_id": "b0733d6f-a3b1-4532-be2b-d352bad46fd6", "participant_id": "demo_1_split_2", "participant_parent_id": "demo_1", "participant_timestamp": "2024-05-31T12:09:31.688604+00:00", "polished": {}, "possession_state": "held", "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 0.64, "images": [ { "filename": "demo_1_split_2.jpeg", "description": "Split Image", "hash": "5746c01245be9d70becb6d5737e0d9e4caf5f8923d4d9da69586874f53d0de52", "image_type": "default" } ] }, "schema_version": "1.1.0", "sight_no": 2, "sight_year": 2024, "system_timestamp": "2024-05-31T12:10:07.966000+00:00", "verification_description": "verified record", "verification_status": "Verified", "version_id": "a4kaxhi4rns75dgi52msrege", "verification_status_modified_at": "2024-05-31T12:09:46.830574+00:00", "unlock_status": "not_eligible_for_unlock", "rough_check": false } ], "total": 1 } ``` # Unlock > **Please note** > > Fees apply for unlocking diamonds, whether the action is taken through the portal or via the API. See the [Unlock section](https://gitlab.com/tracr/pcs/platform/pcs/-/blob/gitbook/docs/user-documentation/7x790kk4qwntj-inventory/README.md#unlock-diamonds) of the inventory page for more information. To unlock a set of polished diamonds in one, pass the list to the unlock endpoint: {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "a2uj544df5t5awu5v792wyj6" }, { "diamond_id": "jo55p0yxbk7slopptdwv0zol" } ] } ``` {% endtab %} {% tab title="Response" %} ```json { "diamonds": [ { "diamond_id": "a2uj544df5t5awu5v792wyj6", "status": "success" }, { "diamond_id": "jo55p0yxbk7slopptdwv0zol", "status": "success" } ] } ``` {% endtab %} {% endtabs %} # Provenance A diamond's provenance object details where it originated from. ## Unlocking provenance > **Please note** > > After the 21st of May 2025 the provenance for all locked diamond's on Tracr will be hidden. To unlock the diamond's provenance the diamond must be unlocked. See the [unlock documentation](/api-reference/tracr-api/unlock) for details on how to unlock a diamond. Producers can always see the provenance for diamonds they have uploaded. Once a rough diamond is transferred to another Tracr participant its provenance becomes locked. Unlocking a diamond will permanently unlock its provenance information. Once a diamond's provenance is unlocked it will be shown in all interfaces and APIs. Locked diamonds always have an empty `provenance_name`, but the values of the other fields will change depending on whether the diamond has single origin: * `provenance_type` will display as `Country` if the diamond has a single origin or `Entity` if it has multi origin available. * `country_code` will never be returned if the provenance is locked. * `is_country_code_available` when `true` indicates that the locked diamond has single origin available after unlock. When `false` it indicates that the diamond has multi origin available after unlock. Note: in future revisions of the API `provenance_type` and `provenance_name` will not be returned if the diamond is locked. There are some examples of provenance values below. ## Example provenance values ### Locked single origin ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "is_locked": true, "is_country_code_available": true } } ``` ### Locked multi origin ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "", "is_locked": true, "is_country_code_available": false } } ``` ### Unlocked single origin ```json { "provenance": { "provenance_type": "Country", "provenance_name": "BW", "is_locked": false, "is_country_code_available": true, "country_code": "BW" } } ``` ### Unlocked single origin with mine name ```json { "provenance": { "provenance_type": "Country", "provenance_name": "CA", "is_locked": false, "is_country_code_available": true, "country_code": "CA", "mine_name": "Gahcho Kué" } } ``` ### Unlocked multi origin (DTC) ```json { "provenance": { "provenance_type": "Entity", "provenance_name": "DTC", "is_locked": false, "is_country_code_available": false } } ``` ### Unlocked multi origin (other) ```json { "provenance": { "provenance_type": "Country", "provenance_name": "", "is_locked": false, "is_country_code_available": false } } ``` # Shipments outbound Please see the [Shipments Outbound](/tracr-user-guide/7.-shipments-outbound) documentation for help on transferring diamonds to another Tracr instance. ## Transfer rough diamonds Producers can send a shipment of rough diamonds to a manufacturer using the Tracr API. First, select the Tracr diamond IDs to put in a shipment (using the Tracr API or Portal), then: Call `POST /v2/transfer/out/start` {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc" }, { "diamond_id": "nmg7r5yhut68fz4czxnvanoc" } ], "receiver": "https://api.manufacturer.uat.tracr.com", "shipment_name": "Rough Shipment", "shipment_type": "rough" } ``` {% endtab %} {% tab title="Response" %} ```json { "shipment_id": "rhgy6z6e7j1mwd11nbqc0urg", "shipment_name": "Rough Shipment", "diamonds": [ { "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "lifecycle_state": "rough", "participant_id": "rough_1", "polished": null, "rough": { "carats": 2.57, "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "status": "success" }, { "diamond_id": "nmg7r5yhut68fz4czxnvanoc", "lifecycle_state": "rough", "participant_id": "rough_2", "polished": null, "rough": { "carats": 0.64, "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "status": "success" } ] } ``` {% endtab %} {% endtabs %} ## Transfer polished diamonds Manufacturers can transfer the ownership of polished diamonds to other manufacturers and retailers. > ### Please note > > Polished diamonds may only be transferred provided: > > * The diamonds are unlocked (fees apply for unlocking diamonds) > * The diamonds have inscription numbers To initiate a transfer of polished diamonds, pass the list of polished diamonds to the endpoint: Call `POST /v2/transfer/out/start` {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "a2uj544df5t5awu5v792wyj6" }, { "diamond_id": "jo55p0yxbk7slopptdwv0zol" } ], "receiver": "https://api.manufacturer.tracr.local", "shipment_name": "Polished Shipment", "shipment_type": "polished" } ``` {% endtab %} {% tab title="Response" %} ```json { "shipment_id": "ftduqi7nsiaw4vn0039va92v", "shipment_name": "Polished Shipment", "diamonds": [ { "diamond_id": "a2uj544df5t5awu5v792wyj6", "lifecycle_state": "polished", "participant_id": "demo_1_polished_1", "polished": { "carats": 1.01, "clarity": "SI1", "colour": "F", "cut_grade": "EX", "inscription_numbers": [ "GIA 2141438167" ], "shape": "Round" }, "rough": null, "status": "success" }, { "diamond_id": "jo55p0yxbk7slopptdwv0zol", "lifecycle_state": "polished", "participant_id": "demo_1_polished_2", "polished": { "carats": 0.31, "clarity": "VVS1", "colour": "F", "cut_grade": "EX", "inscription_numbers": [ "GIA 1234567891" ], "shape": "Pear" }, "rough": null, "status": "success" } ] } ``` {% endtab %} {% endtabs %} ## View outbound shipments To list all outbound shipments: Call `GET /v2/shipment/outbound` ```json { "next": null, "page": 1, "pages": 1, "previous": null, "results": [ { "created_at": "2024-05-31T11:31+0000", "diamonds": [ { "created_at": "2024-05-31T11:31+0000", "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "lifecycle_state": "rough", "participant_id": "rough_1", "rough": { "carats": "2.57", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transferred", "updated_at": "2024-05-31T15:07+0000", "polished": null }, { "created_at": "2024-05-31T11:31+0000", "diamond_id": "nmg7r5yhut68fz4czxnvanoc", "lifecycle_state": "rough", "participant_id": "rough_2", "rough": { "carats": "0.64", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transferred", "updated_at": "2024-05-31T15:08+0000", "polished": null } ], "id": "rhgy6z6e7j1mwd11nbqc0urg", "name": "Rough Shipment", "receiver": "https://api.manufacturer.tracr.local", "shipment_type": "rough", "status": "complete" }, { "created_at": "2024-05-31T14:55+0000", "diamonds": [ { "created_at": "2024-05-31T14:55+0000", "diamond_id": "xyr7pse2lllekbdup54fqsux", "lifecycle_state": "rough", "participant_id": "rough_3", "rough": { "carats": "1.67", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transfer_out_confirmed", "updated_at": "2024-05-31T14:55+0000", "polished": null }, { "created_at": "2024-05-31T14:55+0000", "diamond_id": "z3p3egbrrvzd8zsxax2ba5fn", "lifecycle_state": "rough", "participant_id": "rough_4", "rough": { "carats": "0.95", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transfer_out_confirmed", "updated_at": "2024-05-31T14:55+0000", "polished": null } ], "id": "gpchul9fhqyo6tf23kzuodjl", "name": "Rough Shipment 2", "receiver": "https://api.manufacturer.tracr.local", "shipment_type": "rough", "status": "sent" } ], "total": 2 } ``` This endpoint support various filters. For example, to return only those shipments that have completed processing: Call `GET /v2/shipment/outbound?status=complete` ```json { "next": null, "page": 1, "pages": 1, "previous": null, "results": [ { "created_at": "2024-05-31T11:31+0000", "diamonds": [ { "created_at": "2024-05-31T11:31+0000", "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "lifecycle_state": "rough", "participant_id": "rough_1", "rough": { "carats": "2.57", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transferred", "updated_at": "2024-05-31T15:07+0000", "polished": null }, { "created_at": "2024-05-31T11:31+0000", "diamond_id": "nmg7r5yhut68fz4czxnvanoc", "lifecycle_state": "rough", "participant_id": "rough_2", "rough": { "carats": "0.64", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transferred", "updated_at": "2024-05-31T15:08+0000", "polished": null } ], "id": "rhgy6z6e7j1mwd11nbqc0urg", "name": "Rough Shipment", "receiver": "https://api.manufacturer.tracr.local", "shipment_type": "rough", "status": "complete" } ], "total": 1 } ``` To view a specific outbound shipment Call `GET v2/shipment/outbound/gpchul9fhqyo6tf23kzuodjl` ```json { "created_at": "2024-05-31T14:55+0000", "diamonds": [ { "created_at": "2024-05-31T14:55+0000", "diamond_id": "xyr7pse2lllekbdup54fqsux", "lifecycle_state": "rough", "participant_id": "rough_3", "rough": { "carats": "1.67", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transfer_out_confirmed", "updated_at": "2024-05-31T14:55+0000", "polished": null }, { "created_at": "2024-05-31T14:55+0000", "diamond_id": "z3p3egbrrvzd8zsxax2ba5fn", "lifecycle_state": "rough", "participant_id": "rough_4", "rough": { "carats": "0.95", "colour": null, "model": null, "quality": null, "stress": null, "box_id": null, "sight_year": null, "sight_number": null }, "transfer_state": "transfer_out_confirmed", "updated_at": "2024-05-31T14:55+0000", "polished": null } ], "id": "gpchul9fhqyo6tf23kzuodjl", "name": "Rough Shipment 2", "receiver": "https://api.manufacturer.tracr.local", "shipment_type": "rough", "status": "sent" } ``` ## Cancel a shipment An outbound shipment can be cancelled by the sender. > **An important note regarding the cancellation of a shipment** > > Cancelling a shipment means Tracr will individually cancel the transfer of each diamond in the shipment. If some diamonds have already been accepted by the receiver, the transfer cannot be cancelled and reverted. Call `POST /transfer/out/gpchul9fhqyo6tf23kzuodjl/cancel` {% tabs %} {% tab title="Request" %} ```json [ { "diamond_id": "xyr7pse2lllekbdup54fqsux" }, { "diamond_id": "z3p3egbrrvzd8zsxax2ba5fn" } ] ``` {% endtab %} {% tab title="Response" %} ```json [ { "diamond_id": "xyr7pse2lllekbdup54fqsux", "status": "success" }, { "diamond_id": "z3p3egbrrvzd8zsxax2ba5fn", "status": "success" } ] ``` {% endtab %} {% endtabs %} # Shipments inbound Please see the [Shipments Inbound](/tracr-user-guide/8.-shipments-inbound) documentation for help on transferring diamonds into a Tracr instance. ## List inbound shipments To list all inbound shipments: Call `GET /v2/shipment/inbound` ```json { "next": null, "page": 1, "pages": 1, "previous": null, "results": [ { "id": "rhgy6z6e7j1mwd11nbqc0urg", "name": "Rough Shipment", "sender": "https://api.producer.uat.tracr.com", "diamonds": [ { "created_at": "2024-05-31T11:31+0000", "diamond_id": "nmg7r5yhut68fz4czxnvanoc", "lifecycle_state": "rough", "polished": null, "rough": { "carats": "0.64", "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T11:31+0000" }, { "created_at": "2024-05-31T11:31+0000", "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "lifecycle_state": "rough", "polished": null, "rough": { "carats": "2.57", "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T11:31+0000" } ], "created_at": "2024-05-31T11:31+0000", "shipment_type": "rough", "status": "action_required", "total_diamonds": 2 }, { "id": "ftduqi7nsiaw4vn0039va92v", "name": "Polished Shipment", "sender": "https://api.manufacturer.uat.tracr.com", "diamonds": [ { "created_at": "2024-05-31T14:35+0000", "diamond_id": "a2uj544df5t5awu5v792wyj6", "lifecycle_state": "polished", "polished": { "carats": "1.01", "clarity": "SI1", "colour": "F", "cut_grade": "EX", "shape": "Round" }, "rough": null, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T14:35+0000" }, { "created_at": "2024-05-31T14:35+0000", "diamond_id": "jo55p0yxbk7slopptdwv0zol", "lifecycle_state": "polished", "polished": { "carats": "0.31", "clarity": "VVS1", "colour": "F", "cut_grade": "EX", "shape": "Pear" }, "rough": null, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T14:35+0000" } ], "created_at": "2024-05-31T14:35+0000", "shipment_type": "polished", "status": "action_required", "total_diamonds": 2 } ], "total": 2 } ``` This endpoint supports filtering. For example, to only return rough shipments from producers: Call `GET /v2/shipment/inbound?shipment_type=rough` ```json { "next": null, "page": 1, "pages": 1, "previous": null, "results": [ { "id": "rhgy6z6e7j1mwd11nbqc0urg", "name": "Rough Shipment", "sender": "https://api.producer.uat.tracr.com", "diamonds": [ { "created_at": "2024-05-31T11:31+0000", "diamond_id": "gy9zacqpt64rfm5l9aj8fdgc", "lifecycle_state": "rough", "polished": null, "rough": { "carats": "2.57", "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T11:31+0000" }, { "created_at": "2024-05-31T11:31+0000", "diamond_id": "nmg7r5yhut68fz4czxnvanoc", "lifecycle_state": "rough", "polished": null, "rough": { "carats": "0.64", "colour": null, "model": null, "quality": null, "stress": null, "box_id": "demo_rough_box", "sight_year": null, "sight_number": null }, "transfer_state": "transfer_in_confirmed", "updated_at": "2024-05-31T11:31+0000" } ], "created_at": "2024-05-31T11:31+0000", "shipment_type": "rough", "status": "action_required", "total_diamonds": 2 } ], "total": 1 } ``` ## Accept a transfer To accept an inbound shipment (thereby starting the transfer process), pass the list of the diamond IDs you wish to accept to the API, along with the ID of the shipment assigned by Tracr. For example, to accept only the pear-shaped diamond in the polished shipment: Call `POST /v2/transfer/in/ftduqi7nsiaw4vn0039va92v/accept` {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "jo55p0yxbk7slopptdwv0zol" } ] } ``` {% endtab %} {% tab title="Response" %} ```json { "results": [ { "diamond_id": "jo55p0yxbk7slopptdwv0zol", "status": "success" } ] } ``` {% endtab %} {% endtabs %} ## Reject a transfer In a similar vein, diamonds can be rejected from the transfer. For example, to reject the round diamond: Call, `POST /transfer/in/ftduqi7nsiaw4vn0039va92v/reject` {% tabs %} {% tab title="Request" %} ```json [ { "diamond_id": "a2uj544df5t5awu5v792wyj6" } ] ``` {% endtab %} {% tab title="Response" %} ```json [ { "diamond_id": "a2uj544df5t5awu5v792wyj6", "status": "success" } ] ``` {% endtab %} {% endtabs %} > **Please note** > > For shipments of rough diamonds, the shipment must be accepted or rejected in its entirety (i.e. by sending each diamond in the request body), otherwise no action will be taken. > > For example: `POST /v2/transfer/in/b66ei4prxlp3fx1lwd2zps7x/accept` > > ```json > { > "diamonds": [ > { > "diamond_id": "nmg7r5yhut68fz4czxnvanoc" > } > ] > } > ``` > > ```json > { > "message": "Rough shipments must be accepted, cancelled, or rejected in their entirety. All of the shipment's diamonds must be present in request." > } > ``` In the case of rough shipments, once the transfer has been accepted you'll be able to start registering rough diamonds against the shipment using the `box_id` field. See ([Register a diamond from another producer](/api-reference/tracr-api/register_rough#register-a-diamond-from-another-producer) for more information. # Delete Tracr provides an API endpoint to delete diamonds. Upon deletion, a diamond is permanently removed from the inventory and cannot be restored. The intention of this endpoint is to give participants the ability to correct data errors with diamonds they've uploaded to Tracr simply by deleting the diamond and re-uploading it with the corrected information. It is not available to retailers and cannot be used on diamonds that have been unlocked (either manually via the portal or automatically via another action, such as transferring to another participant), or diamonds with descendants (children of that diamond, or children of those children and so on...) that have been unlocked. ## Delete diamond without descendants Call `POST /bulk/diamonds/delete` ```json { "diamonds": [ { "diamond_id": "clmkgill50000ps17ogi4d2yu" } ] } ``` If the diamond was successfully deleted this will be marked in the response: ```json { "results": [ { "diamond_id": "clmkgill50000ps17ogi4d2yu", "participant_id":"cb482ea8-5a95-431b-88df-84fc363ebda9", "status": "success", "descendants": [] } ] } ``` If it could not be deleted, the reason will be given: ```json { "results": [ { "diamond_id": "clmkgill50000ps17ogi4d2yu", "participant_id":"cb482ea8-5a95-431b-88df-84fc363ebda9", "status": "diamond_transferred", "error": "The diamond could not be deleted because it has been transferred.", "descendants": [] } ] } ``` ## Delete diamond with descendants A diamond with descendants cannot be deleted unless those descendants are deleted simultaneously (for example, a rough diamond that was split into two roughs that were subsequently polished cannot be deleted unless those polished diamonds are also deleted). To delete the descendants in addition to the diamond, add a `delete_descendants` flag to the diamond in the request body: call `POST /bulk/diamonds/delete` ```json { "diamonds": [ { "diamond_id": "clmkhpl870002mv17475ur906", "delete_descendants": true } ] } ``` If the delete succeeds then the diamond's descendants are returned: ```json { "results": [ { "diamond_id": "clmkhpl870002mv17475ur906", "participant_id": "71a2e460-902f-4bf2-8fa1-5c226847d050", "status": "success", "descendants": [ { "diamond_id": "clmkh5ln90000mv17o65tslpo", "participant_id": "dc7d63ea-df23-4d21-a04a-c611f5f483cf" }, { "diamond_id": "clmkh74z40001mv17em0uu3tz", "participant_id": "951bf2f2-1c49-43c9-a51e-518c62186b2a" } ] } ] } ``` If one of the descendants cannot be deleted then the diamond and all its descendants remain in the inventory, and the diamonds that could not be deleted are marked in the response: ```json { "results": [ { "diamond_id": "clmkhpl870002mv17475ur906", "participant_id": "71a2e460-902f-4bf2-8fa1-5c226847d050", "status": "descendants_in_active_shipment", "error": "The diamond could not be deleted because one or more of its descendants are in an active shipment.", "descendants": [ { "diamond_id": "clmkh74z40001mv17em0uu3tz", "participant_id": "951bf2f2-1c49-43c9-a51e-518c62186b2a" } ] } ] } ``` Likewise if the request is made with `delete_descendants` set to `false`, or not set at all, deletion fails and the diamonds remain in the inventory: call `POST /bulk/diamonds/delete` {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "clmkhpl870002mv17475ur906", } ] } ``` {% endtab %} {% tab title="Response" %} ```json { "results": [ { "diamond_id": "clmkhpl870002mv17475ur906", "participant_id": "71a2e460-902f-4bf2-8fa1-5c226847d050", "status": "diamond_has_descendants", "error": "The diamond could not be deleted because it has descendants.", "descendants": [ { "diamond_id": "clmkh5ln90000mv17o65tslpo", "participant_id": "dc7d63ea-df23-4d21-a04a-c611f5f483cf" }, { "diamond_id": "clmkh74z40001mv17em0uu3tz", "participant_id": "951bf2f2-1c49-43c9-a51e-518c62186b2a" } ] } ] } ``` {% endtab %} {% endtabs %} ## Delete multiple diamonds The endpoint can handle deletion requests for multiple diamonds (up to 1,000) simultaneously. When sending multiple diamond IDs, each diamond is treated in isolation: call `POST /bulk/diamonds/delete` {% tabs %} {% tab title="Request" %} ```json { "diamonds": [ { "diamond_id": "clmkgill50000ps17ogi4d2yu", }, { "diamond_id": "clmkhpl870002mv17475ur906", "delete_descendants": false }, { "diamond_id": "clmkhq91j0003mv176jo5ir3z", "delete_descendants": true } ] } ``` {% endtab %} {% tab title="Response" %} ```json { "results": [ { "diamond_id": "clmkgill50000ps17ogi4d2yu", "participant_id":"cb482ea8-5a95-431b-88df-84fc363ebda9", "status": "diamond_in_active_shipment", "error": "The diamond could not be deleted because it is in an active shipment.", }, { "diamond_id": "clmkhpl870002mv17475ur906", "participant_id": "71a2e460-902f-4bf2-8fa1-5c226847d050", "status": "diamond_has_descendants", "error": "The diamond could not be deleted because it has descendants.", "descendants": [ { "diamond_id": "clmkh5ln90000mv17o65tslpo", "participant_id": "dc7d63ea-df23-4d21-a04a-c611f5f483cf" }, { "diamond_id": "clmkh74z40001mv17em0uu3tz", "participant_id": "951bf2f2-1c49-43c9-a51e-518c62186b2a" } ] }, { "diamond_id": "clmkhq91j0003mv176jo5ir3z", "participant_id": "f2eccb09-c4a7-405e-8bda-4cd8fbbf9e8e", "status": "success", "descendants": [] } ] } ``` {% endtab %} {% endtabs %} # Grading Data Management Tracr provides an API endpoint to * list the grading data record * select a grading data to be active. * deactavate grading data ## List the grading data record All available grading data records are returned in the response body. Call `GET /diamonds/ac0mkpewmjmd9g2xtbqozsdr/graded-measurements` ([reference](/api-reference/tracr-api/references/diamonds#patch-diamonds-id-graded-measurements-graded_measurement_id-deselect)) {% tabs %} {% tab title="Response" %} ```json { "results": [ { "id": "qfbd9poady0vk4evq6edeanj", "carats": 0.4, "clarity": "VS1", "colour": "D", "fluorescence_intensity": "N", "graded_date": "2024-08-06T12:50:03.408407+00:00", "grader_inscription_numbers": [ "GIA 2358460633" ], "grader_report_number": "2358460633", "grading_certificate_filename": "GradingCertificate(69).pdf", "grading_certificate_hash": "14ee89d84af3cf49e0e9fc1783dd7e0063adb85a32ce361c6635f259999543ba", "grading_lab": "GIA", "is_active": false, "is_selectable": true, "polish_quality": "EX", "shape": "Heart", "source": "user", "symmetry": "EX" }, { "id": "xwq4n42d33yv943v66nolk00", "carats": 1.24, "clarity": "VS2", "colour": "H", "cut_grade": "EX", "graded_date": "2024-05-31T10:54:28.033000+00:00", "grader_certificate_number": "null", "grader_clarity_characteristics": "Crystal", "grader_inscription_numbers": [ "GIA 2141438180" ], "grader_report_comments": "Perfect", "grader_report_number": "2141438180", "grading_certificate_filename": "demo_polished_1.pdf", "grading_certificate_hash": "0ffa6a2313fff5db0048d47432a89615185873f08feeab5985451adac3a49930", "grading_lab": "GIA", "is_active": true, "is_selectable": true, "measurement_text": "5.10 - 5.12 x 3.18 mm ", "polish_quality": "EX", "shape": "Round", "source": "gis", "symmetry": "VG", "validation_level": "validation" } ] } ``` {% endtab %} {% endtabs %} `is_active` : If it's ture, this means this grading data will be shown on all interfaces , and only the active grading data record will be transferred. `is_selectable` : This is to indicate which grading data is available for selection `source` :This is to indicate the source of grading data * user : The grading data is uploaded by user * gis : The grading data is provided by the grading lab. ## Select a grading data to be active To select a grading data which will be shown on all interfaces, and this grading data will be tranferred to downstream if transfer is happening. > There's only one active grading data is allowed. Once the other grading data be selected, the current active grading data record will be deactived .(`is_active` will be set to flase .) Call `PATCH diamonds/ac0mkpewmjmd9g2xtbqozsdr/qfbd9poady0vk4evq6edeanj/select`([reference](/api-reference/tracr-api/references/diamonds#patch-diamonds-id-graded-measurements-graded_measurement_id-select)) {% tabs %} {% tab title="Response" %} ```json { "id": "qfbd9poady0vk4evq6edeanj", "carats": 0.4, "clarity": "VS1", "colour": "D", "fluorescence_intensity": "N", "graded_date": "2024-08-06T12:50:03.408407+00:00", "grader_inscription_numbers": [ "GIA 2358460633" ], "grader_report_number": "2358460633", "grading_certificate_filename": "GradingCertificate(69).pdf", "grading_certificate_hash": "14ee89d84af3cf49e0e9fc1783dd7e0063adb85a32ce361c6635f259999543ba", "grading_lab": "GIA", "is_active": true, "is_selectable": true, "polish_quality": "EX", "shape": "Heart", "source": "user", "symmetry": "EX" } ``` {% endtab %} {% endtabs %} ## Deselect a grading data To remove the grading data from any interfaces. Call `PATCH diamonds/ac0mkpewmjmd9g2xtbqozsdr/qfbd9poady0vk4evq6edeanj/deselect`([reference](/api-reference/tracr-api/references/diamonds#patch-diamonds-id-graded-measurements-graded_measurement_id-deselect)) {% tabs %} {% tab title="Response" %} ```json { "id": "qfbd9poady0vk4evq6edeanj", "carats": 0.4, "clarity": "VS1", "colour": "D", "fluorescence_intensity": "N", "graded_date": "2024-08-06T12:50:03.408407+00:00", "grader_inscription_numbers": [ "GIA 2358460633" ], "grader_report_number": "2358460633", "grading_certificate_filename": "GradingCertificate(69).pdf", "grading_certificate_hash": "14ee89d84af3cf49e0e9fc1783dd7e0063adb85a32ce361c6635f259999543ba", "grading_lab": "GIA", "is_active": false, "is_selectable": true, "polish_quality": "EX", "shape": "Heart", "source": "user", "symmetry": "EX" } ``` {% endtab %} {% endtabs %} # Bulk ## POST /bulk/diamond-asset/delete > Delete Diamond Assets ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/bulk/diamond-asset/delete":{"post":{"operationId":"delete_diamond_assets_bulk_diamond_asset_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResponse"}}},"description":"The request was processed successfully. The result of each deletion is determined by looking at individual deletion status for each diamond asset."},"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."},"409":{"description":"The request was unable to be processed due to one of the diamond assets in the request (or the asset's related diamond) being updated by another process."},"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":"Delete Diamond Assets","tags":["Bulk","Diamond Assets"]}}},"components":{"schemas":{"BulkDiamondAssetDeleteRequest":{"description":"A request to delete one or more diamond assets.","properties":{"assets":{"description":"The diamond assets for which to process.","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteRequestAsset"},"title":"Assets","type":"array"}},"required":["assets"],"title":"BulkDiamondAssetDeleteRequest","type":"object"},"BulkDiamondAssetDeleteRequestAsset":{"description":"A diamond asset contained within a bulk diamond asset deletion request.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to delete.","title":"Diamond Asset Id","type":"string"}},"required":["diamond_asset_id"],"title":"BulkDiamondAssetDeleteRequestAsset","type":"object"},"BulkDiamondAssetDeleteResponse":{"description":"A response from the /bulk/diamond-asset/delete endpoint containing the status\nof each deleted diamond.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResult"},"title":"Results","type":"array"}},"required":["results"],"title":"BulkDiamondAssetDeleteResponse","type":"object"},"BulkDiamondAssetDeleteResult":{"description":"The result of deleting a single diamond asset.","properties":{"diamond_asset_id":{"description":"The ID of the diamond asset to which this result pertains.","title":"Diamond Asset Id","type":"string"},"diamond_id":{"anyOf":[{"pattern":"^[a-z\\d]{20,98}$","type":"string"},{"type":"null"}],"description":"The ID of diamond to which this result pertains. In the case that the asset could not be found, this will be null.","title":"Diamond Id"},"errors":{"description":"Any errors preventing the deletion of the diamond asset. In the case that the error(s) are resolvable many errors may be returned. ","items":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultError"},"title":"Errors","type":"array"},"status":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteStatus","description":"The status of the deletion."}},"required":["diamond_asset_id","diamond_id","status"],"title":"BulkDiamondAssetDeleteResult","type":"object"},"BulkDiamondAssetDeleteResultError":{"description":"An error returned if the deletion of a diamond asset fails.","properties":{"error_code":{"$ref":"#/components/schemas/BulkDiamondAssetDeleteResultErrorCode","description":"An error code representing the error that occurred."},"message":{"description":"A human readable error message explaining the error code. Error messages can change over time.","title":"Message","type":"string"}},"required":["error_code","message"],"title":"BulkDiamondAssetDeleteResultError","type":"object"},"BulkDiamondAssetDeleteResultErrorCode":{"description":"Unique error codes representing errors that occur when deleting diamond assets.","enum":["diamond_asset_not_found","diamond_archived","diamond_in_transfer","diamond_transferred","invalid_diamond_asset_type","legacy_diamond_asset"],"title":"BulkDiamondAssetDeleteResultErrorCode","type":"string"},"BulkDiamondAssetDeleteStatus":{"description":"Overarching status of a bulk diamond asset deletion request.","enum":["success","error"],"title":"BulkDiamondAssetDeleteStatus","type":"string"}}}} ``` ## Bulk Mark As Archived > Mark diamonds as archived, if they're available to be archived. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/bulk/diamonds/archive":{"post":{"description":"Mark diamonds as archived, if they're available to be archived.","operationId":"bulk_mark_as_archived_bulk_diamonds_archive_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveResponse"}}},"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":"Bulk Mark As Archived","tags":["Bulk","Diamonds"]}}},"components":{"schemas":{"ArchiveRequest":{"description":"A list of diamonds to mark as archived.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"ArchiveRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"ArchiveResponse":{"description":"Aggregated results of marking diamonds as archived.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/ArchiveDiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"ArchiveResponse","type":"object"},"ArchiveDiamondResult":{"description":"The result of marking a single diamond as archived.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/ArchiveStatus"}},"required":["diamond_id","status"],"title":"ArchiveDiamondResult","type":"object"},"ArchiveStatus":{"description":"Indicates that a diamond was marked as archived successfully or the reason why\nthe diamond could not be marked as archived.","enum":["success","diamond_not_found","diamond_in_terminal_state","diamond_transferred","diamond_in_active_shipment"],"title":"ArchiveStatus","type":"string"}}}} ``` ## Bulk Delete Diamonds > Permanently delete diamonds from a participant's inventory. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/bulk/diamonds/delete":{"post":{"description":"Permanently delete diamonds from a participant's inventory.","operationId":"bulk_delete_diamonds_bulk_diamonds_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResponse"}}},"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":"Bulk Delete Diamonds","tags":["Bulk","Diamonds"]}}},"components":{"schemas":{"DeleteRequest":{"properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DeleteRequestDiamond"},"maxItems":1000,"title":"Diamonds","type":"array"},"dry_run":{"default":false,"description":"If true, no diamonds will be deleted. The API will return the response as if it did.","title":"Dry Run","type":"boolean"}},"required":["diamonds"],"title":"DeleteRequest","type":"object"},"DeleteRequestDiamond":{"properties":{"delete_descendants":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Delete Descendants"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DeleteRequestDiamond","type":"object"},"DeleteResponse":{"properties":{"results":{"items":{"anyOf":[{"$ref":"#/components/schemas/DeleteResultError"},{"$ref":"#/components/schemas/DeleteResultSuccess"}]},"title":"Results","type":"array"}},"required":["results"],"title":"DeleteResponse","type":"object"},"DeleteResultError":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"error":{"title":"Error","type":"string"},"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.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultErrorStatus"}},"required":["diamond_id","status","descendants","error"],"title":"DeleteResultError","type":"object"},"DeleteResponseDiamond":{"properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"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.","title":"Participant Id"}},"required":["diamond_id"],"title":"DeleteResponseDiamond","type":"object"},"DeleteResultErrorStatus":{"description":"Defines the different errors possible when deleting a diamond.","enum":["descendants_in_active_shipment","descendants_transferred","descendants_unlocked","descendants_archived","diamond_has_descendants","diamond_in_active_shipment","diamond_not_found","diamond_transferred","diamond_unlocked"],"title":"DeleteResultErrorStatus","type":"string"},"DeleteResultSuccess":{"properties":{"descendants":{"items":{"$ref":"#/components/schemas/DeleteResponseDiamond"},"title":"Descendants","type":"array"},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"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.","title":"Participant Id"},"status":{"$ref":"#/components/schemas/DeleteResultSuccessStatus","default":"success"}},"required":["diamond_id","descendants"],"title":"DeleteResultSuccess","type":"object"},"DeleteResultSuccessStatus":{"description":"Defines the possible statuses when a diamond has been successfully\ndeleted.","enum":["success"],"title":"DeleteResultSuccessStatus","type":"string"}}}} ``` ## Bulk Unarchive > Un-archive diamonds, if they're available to be un-archived. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/bulk/diamonds/unarchive":{"post":{"description":"Un-archive diamonds, if they're available to be un-archived.","operationId":"bulk_unarchive_bulk_diamonds_unarchive_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnarchiveRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnarchiveResponse"}}},"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":"Bulk Unarchive","tags":["Bulk","Diamonds"]}}},"components":{"schemas":{"UnarchiveRequest":{"description":"A list of diamonds to un-archive.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnarchiveRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"UnarchiveResponse":{"description":"Aggregated results of un-archiving diamonds.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/UnarchiveDiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"UnarchiveResponse","type":"object"},"UnarchiveDiamondResult":{"description":"The result of un-archiving a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/UnarchiveStatus"}},"required":["diamond_id","status"],"title":"UnarchiveDiamondResult","type":"object"},"UnarchiveStatus":{"description":"Indicates that a diamond was successfully un-archived or the reason why\nthe diamond could not be un-archived.","enum":["success","diamond_not_found"],"title":"UnarchiveStatus","type":"string"}}}} ``` ## Unlock Diamonds > Unlock the diamonds in the request body, if they're available to unlock. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/bulk/diamonds/unlock":{"post":{"description":"Unlock the diamonds in the request body, if they're available to unlock.","operationId":"unlock_diamonds_bulk_diamonds_unlock_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockResponse"}}},"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":"Returned if the request body is malformed or does not contain any diamonds"},"500":{"description":"Internal Server Error. If this error persists please contact the Platform Admin team."}},"summary":"Unlock Diamonds","tags":["Bulk","Diamonds"]}}},"components":{"schemas":{"UnlockRequest":{"description":"Represents a request to unlock one or more locked diamonds.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnlockRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"UnlockResponse":{"description":"Represents the response to an UnlockRequest.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondUnlockResult"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"UnlockResponse","type":"object"},"DiamondUnlockResult":{"description":"Represents the result of an attempt to unlock a single diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/DiamondUnlockResultStatus"}},"required":["diamond_id","status"],"title":"DiamondUnlockResult","type":"object"},"DiamondUnlockResultStatus":{"description":"Represents the possible responses to an attempt to unlock a diamond.","enum":["diamond_does_not_exist","diamond_cannot_be_unlocked","missing_unlock_requirement","success"],"title":"DiamondUnlockResultStatus","type":"string"}}}} ``` # Deprecated ## Get Diamonds > This endpoint is deprecated. Please use the \`/v2/diamond/\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/":{"get":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/diamond/` endpoint instead.","operationId":"get_diamonds_diamonds__get","parameters":[{"description":"Lifecycle state of the diamond","in":"query","name":"lifecycle_state","required":false,"schema":{"default":["rough","polished"],"description":"Lifecycle state of the diamond","items":{"$ref":"#/components/schemas/LifecycleState"},"title":"Lifecycle State","type":"array"}},{"description":"Possession state of the diamond","in":"query","name":"possession_state","required":false,"schema":{"default":["held"],"description":"Possession state of the diamond","items":{"$ref":"#/components/schemas/PossessionState"},"title":"Possession State","type":"array"}},{"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","in":"query","name":"participant_id","required":false,"schema":{"default":[],"description":"User supplied identifier for the diamond, specific to this Tracr instance. Synonymous with ERP ID and Stock ID.","items":{"type":"string"},"title":"Participant Id","type":"array"}},{"description":"Tracr Diamond ID","in":"query","name":"diamond_id","required":false,"schema":{"default":[],"description":"Tracr Diamond ID","items":{"type":"string"},"title":"Diamond Id","type":"array"}},{"description":"List archived diamonds","in":"query","name":"is_archived","required":false,"schema":{"default":false,"description":"List archived diamonds","title":"Is Archived","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/DiamondsPaginator_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":"Get Diamonds","tags":["Deprecated"]}}},"components":{"schemas":{"LifecycleState":{"enum":["destroyed","polished","rough","split"],"title":"LifecycleState","type":"string"},"PossessionState":{"enum":["destroyed","held","known"],"title":"PossessionState","type":"string"},"DiamondsPaginator_DiamondV1_":{"properties":{"next":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the next page. Excluded from the response if there is no 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 for the previous page. Excluded from the response if there is no previous page.","title":"Previous"},"results":{"description":"The diamond data.","items":{"$ref":"#/components/schemas/DiamondV1"},"title":"Results","type":"array"},"total":{"description":"The total number of diamonds across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"DiamondsPaginator[DiamondV1]","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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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"},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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"},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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 Polished Diamond > This endpoint is deprecated. Please use the \`/v2/diamond/{id}/polished\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/polished":{"patch":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/diamond/{id}/polished` endpoint instead.","operationId":"update_polished_diamond_diamonds__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/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":"Update Polished Diamond","tags":["Deprecated"]}}},"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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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 > This endpoint is deprecated. Please use the \`/v2/diamond/{id}/rough\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/diamonds/{id}/rough":{"patch":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/diamond/{id}/rough` endpoint instead.","operationId":"update_rough_diamond_diamonds__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/UpdateRough"}}},"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":"Update Rough Diamond","tags":["Deprecated"]}}},"components":{"schemas":{"UpdateRough":{"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"},"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":"UpdateRough","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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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 All Inbound Shipments > This endpoint is deprecated. Please use the \`/v2/shipment/inbound\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/shipments/inbound":{"get":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/shipment/inbound` endpoint instead.","operationId":"get_all_inbound_shipments_shipments_inbound_get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundShipmentsModel"}}},"description":"Successful Response"}},"summary":"Get All Inbound Shipments","tags":["Deprecated"]}}},"components":{"schemas":{"InboundShipmentsModel":{"description":"Details of multiple inbound shipments and the diamonds within them.","properties":{"items":{"items":{"$ref":"#/components/schemas/InboundShipmentModel"},"title":"Items","type":"array"}},"required":["items"],"title":"InboundShipmentsModel","type":"object"},"InboundShipmentModel":{"description":"Details of the inbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/InboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"sender":{"title":"Sender","type":"string"}},"required":["id","name","sender","diamonds","created_at"],"title":"InboundShipmentModel","type":"object"},"InboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"InboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","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"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"}}}} ``` ## Get Inbound Shipment > This endpoint is deprecated. Please use the \`/v2/shipment/inbound/{shipment\_id}\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/shipments/inbound/{shipment_id}":{"get":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/shipment/inbound/{shipment_id}` endpoint instead.","operationId":"get_inbound_shipment_shipments_inbound__shipment_id__get","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundShipmentModel"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Inbound Shipment","tags":["Deprecated"]}}},"components":{"schemas":{"InboundShipmentModel":{"description":"Details of the inbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/InboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"sender":{"title":"Sender","type":"string"}},"required":["id","name","sender","diamonds","created_at"],"title":"InboundShipmentModel","type":"object"},"InboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/InboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"InboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","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"},"InboundDiamondState":{"enum":["accepted","cancelled","owned","pending_reject","pending_verification","rejected","transferred","transfer_in_confirmed","transfer_in_pending","verification_failed","verified"],"title":"InboundDiamondState","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Get All Outbound Shipments > This endpoint is deprecated. Please use the \`/v2/shipment/outbound\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/shipments/outbound":{"get":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/shipment/outbound` endpoint instead.","operationId":"get_all_outbound_shipments_shipments_outbound_get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundShipmentsModel"}}},"description":"Successful Response"}},"summary":"Get All Outbound Shipments","tags":["Deprecated"]}}},"components":{"schemas":{"OutboundShipmentsModel":{"description":"Details of multiple outbound shipments and the diamonds within them.","properties":{"items":{"items":{"$ref":"#/components/schemas/OutboundShipmentModel"},"title":"Items","type":"array"}},"required":["items"],"title":"OutboundShipmentsModel","type":"object"},"OutboundShipmentModel":{"description":"Details of the outbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/OutboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"receiver":{"title":"Receiver","type":"string"}},"required":["created_at","diamonds","id","name","receiver"],"title":"OutboundShipmentModel","type":"object"},"OutboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"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.","title":"Participant Id"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"OutboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","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"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"}}}} ``` ## Get Outbound Shipment > This endpoint is deprecated. Please use the \`/v2/shipment/outbound/{shipment\_id}\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/shipments/outbound/{shipment_id}":{"get":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/shipment/outbound/{shipment_id}` endpoint instead.","operationId":"get_outbound_shipment_shipments_outbound__shipment_id__get","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundShipmentModel"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Outbound Shipment","tags":["Deprecated"]}}},"components":{"schemas":{"OutboundShipmentModel":{"description":"Details of the outbound shipment of a transfer and the diamonds within it.","properties":{"created_at":{"format":"date-time","title":"Created At","type":"string"},"diamonds":{"items":{"$ref":"#/components/schemas/OutboundShipmentDiamondModel"},"title":"Diamonds","type":"array"},"id":{"pattern":"^[a-z\\d]{20,98}$","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"receiver":{"title":"Receiver","type":"string"}},"required":["created_at","diamonds","id","name","receiver"],"title":"OutboundShipmentModel","type":"object"},"OutboundShipmentDiamondModel":{"description":"Details of a single diamond that is being transferred.","properties":{"carats":{"title":"Carats","type":"string"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"created_at":{"format":"date-time","title":"Created At","type":"string"},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"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.","title":"Participant Id"},"shape":{"anyOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"transfer_state":{"$ref":"#/components/schemas/OutboundDiamondState"},"updated_at":{"format":"date-time","title":"Updated At","type":"string"}},"required":["carats","created_at","diamond_id","transfer_state","updated_at"],"title":"OutboundShipmentDiamondModel","type":"object"},"Clarity":{"enum":["FL","IF","LC","VVS1","VVS2","VS1","VS2","SI1","SI2","SI3","I1","I2","I3","P1","P2","P3"],"title":"Clarity","type":"string"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","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"},"OutboundDiamondState":{"enum":["accepted","cancelled","rejected","pending_cancel","transferred","transfer_out_confirmed","transfer_out_pending","pending_reject","receiver_informed_of_cancel"],"title":"OutboundDiamondState","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer In Accept > This endpoint is deprecated. Please use the \`/v2/transfer/in/{shipment\_id}/accept\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/transfer/in/{shipment_id}/accept":{"post":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/transfer/in/{shipment_id}/accept` endpoint instead.","operationId":"transfer_in_accept_transfer_in__shipment_id__accept_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiamondIdWithInscriptionNumber"},"title":"Data","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferInAcceptDiamondResult"},"title":"Response Transfer In Accept Transfer In Shipment Id Accept Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Accept","tags":["Deprecated"]}}},"components":{"schemas":{"DiamondIdWithInscriptionNumber":{"description":"An object containing a Diamond ID and associated inscription numbers.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"inscription_number":{"title":"Inscription Number","type":"string"}},"required":["diamond_id","inscription_number"],"title":"DiamondIdWithInscriptionNumber","type":"object"},"TransferInAcceptDiamondResult":{"description":"Returned by transfer/in/accept for each diamond accepted.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"inscription_number":{"title":"Inscription Number","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptStatus"}},"required":["diamond_id","inscription_number","status"],"title":"TransferInAcceptDiamondResult","type":"object"},"TransferInAcceptStatus":{"description":"Represents the result of a transfer-in-accept operation.","enum":["success","diamond_not_found","inscription_number_invalid","diamond_in_incorrect_state"],"title":"TransferInAcceptStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer Out Start > This endpoint is deprecated. Please use the \`/v2/transfer/out/start\` endpoint instead. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/transfer/out/start":{"post":{"deprecated":true,"description":"This endpoint is deprecated. Please use the `/v2/transfer/out/start` endpoint instead.","operationId":"transfer_out_start_transfer_out_start_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferOutStartRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferOutStartResponse","anyOf":[{"$ref":"#/components/schemas/TransferErrorResponse"},{"$ref":"#/components/schemas/TransferOutStartResponse"}],"title":"Response Transfer Out Start Transfer Out Start Post"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferErrorResponse"}}},"description":"Returned if:\n- Sender and receiver are the same participant.\n- Any of the diamond IDs passed in the request does not exist in the database.\n- Any of the diamond IDs passed in the request are locked.\n- Any of the diamond IDs passed is for a diamond which is not POLISHED.\n- Any of the diamond IDs passed is for a POLISHED diamond which has no\n inscription numbers.\n- Any of the diamond IDs passed is for a POLISHED diamond which has an in-flight data request.\n- Any of the diamond IDs passed is for a diamond which is archived.\n"},"409":{"description":"Returned if any of the specified diamonds are being updated as part of another process."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Start","tags":["Deprecated"]}}},"components":{"schemas":{"TransferOutStartRequest":{"description":"A request to start a transfer out for a sequence of diamonds to the V1\ntransfer/out/start endpoint.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"},"receiver":{"pattern":"^https://api\\..+\\.tracr\\.com$","title":"Receiver","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_name","receiver","diamonds"],"title":"TransferOutStartRequest","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferOutStartResponse":{"description":"A response to a V1 transfer/out/start request.","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/TransferOutStartDiamondResult"},"title":"Diamonds","type":"array"},"shipment_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_id","shipment_name","diamonds"],"title":"TransferOutStartResponse","type":"object"},"TransferOutStartDiamondResult":{"description":"Returned by the V1 transfer/out/start endpoint for each diamond.","properties":{"diamond_id":{"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"}],"title":"Diamond Parent Id"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferOutStartDiamondResult","type":"object"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"},"TransferErrorResponse":{"description":"Returned by transfer endpoints when an error occurs.","properties":{"diamonds":{"default":[],"items":{"$ref":"#/components/schemas/TransferDiamondError"},"minItems":0,"title":"Diamonds","type":"array"},"message":{"title":"Message","type":"string"}},"required":["message"],"title":"TransferErrorResponse","type":"object"},"TransferDiamondError":{"description":"Returned by transfer endpoints to detail an error with a given diamond.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"status":{"title":"Status","type":"string"}},"required":["diamond_id","diamond_parent_id","status"],"title":"TransferDiamondError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` # Diamonds ## Create Rough Diamond > Create a rough diamond in the inventory. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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 Diamond > Returns the current version of the requested diamond, if it exists. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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.35.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.35.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.35.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.35.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.35.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.35.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.35.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.35.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":"File not found."},"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.35.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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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.35.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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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.35.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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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.35.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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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.35.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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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- ``asset_request_pending``: A diamond data request 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","asset_request_pending","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","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.35.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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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.35.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|B_G|B_GY|BN|BN_O|BN_P|BN_PL|BN_R|BN_Y|CH|CM|CG|GY|GY_B|GY_G|GY_PL|GY_V|G|G_B|G_GY|G_Y|O|O_BN|O_Y|P|P_BN|P_PL|PL|PL_BN|PL_GY|PL_P|PL_R|R|R_BN|R_PL|V|V_GY|Y|Y_BN|Y_G|Y_GY|Y_O|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"},"gis_status":{"anyOf":[{"$ref":"#/components/schemas/GisStatus"},{"type":"null"}],"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI"},"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","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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"},"GisStatus":{"description":"Lab eligibility status of the diamond, exactly mirroring values displayed in the UI","enum":["eligible","missing_report","invalid_report","not_processable","missing_data","shape_not_supported"],"title":"GisStatus","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","B_G","B_GY","BN","BN_O","BN_P","BN_PL","BN_R","BN_Y","CH","CM","CG","GY","GY_B","GY_G","GY_PL","GY_V","G","G_B","G_GY","G_Y","O","O_BN","O_Y","P","P_BN","P_PL","PL","PL_BN","PL_GY","PL_P","PL_R","R","R_BN","R_PL","V","V_GY","Y","Y_BN","Y_G","Y_GY","Y_O","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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"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"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"required":["hash"],"title":"ImageRef","type":"object"},"ScanRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}},"required":["hash"],"title":"ScanRef","type":"object"},"ScanReportRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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":"ScanReportRef","type":"object"},"FileRef":{"additionalProperties":false,"properties":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"}},"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/ScanReportRef"},"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":{"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the diamond asset.","title":"Asset Id"},"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"},"gallery":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The gallery this asset belongs to.","title":"Gallery"},"gallery_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The priority for the asset being displayed in the gallery.","title":"Gallery Priority"},"hash":{"description":"The cryptographic hash of the file stored in the platform","title":"Hash","type":"string"},"is_hero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this is the diamond's hero asset.","title":"Is Hero"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label to be displayed over the asset in its respective gallery.","title":"Label"},"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"}}}} ``` # Transfer ## Transfer In Reject > Reject inbound diamonds.\ > \ > Diamonds must not have been ACCEPTED in order to be rejected. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/transfer/in/{shipment_id}/reject":{"post":{"description":"Reject inbound diamonds.\n\nDiamonds must not have been ACCEPTED in order to be rejected.","operationId":"transfer_in_reject_transfer_in__shipment_id__reject_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Data","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferInRejectDiamondResult"},"title":"Response Transfer In Reject Transfer In Shipment Id Reject Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Reject","tags":["Transfer","Transfer"]}}},"components":{"schemas":{"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferInRejectDiamondResult":{"description":"Returned by transfer/in/reject for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInRejectStatus"}},"required":["diamond_id","status"],"title":"TransferInRejectDiamondResult","type":"object"},"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer Out Cancel > Cancel outbound diamonds preventing them from being accepted.\ > \ > User initiated by the sender.\ > \ > Diamonds must not have been ACCEPTED in order to be cancelled. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/transfer/out/{shipment_id}/cancel":{"post":{"description":"Cancel outbound diamonds preventing them from being accepted.\n\nUser initiated by the sender.\n\nDiamonds must not have been ACCEPTED in order to be cancelled.","operationId":"transfer_out_cancel_transfer_out__shipment_id__cancel_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Data","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferOutCancelDiamondResult"},"title":"Response Transfer Out Cancel Transfer Out Shipment Id Cancel Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Cancel","tags":["Transfer","Transfer"]}}},"components":{"schemas":{"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferOutCancelDiamondResult":{"description":"Returned by transfer/out/cancel for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferOutCancelStatus"}},"required":["diamond_id","status"],"title":"TransferOutCancelDiamondResult","type":"object"},"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer In Accept > Accept an inbound shipment of diamonds. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/accept":{"post":{"description":"Accept an inbound shipment of diamonds.","operationId":"transfer_in_accept_v2_transfer_in__shipment_id__accept_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Response"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Accept","tags":["Transfer"]}}},"components":{"schemas":{"TransferInAcceptV2Request":{"description":"A list of diamonds to accept for transfer.","properties":{"diamonds":{"description":"The diamonds for which to process.","items":{"$ref":"#/components/schemas/DiamondIDOnly"},"title":"Diamonds","type":"array"}},"required":["diamonds"],"title":"TransferInAcceptV2Request","type":"object"},"DiamondIDOnly":{"description":"An object which contains only a diamond_id field.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"DiamondIDOnly","type":"object"},"TransferInAcceptV2Response":{"description":"Aggregated results of accepting diamonds for transfer.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/TransferInAcceptV2DiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"TransferInAcceptV2Response","type":"object"},"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer In Accept All > Accept all the diamonds in the inbound shipment. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/accept/all":{"post":{"description":"Accept all the diamonds in the inbound shipment.","operationId":"transfer_in_accept_all_v2_transfer_in__shipment_id__accept_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferInAcceptV2Response"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Accept All","tags":["Transfer"]}}},"components":{"schemas":{"TransferInAcceptV2Response":{"description":"Aggregated results of accepting diamonds for transfer.","properties":{"results":{"description":"Results with attributed statuses.","items":{"$ref":"#/components/schemas/TransferInAcceptV2DiamondResult"},"title":"Results","type":"array"}},"required":["results"],"title":"TransferInAcceptV2Response","type":"object"},"TransferInAcceptV2DiamondResult":{"description":"The result of accepting a transfer for a single diamond.","properties":{"diamond_id":{"description":"Identifies the diamond from the request.","pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInAcceptV2Status"}},"required":["diamond_id","status"],"title":"TransferInAcceptV2DiamondResult","type":"object"},"TransferInAcceptV2Status":{"description":"Indicates that a diamond was accepted successfully or the reason why\nthe diamond could not be accepted.","enum":["success","diamond_not_found","diamond_in_incorrect_state"],"title":"TransferInAcceptV2Status","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer In Reject All > Reject inbound diamonds.\ > \ > Diamonds must not have been ACCEPTED in order to be rejected. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/transfer/in/{shipment_id}/reject/all":{"post":{"description":"Reject inbound diamonds.\n\nDiamonds must not have been ACCEPTED in order to be rejected.","operationId":"transfer_in_reject_all_v2_transfer_in__shipment_id__reject_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferInRejectDiamondResult"},"title":"Response Transfer In Reject All V2 Transfer In Shipment Id Reject All Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer In Reject All","tags":["Transfer"]}}},"components":{"schemas":{"TransferInRejectDiamondResult":{"description":"Returned by transfer/in/reject for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferInRejectStatus"}},"required":["diamond_id","status"],"title":"TransferInRejectDiamondResult","type":"object"},"TransferInRejectStatus":{"description":"Represents the result of a transfer-in-reject operation.","enum":["success","diamond_in_incorrect_state","diamond_transfer_cancelled","diamond_transfer_complete","diamond_not_found"],"title":"TransferInRejectStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer Out Start > Create a new outbound shipment for a given group of rough diamonds. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/transfer/out/start":{"post":{"description":"Create a new outbound shipment for a given group of rough diamonds.","operationId":"transfer_out_start_v2_transfer_out_start_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartResponse","anyOf":[{"$ref":"#/components/schemas/V2TransferOutStartErrorResponse"},{"$ref":"#/components/schemas/V2TransferOutStartResponse"}],"title":"Response Transfer Out Start V2 Transfer Out Start Post"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2TransferOutStartErrorResponse"}}},"description":"Returned if:\n- Sender and receiver are the same participant.\n- Outbound shipment with the same name already exists.\n- Any of the diamond IDs passed in the request does not exist in the database.\n- Any of the diamond IDs passed in the request already belong to another shipment in the database.\n- Any of the diamond IDs passed in the request are locked.\n- Any of the diamond IDs passed is for a diamond which is not ROUGH.\n- Any of the diamond IDs passed is for a POLISHED diamond which has an in-flight data request.\n- Any of the diamond IDs passed is for a diamond which is not HELD.\n- Any of the diamond IDs passed is for a diamond which has a parent.\n- Any of the diamond IDs passed is for a diamond which is archived.\n"},"409":{"description":"Returned if any of the specified diamonds are being updated as part of another process."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Start","tags":["Transfer"]}}},"components":{"schemas":{"V2TransferOutStartRequest":{"description":"V2 of TransferOutStartRequest model, with shipment_type","properties":{"diamonds":{"items":{"$ref":"#/components/schemas/PermissiveDiamondIDOnly"},"minItems":1,"title":"Diamonds","type":"array"},"receiver":{"pattern":"^https://api\\..+\\.tracr\\.com$","title":"Receiver","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"},"shipment_type":{"$ref":"#/components/schemas/ShipmentLifecycleState"}},"required":["shipment_name","receiver","shipment_type","diamonds"],"title":"V2TransferOutStartRequest","type":"object"},"PermissiveDiamondIDOnly":{"description":"An object which contains only a diamond_id field.\n\nWe use a basic str as the type here to bypass pydantic validation\nthat would normally be run for the DiamondID type.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"}},"required":["diamond_id"],"title":"PermissiveDiamondIDOnly","type":"object"},"ShipmentLifecycleState":{"description":"The different diamond lifecycle states that can be transferred (unique per\nshipment).","enum":["rough","polished"],"title":"ShipmentLifecycleState","type":"string"},"V2TransferOutStartResponse":{"description":"A response to a V2 transfer/out/start request.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"shipment_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"},"shipment_name":{"title":"Shipment Name","type":"string"}},"required":["shipment_id","shipment_name","diamonds"],"title":"V2TransferOutStartResponse","type":"object"},"TransferOutValidateMissing":{"description":"Returned by the validate_diamonds_for_transfer function for a diamond that\ndoes not exist.","properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"status":{"const":"diamond_does_not_exist","default":"diamond_does_not_exist","title":"Status","type":"string"}},"required":["diamond_id"],"title":"TransferOutValidateMissing","type":"object"},"V2TransferOutValidatePolished":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"polished","default":"polished","title":"Lifecycle State","type":"string"},"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.","title":"Participant Id"},"polished":{"$ref":"#/components/schemas/V2TransferOutPolishedFields"},"rough":{"title":"Rough","type":"null"},"status":{"$ref":"#/components/schemas/TransferOutValidatePolishedStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidatePolished","type":"object"},"V2TransferOutPolishedFields":{"properties":{"carats":{"title":"Carats","type":"number"},"clarity":{"anyOf":[{"$ref":"#/components/schemas/Clarity"},{"type":"null"}]},"colour":{"anyOf":[{"$ref":"#/components/schemas/Colour"},{"type":"null"}]},"cut_grade":{"anyOf":[{"$ref":"#/components/schemas/CutGrade"},{"type":"null"}]},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"inscription_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inscription Numbers"},"shape":{"$ref":"#/components/schemas/Shape"}},"required":["carats","shape"],"title":"V2TransferOutPolishedFields","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"},"CutGrade":{"enum":["I","EX","VG","G","F","P","NA"],"title":"CutGrade","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"},"TransferOutValidatePolishedStatus":{"description":"Represents the status of a transfer out validation request for a polished\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_has_no_inscription_numbers","diamond_is_locked","diamond_unlock_unavailable","diamond_has_in_flight_data_request"],"title":"TransferOutValidatePolishedStatus","type":"string"},"V2TransferOutValidateRough":{"properties":{"diamond_id":{"title":"Diamond Id","type":"string"},"diamond_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diamond Parent Id"},"lifecycle_state":{"const":"rough","default":"rough","title":"Lifecycle State","type":"string"},"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.","title":"Participant Id"},"polished":{"title":"Polished","type":"null"},"rough":{"$ref":"#/components/schemas/V2TransferOutRoughFields"},"status":{"$ref":"#/components/schemas/TransferOutValidateRoughStatus"}},"required":["diamond_id","diamond_parent_id","polished","rough","status"],"title":"V2TransferOutValidateRough","type":"object"},"V2TransferOutRoughFields":{"properties":{"box_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Box Id"},"carats":{"title":"Carats","type":"number"},"colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Colour"},"display_colour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Colour"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"quality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quality"},"sight_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Number"},"sight_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sight Year"},"stress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stress"}},"required":["carats"],"title":"V2TransferOutRoughFields","type":"object"},"TransferOutValidateRoughStatus":{"description":"Represents the status of a transfer out validation request for a rough\ndiamond.","enum":["success","diamond_already_pending_transfer","diamond_already_transferred","diamond_in_terminal_state","diamond_lifecycle_state_not_transferrable","diamond_is_archived","diamond_cannot_have_parent","diamond_missing_rough_scan","diamond_missing_rough_check"],"title":"TransferOutValidateRoughStatus","type":"string"},"V2TransferOutStartErrorResponse":{"description":"Returns a list of all diamonds requested in the v2 /transfer/out/start\nendpoint and their corresponding statuses.","properties":{"diamonds":{"items":{"anyOf":[{"$ref":"#/components/schemas/TransferOutValidateMissing"},{"$ref":"#/components/schemas/V2TransferOutValidatePolished"},{"$ref":"#/components/schemas/V2TransferOutValidateRough"}]},"title":"Diamonds","type":"array"},"message":{"title":"Message","type":"string"},"status":{"$ref":"#/components/schemas/V2TransferOutValidateStatus"}},"required":["diamonds","status","message"],"title":"V2TransferOutStartErrorResponse","type":"object"},"V2TransferOutValidateStatus":{"enum":["invalid","validated"],"title":"V2TransferOutValidateStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## Transfer Out Cancel All > Cancel outbound diamonds preventing them from being accepted.\ > \ > User initiated by the sender.\ > \ > Diamonds must not have been ACCEPTED in order to be cancelled. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/transfer/out/{shipment_id}/cancel/all":{"post":{"description":"Cancel outbound diamonds preventing them from being accepted.\n\nUser initiated by the sender.\n\nDiamonds must not have been ACCEPTED in order to be cancelled.","operationId":"transfer_out_cancel_all_v2_transfer_out__shipment_id__cancel_all_post","parameters":[{"description":"ID of the shipment assigned by Tracr","in":"path","name":"shipment_id","required":true,"schema":{"description":"ID of the shipment assigned by Tracr","pattern":"^[a-z\\d]{20,98}$","title":"Shipment Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TransferOutCancelDiamondResult"},"title":"Response Transfer Out Cancel All V2 Transfer Out Shipment Id Cancel All Post","type":"array"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Transfer Out Cancel All","tags":["Transfer"]}}},"components":{"schemas":{"TransferOutCancelDiamondResult":{"description":"Returned by transfer/out/cancel for each diamond.","properties":{"diamond_id":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Id","type":"string"},"status":{"$ref":"#/components/schemas/TransferOutCancelStatus"}},"required":["diamond_id","status"],"title":"TransferOutCancelDiamondResult","type":"object"},"TransferOutCancelStatus":{"description":"Represents the result of a transfer-out-cancel operation.","enum":["success","diamond_transfer_complete","diamond_transfer_rejected","diamond_not_found"],"title":"TransferOutCancelStatus","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` # Diamond Assets ## GET /v2/diamond-asset/ > Get Diamond Assets ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/":{"get":{"operationId":"get_diamond_assets_v2_diamond_asset__get","parameters":[{"description":"Filter diamond assets by a list of diamond IDs.","in":"query","name":"diamond_id__in","required":false,"schema":{"description":"Filter diamond assets by a list of diamond IDs.","title":"Diamond Id In","type":"string"}},{"description":"Filter diamond assets by a list of asset types.","in":"query","name":"asset_type__in","required":false,"schema":{"description":"Filter diamond assets by a list of asset types.","title":"Asset Type In","type":"string"}},{"description":"Filter diamond assets by hero status.","in":"query","name":"is_hero","required":false,"schema":{"description":"Filter diamond assets by hero status.","title":"Is Hero","type":"boolean"}},{"description":"Filter diamond assets by a list of diamond stages.","in":"query","name":"diamond_stage__in","required":false,"schema":{"description":"Filter diamond assets by a list of diamond stages.","title":"Diamond Stage In","type":"string"}},{"description":"Filter diamond assets by whether the stage is null or not.","in":"query","name":"diamond_stage__isnull","required":false,"schema":{"description":"Filter diamond assets by whether the stage is null or not.","title":"Diamond Stage Isnull","type":"boolean"}},{"description":"Filter diamond assets by a list of galleries.","in":"query","name":"gallery__in","required":false,"schema":{"description":"Filter diamond assets by a list of galleries.","title":"Gallery In","type":"string"}},{"description":"Filter diamond assets by whether the gallery is null or not.","in":"query","name":"gallery__isnull","required":false,"schema":{"description":"Filter diamond assets by whether the gallery is null or not.","title":"Gallery Isnull","type":"boolean"}},{"description":"Filter diamond assets created on or after this date.","in":"query","name":"created_at__gte","required":false,"schema":{"description":"Filter diamond assets created on or after this date.","format":"date-time","title":"Created At Gte","type":"string"}},{"description":"Filter diamond assets created before this date.","in":"query","name":"created_at__lt","required":false,"schema":{"description":"Filter diamond assets created before this date.","format":"date-time","title":"Created At Lt","type":"string"}},{"description":"Filter diamond assets updated on or after this date.","in":"query","name":"updated_at__gte","required":false,"schema":{"description":"Filter diamond assets updated on or after this date.","format":"date-time","title":"Updated At Gte","type":"string"}},{"description":"Filter diamond assets updated before this date.","in":"query","name":"updated_at__lt","required":false,"schema":{"description":"Filter diamond assets updated before this date.","format":"date-time","title":"Updated At Lt","type":"string"}},{"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/DiamondAssetV2ListResponse"}}},"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 Assets","tags":["Diamond Assets"]}}},"components":{"schemas":{"DiamondAssetV2ListResponse":{"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":{"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":"Results","type":"array"},"total":{"description":"The total number of results across all pages.","minimum":0,"title":"Total","type":"integer"}},"required":["page","results","total"],"title":"DiamondAssetV2ListResponse","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## POST /v2/diamond-asset/image > Create Image ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/image":{"post":{"operationId":"create_image_v2_diamond_asset_image_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiamondAssetV2ImageUpload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"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":"Response Create Image V2 Diamond Asset Image Post"}}},"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 Image","tags":["Diamond Assets"]}}},"components":{"schemas":{"DiamondAssetV2ImageUpload":{"properties":{"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"file":{"description":"The image to be uploaded.","format":"binary","title":"File","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"},"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":[{"maxLength":32,"type":"string"},{"type":"null"}],"title":"Label"}},"required":["diamond_id","file"],"title":"DiamondAssetV2ImageUpload","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","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"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## POST /v2/diamond-asset/scan > Create Scan ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/scan":{"post":{"operationId":"create_scan_v2_diamond_asset_scan_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiamondAssetV2ScanUpload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"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":"Response Create Scan V2 Diamond Asset Scan Post"}}},"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 Scan","tags":["Diamond Assets"]}}},"components":{"schemas":{"DiamondAssetV2ScanUpload":{"properties":{"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"file":{"description":"The scan to be uploaded.","format":"binary","title":"File","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"},"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":[{"maxLength":32,"type":"string"},{"type":"null"}],"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"}},"required":["diamond_id","file"],"title":"DiamondAssetV2ScanUpload","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## POST /v2/diamond-asset/scan-report > Create Scan Report ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/scan-report":{"post":{"operationId":"create_scan_report_v2_diamond_asset_scan_report_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiamondAssetV2ScanReportUpload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"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":"Response Create Scan Report V2 Diamond Asset Scan Report Post"}}},"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 Scan Report","tags":["Diamond Assets"]}}},"components":{"schemas":{"DiamondAssetV2ScanReportUpload":{"properties":{"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"file":{"description":"The scan report to be uploaded.","format":"binary","title":"File","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"},"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":[{"maxLength":32,"type":"string"},{"type":"null"}],"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"}},"required":["diamond_id","file"],"title":"DiamondAssetV2ScanReportUpload","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## POST /v2/diamond-asset/video > Create Video ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/video":{"post":{"operationId":"create_video_v2_diamond_asset_video_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DiamondAssetV2VideoUpload"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"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":"Response Create Video V2 Diamond Asset Video Post"}}},"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 Video","tags":["Diamond Assets"]}}},"components":{"schemas":{"DiamondAssetV2VideoUpload":{"properties":{"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"file":{"description":"The video to be uploaded.","format":"binary","title":"File","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"},"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":[{"maxLength":32,"type":"string"},{"type":"null"}],"title":"Label"}},"required":["diamond_id","file"],"title":"DiamondAssetV2VideoUpload","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"DiamondAssetGallery":{"description":"Galleries that a diamond asset may appear in","enum":["rough","split","polished"],"title":"DiamondAssetGallery","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","type":"string"},"ImageFileExtension":{"description":"The different image file extensions supported by Tracr.","enum":["bmp","gif","jpeg","jpg","png"],"title":"ImageFileExtension","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` ## Get Diamond Asset > Retrieve a single diamond asset by its ID. ```json {"openapi":"3.1.0","info":{"title":"Platform Application API","version":"1.35.0"},"servers":[{"description":"Live","url":"https://api..tracr.network"},{"description":"Sandbox","url":"https://api..uat.tracr.network"}],"paths":{"/v2/diamond-asset/{diamond_asset_id}":{"get":{"description":"Retrieve a single diamond asset by its ID.","operationId":"get_diamond_asset_v2_diamond_asset__diamond_asset_id__get","parameters":[{"in":"path","name":"diamond_asset_id","required":true,"schema":{"pattern":"^[a-z\\d]{20,98}$","title":"Diamond Asset Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"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":"Response Get Diamond Asset V2 Diamond Asset Diamond Asset Id Get"}}},"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 Asset","tags":["Diamond Assets"]}}},"components":{"schemas":{"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ImageFileExtensionV2"},{"$ref":"#/components/schemas/ImageFileExtension"}],"description":"The image's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ImageResponse","type":"object"},"CurrentStage":{"enum":["polished","rough"],"title":"CurrentStage","type":"string"},"ImageFileExtensionV2":{"description":"The different image file extensions supported by Tracr V2 endpoints.","enum":["avif","bmp","gif","jpeg","jpg","png","svg","webp"],"title":"ImageFileExtensionV2","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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/VideoFileExtensionV2"},{"$ref":"#/components/schemas/VideoFileExtension"}],"description":"The video's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2VideoResponse","type":"object"},"VideoFileExtensionV2":{"description":"The different video file extensions supported by Tracr V2 endpoints.","enum":["mov","mp4","mpeg","mpg"],"title":"VideoFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/ScanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The scan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2ScanResponse","type":"object"},"ScanFileExtensionV2":{"enum":["ply","stl"],"title":"ScanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"extension":{"anyOf":[{"$ref":"#/components/schemas/PlanFileExtensionV2"},{"$ref":"#/components/schemas/ScanFileExtension"}],"description":"The plan's file extension.","title":"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","content_hash","filename","extension"],"title":"DiamondAssetV2PlanResponse","type":"object"},"PlanFileExtensionV2":{"enum":["mme","ply","stl"],"title":"PlanFileExtensionV2","type":"string"},"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","grading_lab","graded_date","grader_inscription_no","content_hash","filename","extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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_content_hash","polished_three_d_plan_content_hash","rough_three_d_plan_filename","rough_three_d_plan_extension","polished_three_d_plan_filename","polished_three_d_plan_extension"],"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. diamond_stage and gallery are completely decoupled. The user is free to choose any gallery, including future galleries that aren't yet shown, for which this diamond asset should appear, regardless of the value of diamond_stage. As an example, if a user uploads two scans, diamond_stage can be used to distinguish between a rough scan and a polished scan."},"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","content_hash","filename","extension"],"title":"DiamondAssetV2SupplementaryResponse","type":"object"}}}} ``` --- [Next Page](https://docs.tracr.com/llms-full.txt/1)