> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/api-reference/tracr-api/references/diamond-assets.md). # 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"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tracr.com/api-reference/tracr-api/references/diamond-assets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.