{"openapi":"3.1.0","info":{"description":"API access to the Axial3D Insight Platform","title":"Insight API","version":"v7a9f7addd2a2780c92e3d866c8a5cf085919cb34"},"servers":[{"url":"https://us.staging.api.axial3d.com"}],"security":[{"BearerJWT":[]}],"tags":[{"description":"The cut options for cardiac orders","name":"Cardiac Cuts"},{"description":"The categories and items that make up the order catalogue","name":"Catalogue"},{"description":"Create, list and update delivery or invoice details","name":"Address Details"},{"description":"The titles for use in address details","name":"Titles"},{"description":"The countries for use in address details","name":"Countries"},{"description":"The genders for use in creating orders","name":"Patient Genders"},{"description":"The statuses used for orders","name":"Order Statuses"},{"description":"Create, list, update, delete orders and various other order related actions","name":"Orders"},{"description":"Operations typically for internal use, potentially restricted","name":"Internal"},{"description":"The types of orders that can be created","name":"Order Types"},{"description":"Authorization tokens","name":"Tokens"},{"description":"The materials that can be used for print models","name":"Print Materials"},{"description":"Access resources that have been made public","name":"Resources"},{"description":"Create, list, update and delete pacs details","name":"Pacs Details"}],"paths":{"/api":{"get":{"operationId":"api","responses":{"200":{"content":{"application/JSON":{"schema":{"type":"object","additionalProperties":{"type":"string"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"}},"summary":"Test that the API is available","tags":["Internal"]}},"/api/caches":{"delete":{"operationId":"clear","parameters":[{"in":"query","name":"cacheName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"tags":["Internal"]}},"/api/cardiacCuts":{"get":{"operationId":"listCutTypes","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CutType"}}}},"description":"OK"}},"summary":"List cardiac cuts","tags":["Cardiac Cuts"]}},"/api/catalogue/categories":{"get":{"operationId":"listCategories","parameters":[{"in":"query","name":"includeArchived","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"description":"OK"}},"summary":"List categories","tags":["Catalogue"]}},"/api/catalogue/items":{"get":{"operationId":"listCatalogueItems","parameters":[{"in":"query","name":"categoryId","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"key","required":false,"schema":{"type":"string"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CatalogueItem"}}}},"description":"OK"}},"summary":"List catalogue items","tags":["Catalogue"]}},"/api/catalogue/items/{itemId}":{"get":{"operationId":"getCatalogueItem","parameters":[{"in":"path","name":"itemId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueItem"}}},"description":"OK"}},"summary":"Get catalogue item","tags":["Catalogue"]},"patch":{"description":"Currently only the model filter can be updated","operationId":"updateCatalogueItem","parameters":[{"in":"path","name":"itemId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueItem"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueItem"}}},"description":"OK"}},"summary":"Update catalogue item","tags":["Internal"]}},"/api/modelFilters":{"get":{"operationId":"listFilters","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"List the filters available","tags":["Internal"]},"post":{"operationId":"createFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFilter"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFilter"}}},"description":"OK"}},"summary":"Create a new filter","tags":["Internal"]}},"/api/modelFilters/{id}":{"get":{"operationId":"getFilter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFilter"}}},"description":"OK"}},"summary":"Get the details of a specific filter","tags":["Internal"]},"patch":{"operationId":"updateFilter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFilter"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFilter"}}},"description":"OK"}},"summary":"Update the name or description of an existing filter","tags":["Internal"]}},"/api/modelFilters/{id}/test":{"post":{"operationId":"testFilter","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InferenceModel"}}}},"description":"OK"}},"summary":"Test an existing filter","tags":["Internal"]}},"/api/models":{"get":{"operationId":"listModels","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InferenceModel"}}}},"description":"OK"}},"summary":"List the models available for creating predictions","tags":["Internal"]}},"/api/models/{id}":{"get":{"operationId":"getModel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InferenceModel"}}},"description":"OK"}},"summary":"Get the details of a model available for creating predictions","tags":["Internal"]}},"/api/orderTemplates":{"get":{"operationId":"listOrderTemplates","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderTemplateDTO"}}}},"description":"OK"}},"tags":["Internal"]},"post":{"operationId":"createOrderTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTemplateDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTemplateDTO"}}},"description":"OK"}},"tags":["Internal"]}},"/api/orderTemplates/{id}":{"get":{"operationId":"getOrderTemplate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTemplateDTO"}}},"description":"OK"}},"tags":["Internal"]}},"/api/orderTypes":{"get":{"operationId":"listOrderTypes","responses":{"default":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderType"}}}},"description":"default response","links":{"CreateOrder":{"operationId":"createOrder","parameters":{"id":"$request.body.orderTypeIds"}}}}},"summary":"List the types of order","tags":["Order Types"]}},"/api/pacs/series":{"get":{"operationId":"listPacsSeries","parameters":[{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PacsSeriesSummary"}}}},"description":"OK"}},"summary":"List the series uploaded to PACS","tags":["Internal"]}},"/api/pacs/series/transfer":{"post":{"operationId":"transfer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DICOMTransferRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"}},"tags":["Internal"]}},"/api/pacs/series/{id}":{"get":{"operationId":"getSeriesDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsSeriesSummary"}}},"description":"OK"}},"summary":"Get the details of a series uploaded to PACS","tags":["Internal"]}},"/api/pacs/series/{id}/transfer":{"post":{"operationId":"transferSeries","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DICOMTransferRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"}},"tags":["Internal"]}},"/api/printMaterials":{"get":{"operationId":"listMaterials","responses":{"200":{"content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrintModelMaterial"}}}},"description":"OK"}},"summary":"List print materials","tags":["Print Materials"]}},"/api/public/{resourceId}":{"get":{"description":"Get a resource (e.g. a visual) that has been made public, may use a redirect which should be followed","operationId":"redirect","parameters":[{"in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"summary":"Get a public resource","tags":["Resources"]}},"/api/tokens":{"post":{"description":"Provide the username and password created during registration and then use the <b>idToken</b> from the response to authorize requests","operationId":"generateTokens","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightLoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTokens"}}},"description":"OK"}},"summary":"Generate tokens","tags":["Tokens"]}},"/api/v2/version":{"get":{"operationId":"version","responses":{"200":{"content":{"application/JSON":{"schema":{"type":"object","additionalProperties":{"type":"string"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"}},"summary":"Get the current application version","tags":["Internal"]}},"/api/v3/countries":{"get":{"operationId":"listCountries","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}},"description":"OK"}},"summary":"List countries","tags":["Countries"]}},"/api/v3/deliveryDetails":{"get":{"operationId":"listDeliveryDetails","parameters":[{"in":"query","name":"userId","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryDetails"}}}},"description":"OK"}},"summary":"List delivery details","tags":["Address Details"]},"post":{"operationId":"createDeliveryDetails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"description":"Delivery details created"}},"summary":"Create delivery detail","tags":["Address Details"]}},"/api/v3/deliveryDetails/{id}":{"delete":{"operationId":"delete_1","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}},"summary":"Delete a delivery detail","tags":["Address Details","Internal"]},"get":{"operationId":"getDeliveryDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"description":"OK"}},"summary":"Get delivery detail","tags":["Address Details"]},"put":{"operationId":"updateDeliveryDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetails"}}},"description":"OK"}},"summary":"Update delivery detail","tags":["Address Details"]}},"/api/v3/internalOrderStatus":{"get":{"operationId":"listInternalOrderStatuses","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightOrderStatus"}}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/invoiceDetails":{"get":{"operationId":"listInvoiceDetails","parameters":[{"in":"query","name":"userId","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceDetails"}}}},"description":"OK"}},"summary":"List invoice details","tags":["Address Details"]},"post":{"operationId":"createInvoiceDetails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetails"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetails"}}},"description":"Delivery details created"}},"summary":"Create invoice detail","tags":["Address Details"]}},"/api/v3/invoiceDetails/{id}":{"delete":{"operationId":"delete","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}},"summary":"Delete an invoice detail","tags":["Address Details","Internal"]},"get":{"operationId":"getInvoiceDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetails"}}},"description":"OK"}},"summary":"Get invoice detail","tags":["Address Details"]},"put":{"operationId":"updateInvoiceDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetails"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetails"}}},"description":"OK"}},"summary":"Update invoice detail","tags":["Address Details"]}},"/api/v3/orderDateConfiguration":{"get":{"operationId":"getOrderDateConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDateConfiguration"}}},"description":"OK"}},"summary":"Order date configuration","tags":["Internal"]},"patch":{"operationId":"updateOrderDateConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDateConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDateConfiguration"}}},"description":"OK"}},"summary":"Update Order date configuration","tags":["Internal"]}},"/api/v3/orderStatus":{"get":{"operationId":"listOrderStatuses","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightOrderStatus"}}}},"description":"OK"}},"summary":"List order statuses","tags":["Order Statuses"]}},"/api/v3/orders":{"get":{"description":"List orders with optional pagination parameters","operationId":"listOrders","parameters":[{"in":"query","name":"username","required":false,"schema":{"type":"string"}},{"in":"query","name":"usernameMatch","required":false,"schema":{"type":"string"}},{"in":"query","name":"statusId","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"orderStatusId","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"orderNumber","required":false,"schema":{"type":"string"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightOrderDTO"}}}},"description":"OK"}},"summary":"List orders","tags":["Orders"]},"post":{"description":"To create a new order, send an InsightOrderRequest with the appropriate details.  Once the order is created you can use [Assign Order](#/Orders/assignOrders) to refer the upload of images to a third party such as a PACS department, or [Generate Upload URL](#/Orders/generateUploadURL) to upload images for an order.","operationId":"createOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightOrderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightOrderRequest"}}},"description":"Order created"}},"summary":"Create an order","tags":["Orders"]}},"/api/v3/orders/{orderId}":{"delete":{"description":"Delete order by orderId","operationId":"deleteOrders","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}},"summary":"Delete an order","tags":["Orders"]},"get":{"description":"Get order information by orderId","operationId":"getOrder","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightOrderDTO"}}},"description":"OK"}},"summary":"Get an order","tags":["Orders"]},"patch":{"description":"Update order information by orderId with an appropriate InsightOrderRequest","operationId":"updateOrders","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightOrderRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Update an order","tags":["Orders"]}},"/api/v3/orders/{orderId}/assign":{"post":{"description":"Refer the upload of images for an order to a third party, eg. a PACS department","operationId":"assignOrders","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightAssignEmailRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Refer an order to somebody else","tags":["Orders"]}},"/api/v3/orders/{orderId}/copyImages":{"post":{"description":"Use the uploaded image data from another order for this order","operationId":"copyImageData","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyImageRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Copy image data","tags":["Orders"]}},"/api/v3/orders/{orderId}/deliveryLogistics":{"post":{"operationId":"saveDeliveryLogistics","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryLogisticsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom":{"get":{"description":"The details of the series that have been uploaded for an order","operationId":"listDicomSeries","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"usedForProduct","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeriesMetaDataSummaryResponse"}}},"description":"OK"}},"summary":"List DICOM series details","tags":["Orders"]},"post":{"description":"Create a new series based on a set of existing DICOMs","operationId":"createSeries","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK"}},"summary":"Create a new series","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/all":{"get":{"description":"A URL that can be used to download a zip of all DICOMs for an order","operationId":"getAllSeriesPreSignedUrl","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"OK"}},"summary":"Get presigned URL for zip of DICOMs","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}":{"get":{"description":"The details of a series that has been uploaded for an order","operationId":"getSeries","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeriesMetaDataResponse"}}},"description":"OK"}},"summary":"Get details of a DICOM series","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/instance/{instanceId}":{"get":{"description":"Returns a pre-signed URL with access to a single DICOM instance for a short period of time","operationId":"getInstance","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"}},"summary":"Get access to a single anonymized DICOM","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/instances":{"get":{"description":"Returns a list of DICOM instance ids","operationId":"getInstances","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"OK"}},"summary":"List DICOM instances","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/instances/{instanceId}":{"get":{"description":"Returns a pre-signed URL with access to a single DICOM instance for a short period of time","operationId":"getInstance_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"}},"summary":"Get access to a single anonymized DICOM","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/predictions":{"get":{"operationId":"listSegmentations","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"query","name":"prediction","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"includeExperimental","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segmentation"}}}},"description":"OK"}},"tags":["Internal"]},"post":{"operationId":"createSegmentation","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"Segmentation created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"Segmentation is being created"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/predictions/{segmentation}":{"get":{"operationId":"getSegmentation","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"OK"}},"tags":["Internal"]},"put":{"operationId":"saveSegmentation","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/predictions/{segmentation}/refineLabel":{"post":{"operationId":"refineLabel","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelRefinementRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/predictions/{segmentation}/uploadComplete":{"post":{"operationId":"uploadComplete_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/predictions/{segmentation}/zip":{"get":{"deprecated":true,"operationId":"getSegmentationZip_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/preview":{"get":{"description":"Get the preview image generated for a series of DICOMs","operationId":"getPreview","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"OK"}},"summary":"Get a preview image","tags":["Orders"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/segmentations":{"get":{"operationId":"listSegmentations_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"query","name":"prediction","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"includeExperimental","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segmentation"}}}},"description":"OK"}},"tags":["Internal"]},"post":{"operationId":"createSegmentation_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"Segmentation created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"Segmentation is being created"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/segmentations/{segmentation}":{"get":{"operationId":"getSegmentation_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segmentation"}}},"description":"OK"}},"tags":["Internal"]},"put":{"operationId":"saveSegmentation_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/segmentations/{segmentation}/refineLabel":{"post":{"operationId":"refineLabel_1","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelRefinementRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/segmentations/{segmentation}/uploadComplete":{"post":{"operationId":"uploadComplete","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/segmentations/{segmentation}/zip":{"get":{"deprecated":true,"operationId":"getSegmentationZip","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}},{"in":"path","name":"segmentation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/dicom/{seriesId}/zip":{"get":{"description":"Downloads a ZIP file of the anonymized DICOM files for a series that was uploaded","operationId":"getSeriesZip","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"seriesId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":"OK"}},"summary":"Get all the DICOMs for a series","tags":["Orders"]}},"/api/v3/orders/{orderId}/history":{"get":{"description":"Get the history of an order showing the changes in status, when it was changed and by whom","operationId":"orderHistory","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusRecordDTO"}}}},"description":"OK"}},"summary":"Get history of an order","tags":["Orders"]}},"/api/v3/orders/{orderId}/inferenceJobs":{"get":{"operationId":"getInferenceJobs","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InferenceJob"}}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshcomparisons":{"get":{"operationId":"listMeshComparisons","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"seriesId","required":false,"schema":{"type":"string"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MeshComparison"}}}},"description":"OK"}},"tags":["Internal"]},"post":{"operationId":"compare","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshComparisonRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshComparison"}}},"description":"Accepted"}},"summary":"Request the comparison of two sets of meshes.","tags":["Internal"]}},"/api/v3/orders/{orderId}/meshcomparisons/{meshcomparison}":{"get":{"operationId":"getMeshComparison","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"meshcomparison","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeshComparison"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshes":{"get":{"operationId":"listMeshes","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"seriesId","required":false,"schema":{"type":"string"}},{"in":"query","name":"format","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mesh"}}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshes/{mesh}":{"get":{"operationId":"getMesh","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"mesh","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mesh"}}},"description":"OK"}},"tags":["Internal"]},"put":{"operationId":"uploadMesh","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"mesh","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mesh"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshes/{mesh}/ambientOcclusion":{"post":{"operationId":"ambientOcclusion","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"mesh","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshes/{mesh}/boolean":{"post":{"operationId":"applyBoolean","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"mesh","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BooleanOperation"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mesh"}}},"description":"Accepted"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/meshes/{mesh}/centerlines":{"post":{"operationId":"createCenterLines","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"mesh","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/products":{"delete":{"operationId":"deleteProducts","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]},"get":{"operationId":"listProducts","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductDTO"}}}},"description":"OK"}},"summary":"List the products for an order","tags":["Orders"]},"post":{"operationId":"uploadProduct","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/products/{productId}":{"get":{"operationId":"getProduct","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"productId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDTO"}}},"description":"OK"}},"summary":"Get the details of an order product","tags":["Orders"]}},"/api/v3/orders/{orderId}/reset":{"post":{"operationId":"resetOrder","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetRequest"}}},"required":true},"responses":{"200":{"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/status":{"post":{"operationId":"updateStatus","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightOrderStatus"}}},"required":true},"responses":{"200":{"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/uploadComplete":{"post":{"description":"This should be called when all images have been uploaded for an order and the order is ready to process","operationId":"completeOrders","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}},"summary":"Complete upload for an order","tags":["Orders"]}},"/api/v3/orders/{orderId}/uploadSummary":{"get":{"operationId":"getSummary","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/uploads":{"post":{"description":"Generates a Pre-Signed URL for uploading a single DICOM file or a ZIP of multiple DICOM files, when all files are uploaded [Upload Complete](#/Orders/completeOrders) should be called","operationId":"generateUploadURL","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"filename","required":false,"schema":{"type":"string"}},{"in":"query","name":"partCount","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUpload"}}},"description":"OK"}},"summary":"Upload images for an order","tags":["Orders"]}},"/api/v3/orders/{orderId}/uploads/multipartUploadComplete":{"post":{"description":"This should be called when all parts have been uploaded for an order and the order is ready to process.","operationId":"completeMultipartOrders","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Multipart"}}},"required":true},"responses":{"204":{"description":"No Content"}},"summary":"Complete multipart upload","tags":["Orders"]}},"/api/v3/orders/{orderId}/uploads/{filename}":{"put":{"description":"Upload a single DICOM file or a ZIP file of multiple DICOM files, when all files are uploaded [Upload Complete](#/Orders/completeOrders) should be called.","operationId":"upload","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"filename","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"OK"}},"summary":"Upload images for an order","tags":["Orders"]}},"/api/v3/orders/{orderId}/visuals":{"delete":{"operationId":"deleteVisuals","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]},"get":{"description":"To download a visual use the `id` field with [Get Visual](#/Orders/getVisual) to obtain the pre-signed URL to download the visual with.","operationId":"listVisuals","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VisualDTO"}}}},"description":"OK"}},"summary":"List the visuals for an order","tags":["Orders"]},"post":{"operationId":"uploadVisual","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisualDTO"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/visuals/{visualId}":{"get":{"description":"Download the visual using the pre-signed URL provided.","operationId":"getVisual","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"visualId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisualDTO"}}},"description":"OK"}},"summary":"Get the details of a visual","tags":["Orders"]}},"/api/v3/orders/{orderId}/visuals/{visualId}/hide":{"post":{"operationId":"hideVisual","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"visualId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/orders/{orderId}/visuals/{visualId}/publish":{"post":{"operationId":"publishVisual","parameters":[{"in":"path","name":"orderId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"visualId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisualDTO"}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/pacsDetails":{"get":{"operationId":"listPacsDetails","parameters":[{"in":"query","name":"userId","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PacsDetailsDTO"}}}},"description":"OK"}},"summary":"List pacs details","tags":["Pacs Details"]},"post":{"operationId":"createPacsDetails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsDetailsDTO"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsDetailsDTO"}}},"description":"PACS details created"}},"summary":"Create pacs detail","tags":["Pacs Details"]}},"/api/v3/pacsDetails/{id}":{"delete":{"operationId":"deletePacsDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}},"summary":"Delete pacs detail","tags":["Pacs Details"]},"get":{"operationId":"getPacsDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsDetailsDTO"}}},"description":"OK"}},"summary":"Get pacs detail","tags":["Pacs Details"]},"patch":{"operationId":"updatePacsDetails","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsDetailsDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacsDetailsDTO"}}},"description":"OK"}},"summary":"Update pacs detail","tags":["Pacs Details"]}},"/api/v3/patientGenders":{"get":{"operationId":"listPatientGenders","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatientGender"}}}},"description":"OK"}},"summary":"List patient genders","tags":["Patient Genders"]}},"/api/v3/specialities":{"get":{"description":"List specialities","operationId":"listSpecialities","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Speciality"}}}},"description":"OK"}},"tags":["Internal"]}},"/api/v3/titles":{"get":{"operationId":"listTitles","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Title"}}}},"description":"OK"}},"summary":"List titles","tags":["Titles"]}},"/api/v3/userGroups":{"get":{"operationId":"listUserGroups","parameters":[{"in":"query","name":"userId","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}}}},"description":"OK"}},"summary":"List user groups","tags":["Internal"]}},"/api/v3/users":{"get":{"operationId":"listUsers","parameters":[{"in":"query","name":"username","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"lastLogin","required":false,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"approved","required":false,"schema":{"type":"boolean"}},{"description":"Page number of results","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Number of results per page","example":10,"in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Direction of results sorting","in":"query","name":"sortDir","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"Field to sort by","in":"query","name":"sortField","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"description":"OK"}},"summary":"List users","tags":["Internal"]},"post":{"operationId":"createUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"description":"User created"}},"summary":"Create user","tags":["Internal"]}},"/api/v3/users/confirm":{"post":{"operationId":"confirmUsers","parameters":[{"in":"query","name":"token","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"tags":["Internal"]}},"/api/v3/users/login":{"post":{"operationId":"login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightLoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTokens"}}},"description":"OK"}},"summary":"Perform login","tags":["Internal"]}},"/api/v3/users/reset":{"post":{"operationId":"resetPassword","parameters":[{"in":"query","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}},"summary":"Reset password","tags":["Internal"]}},"/api/v3/users/{userId}":{"delete":{"operationId":"deleteUser","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"removeOrders","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"User deleted"},"202":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"User deletion is in progress"}},"summary":"Delete user","tags":["Internal"]},"get":{"operationId":"getUsers","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}},"summary":"Get user","tags":["Internal"]},"patch":{"operationId":"updateUsers","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}},"summary":"Update user","tags":["Internal"]}},"/api/v3/users/{userId}/changePassword":{"post":{"operationId":"changePassword","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"}},"summary":"Change user password","tags":["Internal"]}},"/api/v3/users/{userId}/config":{"delete":{"operationId":"resetConfig","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}},"summary":"Reset the configuration for a user","tags":["Internal"]},"get":{"operationId":"getConfig","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"description":"OK"}},"summary":"Get configuration for user","tags":["Internal"]},"patch":{"operationId":"updateConfig","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"description":"OK"}},"summary":"Update configuration for user","tags":["Internal"]}},"/api/v3/users/{userId}/orderTemplates":{"get":{"operationId":"listUserOrderTemplates","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserOrderTemplateDTO"}}}},"description":"OK"}},"tags":["Internal"]},"post":{"operationId":"createUserOrderTemplate","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOrderTemplateDTO"}}},"required":true},"responses":{"200":{"description":"OK"}},"tags":["Internal"]}},"/api/v3/users/{userId}/orderTemplates/{id}":{"delete":{"operationId":"removeUserOrderTemplate","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}},"tags":["Internal"]}}},"components":{"schemas":{"BooleanOperation":{"type":"object","properties":{"mesh":{"type":"string","maxLength":512,"minLength":5},"operation":{"type":"string","pattern":"^diff$|^union$|^intersect$"}},"required":["mesh","operation"]},"CatalogueItem":{"type":"object","properties":{"categoryId":{"type":"integer","format":"int64"},"description":{"type":"string"},"id":{"type":"integer","format":"int64"},"imageKey":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string"}},"key":{"type":"string"},"label":{"type":"string"},"modelFilterId":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"Category":{"type":"object","properties":{"children":{"description":"The sub-categories of the category"},"id":{"type":"integer","format":"int32"},"label":{"type":"string"},"name":{"type":"string","description":"The name of the category"},"orderTemplate":{"$ref":"#/components/schemas/OrderTemplateDTO"},"priority":{"type":"integer","format":"int32"},"trauma":{"type":"boolean","description":"True if the category could contain trauma"}}},"Component":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"object"}},"component":{"type":"string"}}},"CopyImageRequest":{"type":"object","properties":{"sourceOrderId":{"type":"integer","format":"int32","description":"The id of the order to copy the images from"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the Country","readOnly":true}}},"CutLocation":{"type":"object","properties":{"cutId":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int32"},"label":{"type":"string"}}},"CutType":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"imageId":{"type":"string"},"label":{"type":"string"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/CutLocation"}}}},"DICOMTransferRequest":{"type":"object","description":"A request to transfer a DICOM series to an order","properties":{"orderId":{"type":"integer","format":"int32"},"seriesIds":{"type":"array","items":{"type":"string"}}}},"DeliveryDetails":{"type":"object","description":"Structure containing all required information for deliveries","properties":{"address1":{"type":"string","maxLength":128,"minLength":0},"address2":{"type":"string","maxLength":128,"minLength":0},"areaCode":{"type":"string","maxLength":8,"minLength":0},"city":{"type":"string","maxLength":64,"minLength":0},"country":{"$ref":"#/components/schemas/Country"},"department":{"type":"string","maxLength":64,"minLength":0},"description":{"type":"string","maxLength":64,"minLength":0},"firstName":{"type":"string","maxLength":64,"minLength":0},"id":{"type":"integer","format":"int32","readOnly":true},"institution":{"type":"string","maxLength":64,"minLength":0},"lastName":{"type":"string","maxLength":64,"minLength":0},"phoneNumber":{"type":"string","maxLength":32,"minLength":0},"postCode":{"type":"string","maxLength":16,"minLength":0},"title":{"$ref":"#/components/schemas/Title"},"userId":{"type":"integer","format":"int32"}},"required":["address1","city","country","firstName","institution","lastName","postCode","title"]},"DeliveryLogisticsRequest":{"type":"object","properties":{"courier":{"type":"string","maxLength":48,"minLength":0},"deliveryDate":{"type":"string","format":"date"},"deliveryDetailsId":{"type":"integer","format":"int32"},"invoiceDetailsId":{"type":"integer","format":"int32"},"orderNumber":{"type":"string","maxLength":32,"minLength":0},"trackingNo":{"type":"string","maxLength":32,"minLength":0}},"required":["courier","deliveryDate","orderNumber"]},"InferenceJob":{"type":"object","properties":{"creationTime":{"type":"string","format":"date-time"},"modelName":{"type":"string"},"orderNumber":{"type":"string"},"status":{"type":"string"}}},"InferenceModel":{"type":"object","properties":{"id":{"type":"string","description":"The id of the model, should be unique across all models"},"name":{"type":"string","description":"The name given to the model, i.e. Saint.format"},"type":{"type":"string","description":"The type of the model, eg. cardiac, trauma etc"},"version":{"type":"string","description":"The version of the model, eg. v1.2.3"}}},"InsightAssignEmailRequest":{"type":"object","properties":{"email":{"type":"string","maxLength":255,"minLength":0},"healthcareNumber":{"type":"string","maxLength":128,"minLength":0},"includeUserAsCc":{"type":"boolean","writeOnly":true},"scanDate":{"type":"string","deprecated":true,"maxLength":4096,"minLength":0},"scanType":{"type":"string","deprecated":true,"maxLength":64,"minLength":0},"scans":{"type":"array","items":{"$ref":"#/components/schemas/ScanRequest"}}},"required":["email","healthcareNumber"]},"InsightLoginRequest":{"type":"object","description":"Username and password for login","properties":{"password":{"type":"string","maxLength":255,"minLength":0},"username":{"type":"string","maxLength":255,"minLength":0}},"required":["password","username"]},"InsightOrderDTO":{"type":"object","properties":{"anatomicalStructures":{"type":"string","description":"Anatomical structures to include in the model","maxLength":8192,"minLength":0},"cardiacAnatomy":{"type":"string","description":"The internal anatomy that needs to be visible, used to determine which cuts to provide","maxLength":2048,"minLength":0},"cardiacCutLocations":{"type":"array","description":"A list of the cut locations as provided by [List Cardiac Cuts](#/Cardiac%20Cuts/listCutTypes) ","items":{"$ref":"#/components/schemas/CutLocation"}},"catalogueItem":{"$ref":"#/components/schemas/CatalogueItem"},"courier":{"type":"string"},"customerReference":{"type":"string"},"customisation":{"type":"string","description":"Any further variations from a standard order","maxLength":2048,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"The date the order is expected to be delivered"},"deliveryDetailsId":{"type":"integer","format":"int32"},"deliveryNoteDetailsId":{"type":"integer","format":"int32","description":"The id of the delivery address on the delivery note"},"deliveryNoteId":{"type":"string"},"dicomCount":{"type":"integer","format":"int32","description":"The number of DICOM files that are available for this order"},"displayOrderNo":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer","format":"int32"},"includeArtifacts":{"type":"integer","format":"int32","description":"1 if the artifacts should be included, 0 if not, -1 if not applicable","maximum":1,"minimum":-1},"institution":{"type":"string"},"invoiceDetailsId":{"type":"integer","format":"int32"},"meshFormat":{"type":"string","description":"The format for the produced mesh files for 3D Mesh orders"},"modelInDraft":{"type":"boolean"},"notes":{"type":"string"},"oncology":{"type":"boolean","description":"True if the order relates to images that contain invasive or abnormal cell growth"},"orderNumber":{"type":"string"},"orderStatus":{"$ref":"#/components/schemas/InternalOrderStatus"},"orderStatusUpdatedDate":{"type":"string","format":"date","description":"The date of the latest status update for the order"},"orderTypes":{"type":"array","items":{"$ref":"#/components/schemas/OrderType"}},"patientBirthYear":{"type":"integer","format":"int32"},"patientGender":{"type":"string"},"printModelMaterial":{"$ref":"#/components/schemas/PrintModelMaterialDTO","description":"The model material option selected for this order as provided by [List materials](#/Print%20Materials/listMaterials"},"printerDetails":{"type":"string","description":"Details of the printer model and/or size for 3D Print Ready orders"},"requiredDate":{"type":"string","format":"date","description":"The date the order was required for"},"sketchfabId":{"type":"string"},"startedDate":{"type":"string","format":"date","description":"The date the order was created"},"status":{"type":"string"},"statusId":{"type":"integer","format":"int32"},"surgery":{"type":"string"},"telephone":{"type":"string"},"trackingNo":{"type":"string"},"trauma":{"type":"boolean","description":"True if the order relates to images that contain injuries, e.g. fractures, dislocations etc"},"uploadCount":{"type":"integer","format":"int32","description":"The number of files that have been uploaded for this order"},"userApproved":{"type":"boolean"},"userId":{"type":"integer","format":"int32"}}},"InsightOrderRequest":{"type":"object","properties":{"anatomicalStructures":{"type":"string","description":"Anatomical structures to include in the model","maxLength":8192,"minLength":0},"cardiacAnatomy":{"type":"string","description":"The internal anatomy that needs to be visible, used to determine which cuts to provide","maxLength":2048,"minLength":0},"cardiacCutLocations":{"type":"array","description":"A list of the cut locations as provided by [List Cardiac Cuts](#/Cardiac%20Cuts/listCutTypes) ","items":{"$ref":"#/components/schemas/CutLocation"}},"catalogueItemId":{"type":"integer","format":"int64","description":"The id of a catalogue item as provided by [List Catalogue Items](#/Catalogue/listCatalogueItems)","example":17},"customerReference":{"type":"string","description":"Optional customer reference for this order","maxLength":16,"minLength":0,"pattern":"^([.a-zA-Z0-9-_/\\\\])*$"},"customisation":{"type":"string","description":"Any further variations from a standard order","maxLength":2048,"minLength":0},"deliveryDetailsId":{"type":"integer","format":"int32","description":"The id of a delivery detail as provided by [List Delivery Details](#/Address%20Details/listDeliveryDetails). If required, create one first with [Create Delivery Details](#/Address%20Details/createDeliveryDetails)"},"id":{"type":"integer","format":"int32","readOnly":true},"includeArtifacts":{"type":"integer","format":"int32","description":"1 if the artifacts should be included, 0 if not, -1 if not applicable","maximum":1,"minimum":-1},"invoiceDetailsId":{"type":"integer","format":"int32","description":"The id of an invoice detail as provided by [List Invoice Details](#/Address%20Details/listInvoiceDetails). If required, create one first with [Create Invoice Details](#/Address%20Details/createInvoiceDetails)"},"meshFormat":{"type":"string","description":"The format for the produced mesh files for 3D Mesh orders","maxLength":512,"minLength":0},"modelInDraft":{"type":"boolean"},"notes":{"type":"string","description":"Details of the 3D model customization. Please provide as much detail as possible","maxLength":8192,"minLength":0},"oncology":{"type":"boolean","description":"True if the order relates to images that contain invasive or abnormal cell growth"},"orderTypeIds":{"type":"array","description":"A list of ids of order types as provided by [List Order Types](#/Order%20Types/listOrderTypes)","example":[1],"items":{"type":"integer","format":"int64"}},"patientBirthYear":{"type":"integer","format":"int32","description":"Patient's year of birth in 4 digit format","example":2000},"patientGender":{"type":"string","description":"The name of a patient gender as provided by [List Patient Genders](#/Patient%20Genders/listPatientGenders)","example":"Female","maxLength":16,"minLength":0},"printModelMaterial":{"$ref":"#/components/schemas/PrintModelMaterialDTO","description":"The model material option selected for this order as provided by [List materials](#/Print%20Materials/listMaterials"},"printerDetails":{"type":"string","description":"Details of the printer model and/or size for 3D Print Ready orders","maxLength":512,"minLength":0},"requiredDate":{"type":"string","format":"date","description":"The date the model is required for, must allow 6 working days for a 3D print or 1 working day for other order types"},"sketchfabId":{"type":"string","description":"Sketchfab Id unique to the model","maxLength":64,"minLength":0,"pattern":"^([a-zA-Z0-9])*$"},"surgery":{"type":"string","description":"Surgery being completed & pathology","maxLength":255,"minLength":0},"trauma":{"type":"boolean","description":"True if the order relates to images that contain injuries, e.g. fractures, dislocations etc"}},"required":["patientBirthYear","patientGender"]},"InsightOrderStatus":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"InternalOrderStatus":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"label":{"type":"string"},"orderStatus":{"$ref":"#/components/schemas/OrderStatus"}}},"InvoiceDetails":{"type":"object","description":"Structure containing all required information for invoice","properties":{"address1":{"type":"string","maxLength":128,"minLength":0},"address2":{"type":"string","maxLength":128,"minLength":0},"city":{"type":"string","maxLength":64,"minLength":0},"country":{"$ref":"#/components/schemas/Country"},"department":{"type":"string","maxLength":64,"minLength":0},"description":{"type":"string","maxLength":64,"minLength":0},"email":{"type":"string","maxLength":255,"minLength":0},"id":{"type":"integer","format":"int32","readOnly":true},"institution":{"type":"string","maxLength":64,"minLength":0},"name":{"type":"string","maxLength":64,"minLength":0},"position":{"type":"string","maxLength":64,"minLength":0},"postCode":{"type":"string","maxLength":16,"minLength":0},"telephone":{"type":"string","maxLength":32,"minLength":0},"userId":{"type":"integer","format":"int32"}},"required":["address1","address2","city","country","department","description","email","institution","name","position","postCode","telephone"]},"LabelRefinementRequest":{"type":"object","properties":{"functions":{"type":"array","items":{"$ref":"#/components/schemas/RefinementFunction"},"maxItems":5,"minItems":1},"label":{"type":"string"}},"required":["label"]},"Mesh":{"type":"object","description":"A representation of a 3D mesh file","properties":{"format":{"type":"string","description":"The format of the mesh file"},"lastModified":{"type":"integer","format":"int64","description":"The last modified time as a Unix timestamp"},"name":{"type":"string","description":"The name of the mesh file"},"preSignedUrl":{"type":"string","description":"A pre-signed URL for downloading the Mesh, accessible for 10 seconds"},"size":{"type":"integer","format":"int64","description":"The size of the mesh file in bytes"}}},"MeshComparison":{"type":"object","description":"A representation of a comparison of 2 3D mesh files","properties":{"id":{"type":"string"},"imagePreSignedUrls":{"type":"object","additionalProperties":{"type":"string"}},"lastModified":{"type":"integer","format":"int64","description":"The last modified time as a Unix timestamp"},"preSignedUrl":{"type":"string","description":"A pre-signed URL for downloading the Mesh, accessible for 10 seconds"},"size":{"type":"integer","format":"int64","description":"The size of the mesh file in bytes"}}},"MeshComparisonRequest":{"type":"object","description":"A request to compare multiple 3D mesh files","properties":{"comparisons":{"type":"array","items":{"type":"string"},"maxItems":5,"minItems":1},"id":{"type":"string","readOnly":true},"references":{"type":"array","items":{"type":"string"},"maxItems":5,"minItems":1},"threshold":{"type":"number"}}},"ModelFilter":{"type":"object","properties":{"description":{"type":"string","maxLength":512,"minLength":0},"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","maxLength":128,"minLength":0},"regex":{"type":"string","maxLength":255,"minLength":0}},"required":["name","regex"]},"ModelLabel":{"type":"object","properties":{"colour":{"type":"array","items":{"type":"integer","format":"int32"},"maxItems":3,"minItems":0,"readOnly":true},"hexColour":{"type":"string","maxLength":8,"minLength":0},"label":{"type":"string","maxLength":64,"minLength":0},"value":{"type":"integer","format":"int32"}}},"Multipart":{"type":"object","properties":{"etags":{"type":"object","additionalProperties":{"type":"string"}},"key":{"type":"string","maxLength":128,"minLength":1},"uploadId":{"type":"string","maxLength":4096,"minLength":1}},"required":["key","uploadId"]},"OrderDateConfiguration":{"type":"object","properties":{"daysRequiredForPrint":{"type":"integer","format":"int32"},"daysRequiredForVisual":{"type":"integer","format":"int32"},"endOfDayHour":{"type":"integer","format":"int32"},"unavailableDates":{"type":"array","items":{"type":"string"}},"unavailableDaysOfWeek":{"type":"array","items":{"type":"integer","format":"int32"}}}},"OrderSectionDTO":{"type":"object","properties":{"components":{"type":"array","items":{"$ref":"#/components/schemas/Component"}},"conditions":{"type":"object","additionalProperties":{"type":"boolean"}},"title":{"type":"string"}}},"OrderStatus":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"OrderStatusRecordDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"internalStatusId":{"type":"integer","format":"int32"},"orderId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"},"updatedBy":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}}},"OrderTemplateDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/OrderSectionDTO"}}}},"OrderType":{"type":"object","properties":{"description":{"type":"string"},"estimate":{"type":"string"},"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"name":{"type":"string"},"notes":{"type":"string"},"strapLine":{"type":"string"}}},"OrderUpload":{"type":"object","properties":{"location":{"type":"string","format":"url"},"locationMap":{"type":"object","additionalProperties":{"type":"string","format":"url"}},"uploadId":{"type":"string"}}},"PacsDetailsDTO":{"type":"object","properties":{"email":{"type":"string","maxLength":255,"minLength":0},"id":{"type":"integer","format":"int32","readOnly":true},"label":{"type":"string","maxLength":255,"minLength":0,"pattern":"^(?!.*([a-zA-Z0-9.!#$%&\"'*+-\\/=?^_`{|}~]{1}@[a-zA-Z0-9-]+[.]{1}[a-zA-Z]+(.)+)).*$"},"userId":{"type":"integer","format":"int32"}},"required":["email"]},"PacsSeriesSummary":{"type":"object","description":"Selected fields from the DICOM series uploaded to PACS","properties":{"institutionName":{"type":"string"},"lastModified":{"type":"integer","format":"int64"},"modality":{"type":"string"},"patientBirthYear":{"type":"string"},"patientSex":{"type":"string"},"seriesDescription":{"type":"string"},"seriesInstanceUID":{"type":"string"},"studyDescription":{"type":"string"},"studyInstanceUID":{"type":"string"}}},"PasswordUpdate":{"type":"object","description":"Used to update passwords. Contains the current and new passwords","properties":{"currentPassword":{"type":"string","maxLength":255,"minLength":0},"newPassword":{"type":"string","pattern":"^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&]).{8,255}$"}}},"PatientGender":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"PrintModelMaterial":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"integer","format":"int32"},"title":{"type":"string"}}},"PrintModelMaterialDTO":{"type":"object","properties":{"description":{"type":"string","readOnly":true},"id":{"type":"integer","format":"int32"},"title":{"type":"string","readOnly":true}}},"ProductDTO":{"type":"object","properties":{"contentLength":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastModified":{"type":"integer","format":"int64"},"preSignedHeaders":{"type":"object","additionalProperties":{"type":"string"}},"preSignedUrl":{"type":"string"}}},"RefinementFunction":{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"type":"object"}},"name":{"type":"string"}},"required":["name"]},"ResetRequest":{"type":"object","properties":{"endTime":{"type":"integer","format":"int64"},"startTime":{"type":"integer","format":"int64"}}},"ScanRequest":{"type":"object","properties":{"modality":{"type":"string","maxLength":64,"minLength":0},"notes":{"type":"string","maxLength":8192,"minLength":0},"scanDate":{"type":"string","format":"date-time"}},"required":["modality","scanDate"]},"Segmentation":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/SegmentationDetails"},"name":{"type":"string"},"orderNumber":{"type":"string"},"preSignedHeaders":{"type":"object","additionalProperties":{"type":"string"}},"preSignedUrl":{"type":"string"},"prediction":{"type":"boolean"},"seriesId":{"type":"string"},"seriesName":{"type":"string"},"size":{"type":"integer","format":"int64"},"source":{"type":"string"}}},"SegmentationDetails":{"type":"object","properties":{"labelSchema":{"type":"string"},"labels":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ModelLabel"}},"modelName":{"type":"string"},"modelType":{"type":"string"},"predictionConfidence":{"type":"number"}}},"SegmentationRequest":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/ModelLabel"},"maxItems":80,"minItems":0},"maxInstanceNumber":{"type":"integer","format":"int32"},"method":{"type":"string","pattern":"^sagemaker$|^mlinference$"},"minInstanceNumber":{"type":"integer","format":"int32"},"model":{"type":"string","maxLength":128,"minLength":0},"usePrediction":{"type":"boolean"}},"required":["model"]},"SeriesMetaDataResponse":{"type":"object","properties":{"isMultiFrame":{"type":"boolean"},"middleInstance":{"type":"string"},"modality":{"type":"string"},"nominalPercentageOfCardiacPhase":{"type":"number","format":"float"},"patientBirthYear":{"type":"string"},"patientGender":{"type":"string"},"pixelDataSize":{"type":"integer","format":"int32"},"pixelSpacing":{"type":"number","format":"float"},"preSignedUrl":{"type":"string"},"seriesDate":{"type":"string"},"seriesDateTimestamp":{"type":"integer","format":"int64"},"seriesDescription":{"type":"string"},"seriesId":{"type":"string"},"seriesLength":{"type":"integer","format":"int32"},"seriesName":{"type":"string"},"seriesNumber":{"type":"integer","format":"int32"},"sliceSpacing":{"type":"number","format":"float"},"usedForProduct":{"type":"boolean"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"SeriesMetaDataSummaryResponse":{"type":"object","properties":{"seriesMetaData":{"type":"array","items":{"$ref":"#/components/schemas/SeriesMetaDataResponse"}},"totalDicoms":{"type":"integer","format":"int32"},"totalUploadedFiles":{"type":"integer","format":"int32"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"Speciality":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the speciality","readOnly":true}}},"Title":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","readOnly":true}}},"User":{"type":"object","description":"Object that contains all user information","properties":{"admin":{"type":"boolean","readOnly":true},"approved":{"type":"boolean"},"approvedByUserId":{"type":"integer","format":"int32","description":"The id of the user who approved this user in Insight","readOnly":true},"approvedDate":{"type":"string","format":"date-time","description":"The date the user was approved in Insight","readOnly":true},"country":{"$ref":"#/components/schemas/Country"},"firstName":{"type":"string","maxLength":64,"minLength":0},"id":{"type":"integer","format":"int32","readOnly":true},"institution":{"type":"string","maxLength":64,"minLength":0},"lastLogin":{"type":"string","format":"date-time","description":"The date the user was last successfully logged in","readOnly":true},"lastName":{"type":"string","maxLength":64,"minLength":0},"password":{"type":"string","maxLength":255,"minLength":0,"writeOnly":true},"privateSector":{"type":"boolean"},"registeredDate":{"type":"string","format":"date-time","description":"The date the user was registered in Insight","readOnly":true},"registrationComplete":{"type":"boolean"},"speciality":{"$ref":"#/components/schemas/Speciality"},"subscribe":{"type":"boolean"},"telephone":{"type":"string"},"termsOfUseVersion":{"type":"string","description":"The version of the Terms Of Use accepted as part of this registration","maxLength":64,"minLength":0},"title":{"$ref":"#/components/schemas/Title"},"username":{"type":"string"}},"required":["country","firstName","lastName","title","username"]},"UserGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"UserOrderTemplateDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The id of this template","readOnly":true},"initialValues":{"$ref":"#/components/schemas/InsightOrderRequest","description":"The initial values to use with this template"},"label":{"type":"string","description":"The name of the order template","maxLength":64,"minLength":0},"orderTemplateId":{"type":"integer","format":"int32","description":"The order template to use","minimum":1},"userId":{"type":"integer","format":"int32","description":"The user this order template should be associated with","readOnly":true}},"required":["label","orderTemplateId"]},"UserRequest":{"type":"object","description":"Object that contains user information","properties":{"admin":{"type":"boolean","readOnly":true},"approved":{"type":"boolean"},"country":{"$ref":"#/components/schemas/Country"},"firstName":{"type":"string","maxLength":64,"minLength":0},"id":{"type":"integer","format":"int32","readOnly":true},"institution":{"type":"string","maxLength":64,"minLength":0},"lastLogin":{"type":"string","format":"date-time","description":"The date the user was last successfully logged in","readOnly":true},"lastName":{"type":"string","maxLength":64,"minLength":0},"password":{"type":"string","maxLength":255,"minLength":0,"writeOnly":true},"privateSector":{"type":"boolean"},"registeredDate":{"type":"string","format":"date-time","description":"The date the user was registered in Insight","readOnly":true},"speciality":{"$ref":"#/components/schemas/Speciality"},"subscribe":{"type":"boolean"},"telephone":{"type":"string","maxLength":32,"minLength":0,"pattern":"^([+]{1}[0-9]{1,3}[-. ]?)?([(]{1}[+]?[0-9]{1,4}[)]{1})?([-. ]?[0-9]){7,15}([ ]{1}((ext|ex)[. ]?)[0-9]{1,6})?$"},"termsOfUseVersion":{"type":"string","description":"The version of the Terms Of Use accepted as part of this registration","maxLength":64,"minLength":0},"title":{"$ref":"#/components/schemas/Title"},"username":{"type":"string"}},"required":["country","firstName","lastName","title","username"]},"UserTokens":{"type":"object","properties":{"accessToken":{"type":"string"},"idToken":{"type":"string"},"refreshToken":{"type":"string"},"userId":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"level":{"type":"string"},"message":{"type":"string"}}},"VisualDTO":{"type":"object","properties":{"contentLength":{"type":"integer","format":"int64"},"id":{"type":"string"},"lastModified":{"type":"integer","format":"int64"},"preSignedHeaders":{"type":"object","additionalProperties":{"type":"string"}},"preSignedUrl":{"type":"string"},"publicUrl":{"type":"string"}}}},"securitySchemes":{"BearerJWT":{"bearerFormat":"JWT","description":"A JSON Web Token included in the Authorization header of the request","scheme":"bearer","type":"http"}}}}