{ "components": { "schemas": { "AssuranceLevel": { "description": "Represents the assurance level for a diamond.", "enum": [ "assured", "declared" ], "title": "AssuranceLevel", "type": "string" }, "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" }, "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" }, "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" }, "DiamondAssetGallery": { "description": "Galleries that a diamond asset may appear in", "enum": [ "rough", "split", "polished" ], "title": "DiamondAssetGallery", "type": "string" }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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." }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2ImageResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "grading_lab", "graded_date", "grader_inscription_no", "content_hash" ], "title": "DiamondAssetV2InscriptionNumberResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2PlanReportResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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." }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2PlanResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2ScanReportResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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." }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2ScanResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2SupplementaryResponse", "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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_filename", "rough_three_d_plan_extension", "polished_three_d_plan_filename", "polished_three_d_plan_extension", "rough_three_d_plan_content_hash", "polished_three_d_plan_content_hash" ], "title": "DiamondAssetV2ThreeDPlanResponse", "type": "object" }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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." }, "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.", "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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", "filename", "extension", "content_hash" ], "title": "DiamondAssetV2VideoResponse", "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" }, "EnrichedTraceabilityReadView": { "description": "Detailed data of a diamond.", "properties": { "assets": { "items": { "anyOf": [ { "$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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "title": "Diamond Id", "type": "string" }, "diamond_parent_id": { "anyOf": [ { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "type": "string" }, { "type": "null" } ], "title": "Diamond Parent Id" }, "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" }, "ErrorResponse": { "properties": { "detail": { "title": "Detail", "type": "string" } }, "required": [ "detail" ], "title": "ErrorResponse", "type": "object" }, "FancyColour": { "enum": [ "BK", "B", "BN", "CH", "CM", "CG", "GY", "G", "O", "P", "PL", "R", "V", "Y", "W", "X" ], "title": "FancyColour", "type": "string" }, "FancyColourIntensity": { "enum": [ "F", "VL", "L", "FL", "FC", "FCD", "I", "FV", "D" ], "title": "FancyColourIntensity", "type": "string" }, "FileRef": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the file", "title": "Description" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original filename submitted for the file", "title": "Filename" }, "hash": { "description": "The cryptographic hash of the file stored in the platform", "title": "Hash", "type": "string" } }, "required": [ "hash" ], "title": "FileRef", "type": "object" }, "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" }, "GradedMeasurementSource": { "description": "The source of graded measurement data.", "enum": [ "gis", "user" ], "title": "GradedMeasurementSource", "type": "string" }, "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" }, "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" }, "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" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "ImageFileExtension": { "description": "The different image file extensions supported by Tracr.", "enum": [ "bmp", "gif", "jpeg", "jpg", "png" ], "title": "ImageFileExtension", "type": "string" }, "ImageRef": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the file", "title": "Description" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original filename submitted for the file", "title": "Filename" }, "hash": { "description": "The cryptographic hash of the file stored in the platform", "title": "Hash", "type": "string" }, "image_type": { "$ref": "#/components/schemas/ImageType", "default": "default", "description": "Image type" } }, "required": [ "hash" ], "title": "ImageRef", "type": "object" }, "ImageType": { "enum": [ "default", "3d", "b2b", "heart", "arrow", "aset_scope", "plot", "face_up", "dark_field", "ideal_scope", "fluorescence", "inclusion_map", "diagram", "other" ], "title": "ImageType", "type": "string" }, "LifecycleState": { "enum": [ "destroyed", "polished", "rough", "split" ], "title": "LifecycleState", "type": "string" }, "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" }, "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.0, "type": "integer" }, { "type": "null" } ], "description": "The number of the current page.", "title": "Page" }, "pages": { "anyOf": [ { "minimum": 0.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.0, "title": "Total", "type": "integer" } }, "required": [ "page", "results", "total" ], "title": "Paginator[Annotated[Union[UnlockedDiamondSearchResult, RestrictedDiamondSearchResult], FieldInfo(annotation=NoneType, required=True, discriminator='kind')]]", "type": "object" }, "Paginator_CrossIdDiamondSearchResult_": { "properties": { "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL for the next page.", "title": "Next" }, "page": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "description": "The number of the current page.", "title": "Page" }, "pages": { "anyOf": [ { "minimum": 0.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.0, "title": "Total", "type": "integer" } }, "required": [ "page", "results", "total" ], "title": "Paginator[CrossIdDiamondSearchResult]", "type": "object" }, "PlanRef": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the file", "title": "Description" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original filename submitted for the file", "title": "Filename" }, "hash": { "description": "The cryptographic hash of the file stored in the platform", "title": "Hash", "type": "string" }, "plan_software_manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Software company name", "title": "Plan Software Manufacturer" }, "plan_software_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Software name", "title": "Plan Software Name" }, "plan_software_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Software version", "title": "Plan Software Version" }, "scan_device_manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer of the device eg. Sarine, Octonus", "title": "Scan Device Manufacturer" }, "scan_device_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model of the machine eg. Diaexpert, Galaxy, Helium Rough", "title": "Scan Device Model" } }, "required": [ "hash" ], "title": "PlanRef", "type": "object" }, "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" }, "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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "title": "Diamond Id", "type": "string" }, "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" }, "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" }, "ScanRef": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the file", "title": "Description" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original filename submitted for the file", "title": "Filename" }, "hash": { "description": "The cryptographic hash of the file stored in the platform", "title": "Hash", "type": "string" }, "scan_device_manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer of the device eg. Sarine, Octonus", "title": "Scan Device Manufacturer" }, "scan_device_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Model of the machine eg. Diaexpert, Galaxy, Helium Rough", "title": "Scan Device Model" }, "scan_software_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the software used to create the report", "title": "Scan Software Name" }, "scan_software_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Version of the software used to create the report", "title": "Scan Software Version" } }, "required": [ "hash" ], "title": "ScanRef", "type": "object" }, "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" }, "SilhouetteRef": { "additionalProperties": false, "deprecated": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the file", "title": "Description" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The original filename submitted for the file", "title": "Filename" }, "hash": { "description": "The cryptographic hash of the file stored in the platform", "title": "Hash", "type": "string" }, "image_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" }, "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" }, "Symmetry": { "enum": [ "I", "EX", "VG-EX", "VG", "G-VG", "G", "F-G", "F", "P" ], "title": "Symmetry", "type": "string" }, "TraceabilityAncestryFilterDiamond": { "description": "Diamond level filters for traceability ancestry requests.", "properties": { "diamond_id": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "title": "Diamond Id", "type": "string" } }, "required": [ "diamond_id" ], "title": "TraceabilityAncestryFilterDiamond", "type": "object" }, "TraceabilityAncestryParticipantFilter": { "description": "Participant level filters for traceability ancestry requests.", "properties": { "diamonds": { "items": { "$ref": "#/components/schemas/TraceabilityAncestryFilterDiamond" }, "title": "Diamonds", "type": "array" }, "modified_since": { "anyOf": [ { "description": "An ISO 8601 compliant timestamp.", "examples": [ "1970-01-01T00:00:00", "1970-01-01T00:00:00+00:00", "1970-01-01T00:00:00Z", "1970-01-01T00:00:00+00", "1970-01-01T01:00:00+01:00" ], "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Modified Since" }, "platform_id": { "format": "uuid", "title": "Platform Id", "type": "string" } }, "required": [ "diamonds", "platform_id" ], "title": "TraceabilityAncestryParticipantFilter", "type": "object" }, "TraceabilityAncestryRequest": { "description": "Represents a request to the /diamonds/traceability-ancestry endpoint.", "properties": { "data": { "items": { "$ref": "#/components/schemas/TraceabilityAncestryParticipantFilter" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "TraceabilityAncestryRequest", "type": "object" }, "TraceabilityAncestryResponse": { "description": "Represents a response from the /diamonds/traceability-ancestry endpoint.", "properties": { "results": { "items": { "$ref": "#/components/schemas/TraceabilityAncestryResult" }, "title": "Results", "type": "array" } }, "required": [ "results" ], "title": "TraceabilityAncestryResponse", "type": "object" }, "TraceabilityAncestryResult": { "anyOf": [ { "$ref": "#/components/schemas/TraceabilityAncestryResultSuccess" }, { "$ref": "#/components/schemas/TraceabilityAncestryResultError" } ] }, "TraceabilityAncestryResultError": { "description": "An unsuccessful traceability ancestry result with an error message.", "properties": { "error": { "title": "Error", "type": "string" }, "platform_id": { "format": "uuid", "title": "Platform Id", "type": "string" }, "status": { "$ref": "#/components/schemas/TraceabilityAncestryResultStatus" } }, "required": [ "status", "platform_id", "error" ], "title": "TraceabilityAncestryResultError", "type": "object" }, "TraceabilityAncestryResultStatus": { "description": "Per participant statuses for results from the traceability ancestry endpoint.", "enum": [ "success", "not_found", "unauthorised", "unknown_error" ], "title": "TraceabilityAncestryResultStatus", "type": "string" }, "TraceabilityAncestryResultSuccess": { "description": "A successful traceability ancestry result containing diamonds with ancestry.", "properties": { "diamonds": { "patternProperties": { "^[a-z\\d]{20,98}$": { "items": { "$ref": "#/components/schemas/EnrichedTraceabilityReadView" }, "type": "array" } }, "propertyNames": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ] }, "title": "Diamonds", "type": "object" }, "platform_id": { "format": "uuid", "title": "Platform Id", "type": "string" }, "status": { "$ref": "#/components/schemas/TraceabilityAncestryResultStatus" } }, "required": [ "status", "platform_id", "diamonds" ], "title": "TraceabilityAncestryResultSuccess", "type": "object" }, "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" }, "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" }, "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" }, "TypedTraceabilityAncestryResponse": { "description": "Represents a response from the /diamonds/traceability-ancestry endpoint.", "properties": { "results": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TraceabilityAncestryResultSuccess" }, { "$ref": "#/components/schemas/TraceabilityAncestryResultError" } ] }, "title": "Results", "type": "array" } }, "required": [ "results" ], "title": "TypedTraceabilityAncestryResponse", "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" }, "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" }, "ValidationLevel": { "enum": [ "validation", "verification" ], "title": "ValidationLevel", "type": "string" }, "VideoFileExtension": { "description": "The different image file extensions supported by Tracr.", "enum": [ "avi", "mov", "mp4", "mpeg", "mpg" ], "title": "VideoFileExtension", "type": "string" }, "tracr__shared__utils__diamond_asset__CurrentStage": { "enum": [ "polished", "rough" ], "title": "CurrentStage", "type": "string" }, "tracr__shared__utils__openapi__CurrentStage": { "enum": [ "bruting", "planning", "polished", "polishing", "rough", "sawing" ], "title": "CurrentStage", "type": "string" } }, "securitySchemes": { "Auth0JWTAuth": { "scheme": "bearer", "type": "http" }, "OptionalAuth0JWTAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "A centralized API for searching the entire Tracr network for a diamond.", "title": "Cross-participant Search API", "version": "development" }, "openapi": "3.1.0", "paths": { "/v1/bulk/traceability-ancestry": { "post": { "description": "Get traceability ancestry for multiple diamonds from many peers.", "operationId": "get_traceability_ancestry_v1_bulk_traceability_ancestry_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceabilityAncestryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": [ { "results": [ { "diamonds": { "gle1nmqwo6ahrahkr75q8cz5": [ { "assurance_level": "assured", "current_stage": "rough", "diamond_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "split", "polished": {}, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 2.16, "images": [ { "description": "Split Image", "filename": "split.jpeg", "hash": "cf02abefba1b4837b35f45b7f578251046b3bb100d129ff5adc77342d7e0f8a9", "image_type": "default" } ] } }, { "assurance_level": "assured", "current_stage": "polished", "diamond_id": "gle1nmqwo6ahrahkr75q8cz5", "diamond_parent_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "polished", "polished": { "carats": 1.01, "clarity": "SI1", "colour": "F", "cut_grade": "EX", "grading_certificates": [ { "filename": "round_certificate.pdf", "graded_date": "2024-06-04", "grader_certificate_no": "2141438167", "grader_inscription_no": "GIA 2141438167", "grading_lab": "GIA", "hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50" } ], "images": [ { "description": "Polished Image", "filename": "round.jpeg", "hash": "a4a73edbaeab96246671212ebecf7c31ea39aacb182a4ef8ba0b7955d2a02a07", "image_type": "default" } ], "shape": "Round", "videos": [ { "description": "Polished 360 video", "filename": "polished_video.mp4", "hash": "dc897a179788e760b29497dd8ebfeb25051dd961f949e210203a5ae4e15b3dab" } ] }, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 1.52, "images": [ { "description": "Rough Image", "filename": "rough_1.jpeg", "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986", "image_type": "default" } ] } } ], "szgunlsompj206kpu0f9qq3u": [ { "assurance_level": "assured", "current_stage": "rough", "diamond_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "split", "polished": {}, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 2.16, "images": [ { "description": "Split Image", "filename": "split.jpeg", "hash": "cf02abefba1b4837b35f45b7f578251046b3bb100d129ff5adc77342d7e0f8a9", "image_type": "default" } ] } }, { "assurance_level": "assured", "current_stage": "polished", "diamond_id": "szgunlsompj206kpu0f9qq3u", "diamond_parent_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "polished", "polished": { "carats": 0.31, "clarity": "VVS1", "colour": "L", "cut_grade": "EX", "grading_certificates": [ { "filename": "pear_certificate.pdf", "graded_date": "2024-06-04", "grader_certificate_no": "1234567891", "grader_inscription_no": "GIA 1234567891", "grading_lab": "GIA", "hash": "43ede9ecfbed7bbda072a39965e2ae16ede79805ff8f8ec27f4b3c9615e998f7" } ], "images": [ { "description": "Polished Image", "filename": "pear.jpeg", "hash": "89057e6aa26617133752b523d0752159ad534fc0e984ad064dc65bd6bf991cfb", "image_type": "default" } ], "shape": "Pear" }, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 0.64, "images": [ { "description": "Rough Image", "filename": "rough_2.jpeg", "hash": "5746c01245be9d70becb6d5737e0d9e4caf5f8923d4d9da69586874f53d0de52", "image_type": "default" } ] } } ] }, "platform_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "status": "success" }, { "diamonds": { "hyti8zbqeq2e2vw11ijy7g0e": [ { "assurance_level": "assured", "current_stage": "polished", "diamond_id": "hyti8zbqeq2e2vw11ijy7g0e", "lifecycle_state": "polished", "polished": { "carats": 1.34, "clarity": "SI2", "colour": "N", "cut_grade": "F", "shape": "Baguette" }, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 1.89 } } ] }, "platform_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", "status": "success" } ] } ], "schema": { "$ref": "#/components/schemas/TypedTraceabilityAncestryResponse" } } }, "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" } }, "security": [ { "Auth0JWTAuth": [] } ], "summary": "Get Traceability Ancestry", "tags": [ "Tracr XPS API v1", "Bulk Diamond Search" ] } }, "/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" } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamonds", "tags": [ "Tracr XPS API v1", "Diamond Search" ] } }, "/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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "title": "Diamond Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": [ { "assurance_level": "assured", "current_stage": "polished", "diamond_id": "gle1nmqwo6ahrahkr75q8cz5", "diamond_parent_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "polished", "polished": { "carats": 1.01, "clarity": "SI1", "colour": "F", "cut_grade": "EX", "grading_certificates": [ { "filename": "round_certificate.pdf", "graded_date": "2024-06-04", "grader_certificate_no": "2141438167", "grader_inscription_no": "GIA 2141438167", "grading_lab": "GIA", "hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50" } ], "images": [ { "description": "Polished Image", "filename": "round.jpeg", "hash": "a4a73edbaeab96246671212ebecf7c31ea39aacb182a4ef8ba0b7955d2a02a07", "image_type": "default" } ], "shape": "Round", "videos": [ { "description": "Polished 360 video", "filename": "polished_video.mp4", "hash": "dc897a179788e760b29497dd8ebfeb25051dd961f949e210203a5ae4e15b3dab" } ] }, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 1.52, "images": [ { "description": "Rough Image", "filename": "rough_1.jpeg", "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986", "image_type": "default" } ] }, "unlock_status": "unlocked" } ], "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" } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamond", "tags": [ "Tracr XPS API v1", "Diamond Search" ] } }, "/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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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." } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamond File", "tags": [ "Tracr XPS API v1" ] } }, "/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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "pattern": "^[a-z\\d]{20,98}$", "title": "Diamond Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": [ { "content": { "current": { "assurance_level": "assured", "current_stage": "polished", "diamond_id": "gle1nmqwo6ahrahkr75q8cz5", "diamond_parent_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "polished", "polished": { "carats": 1.01, "clarity": "SI1", "colour": "F", "cut_grade": "EX", "grading_certificates": [ { "filename": "round_certificate.pdf", "graded_date": "2024-06-04", "grader_certificate_no": "2141438167", "grader_inscription_no": "GIA 2141438167", "grading_lab": "GIA", "hash": "84de6762dcebfc18dd385389fa5831ec25286fc4fee2e2c0279474d57ceb4a50" } ], "images": [ { "description": "Polished Image", "filename": "round.jpeg", "hash": "a4a73edbaeab96246671212ebecf7c31ea39aacb182a4ef8ba0b7955d2a02a07", "image_type": "default" } ], "shape": "Round", "videos": [ { "description": "Polished 360 video", "filename": "polished_video.mp4", "hash": "dc897a179788e760b29497dd8ebfeb25051dd961f949e210203a5ae4e15b3dab" } ] }, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 1.52, "images": [ { "description": "Rough Image", "filename": "rough_1.jpeg", "hash": "219fe6f8cdc6f32091b310f6c6f5864f4fef97443cb8954a1d64bc9f26731986", "image_type": "default" } ] } }, "y4r3v9549yiyqptelg0049fn": { "assurance_level": "assured", "current_stage": "rough", "diamond_id": "y4r3v9549yiyqptelg0049fn", "lifecycle_state": "split", "polished": {}, "producer_uuid": "952e8987-9e49-437b-824c-5c9a77ce7eee", "provenance": { "provenance_name": "DTC", "provenance_type": "Entity" }, "rough": { "carats": 2.16, "images": [ { "description": "Split Image", "filename": "split.jpeg", "hash": "cf02abefba1b4837b35f45b7f578251046b3bb100d129ff5adc77342d7e0f8a9", "image_type": "default" } ] } } } } ], "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" } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamond History", "tags": [ "Tracr XPS API v1", "Diamond Search" ] } }, "/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" } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamonds V2", "tags": [ "Tracr XPS API v2", "Diamond Search" ] } }, "/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": { "examples": [ "e1mv3nn4n10kd1lw6mde6sums", "0jeopv41zx1bjh78tbbp47xve", "36o1uc84hd24ek2ooeg4zngh0" ], "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" } }, "security": [ { "OptionalAuth0JWTAuth": [] } ], "summary": "Get Diamond History V2", "tags": [ "Tracr XPS API v2", "Diamond Search" ] } } } }