openapi: 3.0.3 info: title: grand-challenge.org API version: 1.0.0 description: The API for grand-challenge.org. termsOfService: https://grand-challenge.org/policies/terms-of-service/ license: name: Apache License 2.0 paths: /api/schema/: get: operationId: api_schema_retrieve description: |- OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json parameters: - in: query name: format schema: type: string enum: - json - yaml - in: query name: lang schema: type: string enum: - af - ar - ar-dz - ast - az - be - bg - bn - br - bs - ca - ckb - cs - cy - da - de - dsb - el - en - en-au - en-gb - eo - es - es-ar - es-co - es-mx - es-ni - es-ve - et - eu - fa - fi - fr - fy - ga - gd - gl - he - hi - hr - hsb - hu - hy - ia - id - ig - io - is - it - ja - ka - kab - kk - km - kn - ko - ky - lb - lt - lv - mk - ml - mn - mr - ms - my - nb - ne - nl - nn - os - pa - pl - pt - pt-br - ro - ru - sk - sl - sq - sr - sr-latn - sv - sw - ta - te - tg - th - tk - tr - tt - udm - uk - ur - uz - vi - zh-hans - zh-hant tags: - api security: - knoxApiToken: [] - cookieAuth: [] - {} responses: '200': content: application/vnd.oai.openapi: schema: type: object additionalProperties: {} application/yaml: schema: type: object additionalProperties: {} application/vnd.oai.openapi+json: schema: type: object additionalProperties: {} application/json: schema: type: object additionalProperties: {} description: '' /api/v1/algorithms/: get: operationId: algorithms_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: slug schema: type: string tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAlgorithmList' description: '' /api/v1/algorithms/{id}/: get: operationId: algorithms_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this algorithm. required: true tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Algorithm' description: '' /api/v1/algorithms/images/: get: operationId: algorithms_images_list parameters: - in: query name: algorithm schema: type: string format: uuid - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAlgorithmImageList' description: '' /api/v1/algorithms/images/{id}/: get: operationId: algorithms_images_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this algorithm image. required: true tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlgorithmImage' description: '' /api/v1/algorithms/jobs/: get: operationId: algorithms_jobs_list parameters: - in: query name: algorithm_image__algorithm schema: type: string format: uuid - in: query name: input_image schema: type: array items: type: string format: uuid explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: output_image schema: type: array items: type: string format: uuid explode: true style: form tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHyperlinkedJobList' description: '' post: operationId: algorithms_jobs_create tags: - algorithms requestBody: content: application/json: schema: $ref: '#/components/schemas/JobPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/JobPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/JobPostRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/JobPost' description: '' /api/v1/algorithms/jobs/{id}/: get: operationId: algorithms_jobs_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this job. required: true tags: - algorithms security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HyperlinkedJob' description: '' /api/v1/archives/: get: operationId: archives_list parameters: - in: query name: format schema: type: string enum: - csv - json - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: slug schema: type: string tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedArchiveList' text/csv: schema: $ref: '#/components/schemas/PaginatedArchiveList' description: '' /api/v1/archives/{id}/: get: operationId: archives_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive. required: true tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Archive' text/csv: schema: $ref: '#/components/schemas/Archive' description: '' /api/v1/archives/{id}/patients/: get: operationId: archives_patients_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive. required: true tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Archive' text/csv: schema: $ref: '#/components/schemas/Archive' description: '' /api/v1/archives/{id}/studies/: get: operationId: archives_studies_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive. required: true tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Archive' text/csv: schema: $ref: '#/components/schemas/Archive' description: '' /api/v1/archives/items/: get: operationId: archives_items_list parameters: - in: query name: archive schema: type: string format: uuid - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedArchiveItemList' description: '' post: operationId: archives_items_create tags: - archives requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ArchiveItemPost' description: '' /api/v1/archives/items/{id}/: get: operationId: archives_items_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive item. required: true tags: - archives security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArchiveItem' description: '' put: operationId: archives_items_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive item. required: true tags: - archives requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/ArchiveItemPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArchiveItemPost' description: '' patch: operationId: archives_items_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this archive item. required: true tags: - archives requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedArchiveItemPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedArchiveItemPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedArchiveItemPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArchiveItemPost' description: '' /api/v1/cases/images/: get: operationId: cases_images_list parameters: - in: query name: archive schema: type: array items: type: array items: type: string explode: true style: form - in: query name: format schema: type: string enum: - csv - json - in: query name: job_input schema: type: array items: type: array items: type: string explode: true style: form - in: query name: job_output schema: type: array items: type: array items: type: string explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: name schema: type: string - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: origin schema: type: string format: uuid - in: query name: patient_age schema: type: string - in: query name: patient_birth_date schema: type: string format: date - in: query name: patient_id schema: type: string - in: query name: patient_id__isempty schema: type: boolean - in: query name: patient_name schema: type: string - in: query name: patient_sex schema: type: string enum: - F - M - O description: |- * `M` - Male * `F` - Female * `O` - Other - in: query name: reader_study schema: type: array items: type: array items: type: string explode: true style: form - in: query name: series_description schema: type: string - in: query name: series_instance_uid schema: type: string - in: query name: study_date schema: type: string format: date - in: query name: study_description schema: type: string - in: query name: study_description__isempty schema: type: boolean - in: query name: study_instance_uid schema: type: string tags: - cases security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHyperlinkedImageList' text/csv: schema: $ref: '#/components/schemas/PaginatedHyperlinkedImageList' description: '' /api/v1/cases/images/{id}/: get: operationId: cases_images_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this image. required: true tags: - cases security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/HyperlinkedImage' text/csv: schema: $ref: '#/components/schemas/HyperlinkedImage' description: '' /api/v1/cases/upload-sessions/: get: operationId: cases_upload_sessions_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - cases security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRawImageUploadSessionList' description: '' post: operationId: cases_upload_sessions_create tags: - cases requestBody: content: application/json: schema: $ref: '#/components/schemas/RawImageUploadSessionRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RawImageUploadSessionRequest' multipart/form-data: schema: $ref: '#/components/schemas/RawImageUploadSessionRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RawImageUploadSession' description: '' /api/v1/cases/upload-sessions/{id}/: get: operationId: cases_upload_sessions_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this raw image upload session. required: true tags: - cases security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RawImageUploadSession' description: '' /api/v1/challenges/: get: operationId: challenges_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - challenges security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPublicChallengeList' description: '' /api/v1/challenges/{slug}/: get: operationId: challenges_retrieve parameters: - in: path name: slug schema: type: string description: short name used in url, specific css, files etc. No spaces allowed required: true tags: - challenges security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicChallenge' description: '' /api/v1/components/interfaces/: get: operationId: components_interfaces_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: slug schema: type: string tags: - components security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedComponentInterfaceList' description: '' /api/v1/components/interfaces/{id}/: get: operationId: components_interfaces_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this component interface. required: true tags: - components security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentInterface' description: '' /api/v1/evaluations/: get: operationId: evaluations_list parameters: - in: query name: format schema: type: string enum: - csv - json - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: submission__phase schema: type: string format: uuid tags: - evaluations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEvaluationList' text/csv: schema: $ref: '#/components/schemas/PaginatedEvaluationList' description: '' /api/v1/evaluations/{id}/: get: operationId: evaluations_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this evaluation. required: true tags: - evaluations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Evaluation' text/csv: schema: $ref: '#/components/schemas/Evaluation' description: '' /api/v1/evaluations/{id}/claim/: patch: operationId: evaluations_claim_partial_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this evaluation. required: true tags: - evaluations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedExternalEvaluationRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedExternalEvaluationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedExternalEvaluationRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalEvaluation' text/csv: schema: $ref: '#/components/schemas/ExternalEvaluation' description: '' /api/v1/evaluations/{id}/update_external_evaluation/: patch: operationId: evaluations_update_external_evaluation_partial_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this evaluation. required: true tags: - evaluations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedExternalEvaluationUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedExternalEvaluationUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedExternalEvaluationUpdateRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalEvaluationUpdate' text/csv: schema: $ref: '#/components/schemas/ExternalEvaluationUpdate' description: '' /api/v1/evaluations/claimable_evaluations/: get: operationId: evaluations_claimable_evaluations_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: query name: submission__phase schema: type: string format: uuid description: Filter claimable evaluations by submission phase tags: - evaluations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalEvaluation' text/csv: schema: $ref: '#/components/schemas/ExternalEvaluation' description: '' /api/v1/gcapi/: get: operationId: gcapi_retrieve tags: - gcapi security: - knoxApiToken: [] - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/GCAPIVersion' description: '' /api/v1/notifications/: get: operationId: notifications_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - notifications security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationList' description: '' /api/v1/notifications/{id}/: get: operationId: notifications_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this notification. required: true tags: - notifications security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' put: operationId: notifications_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this notification. required: true tags: - notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/NotificationRequest' multipart/form-data: schema: $ref: '#/components/schemas/NotificationRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' patch: operationId: notifications_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this notification. required: true tags: - notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNotificationRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNotificationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNotificationRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Notification' description: '' delete: operationId: notifications_destroy parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this notification. required: true tags: - notifications security: - knoxApiToken: [] - cookieAuth: [] responses: '204': description: No response body /api/v1/profiles/users/self/: get: operationId: profiles_users_self_retrieve tags: - profiles security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' /api/v1/reader-studies/: get: operationId: reader_studies_list parameters: - in: query name: format schema: type: string enum: - csv - json - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: slug schema: type: string tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedReaderStudyList' text/csv: schema: $ref: '#/components/schemas/PaginatedReaderStudyList' description: '' /api/v1/reader-studies/{id}/: get: operationId: reader_studies_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this reader study. required: true tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReaderStudy' text/csv: schema: $ref: '#/components/schemas/ReaderStudy' description: '' /api/v1/reader-studies/{id}/ground-truth/{case_pk}/: get: operationId: reader_studies_ground_truth_retrieve parameters: - in: path name: case_pk schema: type: string format: uuid required: true - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this reader study. required: true tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReaderStudy' text/csv: schema: $ref: '#/components/schemas/ReaderStudy' description: '' /api/v1/reader-studies/answers/: get: operationId: reader_studies_answers_list parameters: - in: query name: creator schema: type: string description: username - in: query name: display_set schema: type: string format: uuid - in: query name: format schema: type: string enum: - csv - json - in: query name: is_ground_truth schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: question__reader_study schema: type: string format: uuid tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAnswerList' text/csv: schema: $ref: '#/components/schemas/PaginatedAnswerList' description: '' post: operationId: reader_studies_answers_create parameters: - in: query name: format schema: type: string enum: - csv - json tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/AnswerRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnswerRequest' multipart/form-data: schema: $ref: '#/components/schemas/AnswerRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Answer' text/csv: schema: $ref: '#/components/schemas/Answer' description: '' /api/v1/reader-studies/answers/{id}/: get: operationId: reader_studies_answers_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this answer. required: true tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Answer' text/csv: schema: $ref: '#/components/schemas/Answer' description: '' put: operationId: reader_studies_answers_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this answer. required: true tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/AnswerRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AnswerRequest' multipart/form-data: schema: $ref: '#/components/schemas/AnswerRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Answer' text/csv: schema: $ref: '#/components/schemas/Answer' description: '' patch: operationId: reader_studies_answers_partial_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this answer. required: true tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAnswerRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAnswerRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAnswerRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Answer' text/csv: schema: $ref: '#/components/schemas/Answer' description: '' /api/v1/reader-studies/answers/mine/: get: operationId: reader_studies_answers_mine_retrieve description: |- An endpoint that returns the questions that have been answered by the current user. parameters: - in: query name: format schema: type: string enum: - csv - json tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Answer' text/csv: schema: $ref: '#/components/schemas/Answer' description: '' /api/v1/reader-studies/display-sets/: get: operationId: reader_studies_display_sets_list parameters: - in: query name: format schema: type: string enum: - csv - json - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: reader_study schema: type: string format: uuid - in: query name: unanswered_by_user schema: type: boolean - in: query name: user schema: type: string tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDisplaySetList' text/csv: schema: $ref: '#/components/schemas/PaginatedDisplaySetList' description: '' post: operationId: reader_studies_display_sets_create parameters: - in: query name: format schema: type: string enum: - csv - json tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/DisplaySetPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DisplaySetPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/DisplaySetPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DisplaySetPost' text/csv: schema: $ref: '#/components/schemas/DisplaySetPost' description: '' /api/v1/reader-studies/display-sets/{id}/: get: operationId: reader_studies_display_sets_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this display set. required: true tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DisplaySet' text/csv: schema: $ref: '#/components/schemas/DisplaySet' description: '' put: operationId: reader_studies_display_sets_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this display set. required: true tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/DisplaySetPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DisplaySetPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/DisplaySetPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DisplaySetPost' text/csv: schema: $ref: '#/components/schemas/DisplaySetPost' description: '' patch: operationId: reader_studies_display_sets_partial_update parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this display set. required: true tags: - reader-studies requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDisplaySetPostRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedDisplaySetPostRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDisplaySetPostRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DisplaySetPost' text/csv: schema: $ref: '#/components/schemas/DisplaySetPost' description: '' /api/v1/reader-studies/questions/: get: operationId: reader_studies_questions_list parameters: - in: query name: format schema: type: string enum: - csv - json - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: reader_study schema: type: string format: uuid tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedQuestionList' text/csv: schema: $ref: '#/components/schemas/PaginatedQuestionList' description: '' /api/v1/reader-studies/questions/{id}/: get: operationId: reader_studies_questions_retrieve parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: string format: uuid description: A UUID string identifying this question. required: true tags: - reader-studies security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Question' text/csv: schema: $ref: '#/components/schemas/Question' description: '' /api/v1/subscriptions/: get: operationId: subscriptions_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - subscriptions security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFollowList' description: '' /api/v1/subscriptions/{id}/: get: operationId: subscriptions_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this follow. required: true tags: - subscriptions security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Follow' description: '' put: operationId: subscriptions_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this follow. required: true tags: - subscriptions requestBody: content: application/json: schema: $ref: '#/components/schemas/FollowRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FollowRequest' multipart/form-data: schema: $ref: '#/components/schemas/FollowRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Follow' description: '' patch: operationId: subscriptions_partial_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this follow. required: true tags: - subscriptions requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFollowRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFollowRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFollowRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Follow' description: '' delete: operationId: subscriptions_destroy parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this follow. required: true tags: - subscriptions security: - knoxApiToken: [] - cookieAuth: [] responses: '204': description: No response body /api/v1/timezone/: put: operationId: timezone_update tags: - timezone requestBody: content: application/json: schema: $ref: '#/components/schemas/TimezoneRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TimezoneRequest' multipart/form-data: schema: $ref: '#/components/schemas/TimezoneRequest' required: true security: - cookieAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/Timezone' description: '' /api/v1/uploads/: get: operationId: uploads_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - uploads security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserUploadList' description: '' post: operationId: uploads_create tags: - uploads requestBody: content: application/json: schema: $ref: '#/components/schemas/UserUploadCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserUploadCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UserUploadCreateRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserUploadCreate' description: '' /api/v1/uploads/{id}/: get: operationId: uploads_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user upload. required: true tags: - uploads security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserUpload' description: '' /api/v1/uploads/{id}/{s3_upload_id}/abort-multipart-upload/: patch: operationId: uploads_abort_multipart_upload_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user upload. required: true - in: path name: s3_upload_id schema: type: string pattern: ^[^/]+$ required: true tags: - uploads security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserUpload' description: '' /api/v1/uploads/{id}/{s3_upload_id}/complete-multipart-upload/: patch: operationId: uploads_complete_multipart_upload_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user upload. required: true - in: path name: s3_upload_id schema: type: string pattern: ^[^/]+$ required: true tags: - uploads requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserUploadCompleteRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUserUploadCompleteRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUserUploadCompleteRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserUploadComplete' description: '' /api/v1/uploads/{id}/{s3_upload_id}/generate-presigned-urls/: patch: operationId: uploads_generate_presigned_urls_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user upload. required: true - in: path name: s3_upload_id schema: type: string pattern: ^[^/]+$ required: true tags: - uploads requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserUploadPresignedURLsRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUserUploadPresignedURLsRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUserUploadPresignedURLsRequest' security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserUploadPresignedURLs' description: '' /api/v1/uploads/{id}/{s3_upload_id}/list-parts/: get: operationId: uploads_list_parts_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user upload. required: true - in: path name: s3_upload_id schema: type: string pattern: ^[^/]+$ required: true tags: - uploads security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserUploadParts' description: '' /api/v1/workstations/: get: operationId: workstations_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: slug schema: type: string tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWorkstationList' description: '' /api/v1/workstations/{id}/: get: operationId: workstations_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this workstation. required: true tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Workstation' description: '' /api/v1/workstations/configs/: get: operationId: workstations_configs_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWorkstationConfigList' description: '' /api/v1/workstations/configs/{id}/: get: operationId: workstations_configs_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this workstation config. required: true tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkstationConfig' description: '' /api/v1/workstations/feedback/: get: operationId: workstations_feedback_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFeedbackList' description: '' post: operationId: workstations_feedback_create tags: - workstations requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedbackRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FeedbackRequest' multipart/form-data: schema: $ref: '#/components/schemas/FeedbackRequest' required: true security: - knoxApiToken: [] - cookieAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Feedback' description: '' /api/v1/workstations/feedback/{id}/: get: operationId: workstations_feedback_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this feedback. required: true tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Feedback' description: '' /api/v1/workstations/sessions/: get: operationId: workstations_sessions_list parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSessionList' description: '' /api/v1/workstations/sessions/{id}/: get: operationId: workstations_sessions_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this session. required: true tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Session' description: '' /api/v1/workstations/sessions/{id}/keep_alive/: patch: operationId: workstations_sessions_keep_alive_partial_update description: Increase the maximum duration of the session, up to the limit. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this session. required: true tags: - workstations security: - knoxApiToken: [] - cookieAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Session' description: '' components: schemas: Algorithm: type: object properties: api_url: type: string readOnly: true url: type: string format: uri readOnly: true description: type: string nullable: true pk: type: string format: uuid readOnly: true title: Id title: type: string maxLength: 255 logo: type: string format: uri readOnly: true slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ average_duration: type: number format: double nullable: true description: The average duration of successful jobs in seconds readOnly: true inputs: type: array items: $ref: '#/components/schemas/ComponentInterface' readOnly: true outputs: type: array items: $ref: '#/components/schemas/ComponentInterface' readOnly: true required: - api_url - average_duration - inputs - logo - outputs - pk - slug - title - url AlgorithmImage: type: object properties: pk: type: string format: uuid readOnly: true title: Id url: type: string format: uri readOnly: true api_url: type: string readOnly: true algorithm: type: string format: uri readOnly: true created: type: string format: date-time readOnly: true import_status: type: string readOnly: true image: type: string format: uri description: .tar.gz archive of the container image produced from the command 'docker save IMAGE | gzip -c > IMAGE.tar.gz'. See https://docs.docker.com/engine/reference/commandline/save/ required: - algorithm - api_url - created - import_status - pk - url Answer: type: object properties: answer: nullable: true api_url: type: string description: API url for this ``Answer``. readOnly: true created: type: string format: date-time readOnly: true creator: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. readOnly: true display_set: type: string format: uri pk: type: string format: uuid readOnly: true title: Id question: type: string format: uri modified: type: string format: date-time readOnly: true answer_image: type: string format: uri readOnly: true last_edit_duration: type: string nullable: true total_edit_duration: type: string readOnly: true is_ground_truth: type: boolean readOnly: true required: - answer_image - api_url - created - creator - is_ground_truth - modified - pk - question - total_edit_duration AnswerRequest: type: object properties: answer: nullable: true display_set: type: string format: uri question: type: string format: uri last_edit_duration: type: string nullable: true required: - question Archive: type: object properties: pk: type: string format: uuid readOnly: true title: Id name: type: string readOnly: true title: type: string maxLength: 255 algorithms: type: array items: type: string format: uri readOnly: true logo: type: string format: uri readOnly: true description: type: string nullable: true api_url: type: string readOnly: true url: type: string format: uri readOnly: true required: - algorithms - api_url - logo - name - pk - title - url ArchiveItem: type: object properties: pk: type: string format: uuid readOnly: true title: Id title: type: string default: '' maxLength: 255 archive: type: string format: uri readOnly: true values: type: array items: $ref: '#/components/schemas/HyperlinkedComponentInterfaceValue' hanging_protocol: allOf: - $ref: '#/components/schemas/HangingProtocol' readOnly: true nullable: true optional_hanging_protocols: type: array items: $ref: '#/components/schemas/HangingProtocol' readOnly: true view_content: readOnly: true required: - archive - hanging_protocol - optional_hanging_protocols - pk - values - view_content ArchiveItemPost: type: object properties: pk: type: string format: uuid readOnly: true title: Id title: type: string default: '' maxLength: 255 archive: type: string format: uri values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePost' hanging_protocol: allOf: - $ref: '#/components/schemas/HangingProtocol' readOnly: true nullable: true optional_hanging_protocols: type: array items: $ref: '#/components/schemas/HangingProtocol' readOnly: true view_content: readOnly: true required: - hanging_protocol - optional_hanging_protocols - pk - view_content ArchiveItemPostRequest: type: object properties: title: type: string default: '' maxLength: 255 archive: type: string format: uri values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePostRequest' BlankEnum: enum: - '' CategoricalOption: type: object properties: id: type: integer readOnly: true title: type: string maxLength: 1024 default: type: boolean required: - id - title Challenge: type: object properties: title: type: string description: The name of the challenge that is displayed on the All Challenges page. If this is blank the short name of the challenge will be used. maxLength: 64 short_name: type: string description: short name used in url, specific css, files etc. No spaces allowed pattern: ^[-a-zA-Z0-9_]+$ maxLength: 50 required: - short_name ChallengeRequest: type: object properties: title: type: string description: The name of the challenge that is displayed on the All Challenges page. If this is blank the short name of the challenge will be used. maxLength: 64 short_name: type: string minLength: 1 description: short name used in url, specific css, files etc. No spaces allowed pattern: ^[-a-zA-Z0-9_]+$ maxLength: 50 required: - short_name ColorInterpolationEnum: enum: - RGB - HLS - HLSpos - HLSneg - Constant type: string description: |- * `RGB` - RGB * `HLS` - HLS * `HLSpos` - HLS Positive * `HLSneg` - HLS Negative * `Constant` - Constant ColorSpaceEnum: enum: - GRAY - RGB - RGBA - YCBCR type: string description: |- * `GRAY` - GRAY * `RGB` - RGB * `RGBA` - RGBA * `YCBCR` - YCBCR ComponentInterface: type: object properties: title: type: string description: Human readable name of this input/output field. maxLength: 255 description: type: string description: Description of this input/output field. slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ kind: type: string readOnly: true pk: type: integer readOnly: true title: ID default_value: nullable: true description: Default value for this field, only valid for inputs. super_kind: type: string readOnly: true relative_path: type: string description: The path to the entity that implements this interface relative to the input or output directory. pattern: .*[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}.* maxLength: 255 overlay_segments: description: 'The schema that defines how categories of values in the overlay images are differentiated. Example usage: [{"name": "background", "visible": true, "voxel_value": 0},{"name": "tissue", "visible": true, "voxel_value": 1}]. If a categorical overlay is shown, it is possible to show toggles to change the visibility of the different overlay categories. To do so, configure the categories that should be displayed. Data from the algorithm''s output.json can be added as an extra label to each toggle using jinja templating. For example: [{"name": "Level 0", "visible": false, "voxel_value": 0, "metric_template": "{{metrics.volumes[0]}} mm³"}]. ' look_up_table: allOf: - $ref: '#/components/schemas/LookUpTable' readOnly: true nullable: true required: - kind - look_up_table - pk - relative_path - slug - super_kind - title ComponentInterfaceValue: type: object properties: interface: $ref: '#/components/schemas/ComponentInterface' value: nullable: true file: type: string format: uri nullable: true image: $ref: '#/components/schemas/SimpleImage' pk: type: integer readOnly: true title: Id required: - interface - pk ComponentInterfaceValuePost: type: object description: |- Serializes images with hyperlinks for external usage Expects interface_slug, to allow creating a ComponentInterfaceValue with an existing ComponentInterface properties: interface: type: string value: nullable: true file: type: string format: uri nullable: true image: type: string format: uri pk: type: integer readOnly: true title: Id required: - interface - pk ComponentInterfaceValuePostRequest: type: object description: |- Serializes images with hyperlinks for external usage Expects interface_slug, to allow creating a ComponentInterfaceValue with an existing ComponentInterface properties: interface: type: string minLength: 1 value: nullable: true file: type: string format: binary nullable: true image: type: string format: uri upload_session: type: string format: uri writeOnly: true user_upload: type: string format: uri writeOnly: true required: - interface DisplaySet: type: object properties: pk: type: string format: uuid readOnly: true title: Id title: type: string default: '' maxLength: 255 reader_study: type: string format: uri readOnly: true values: type: array items: $ref: '#/components/schemas/HyperlinkedComponentInterfaceValue' order: type: integer maximum: 2147483647 minimum: 0 api_url: type: string description: API url for this ``DisplaySet``. readOnly: true hanging_protocol: allOf: - $ref: '#/components/schemas/HangingProtocol' readOnly: true nullable: true optional_hanging_protocols: type: array items: $ref: '#/components/schemas/HangingProtocol' readOnly: true view_content: readOnly: true description: type: string readOnly: true index: type: integer nullable: true readOnly: true required: - api_url - description - hanging_protocol - index - optional_hanging_protocols - pk - reader_study - values - view_content DisplaySetPost: type: object properties: pk: type: string format: uuid readOnly: true title: Id title: type: string default: '' maxLength: 255 reader_study: type: string values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePost' order: type: integer maximum: 2147483647 minimum: 0 api_url: type: string description: API url for this ``DisplaySet``. readOnly: true hanging_protocol: allOf: - $ref: '#/components/schemas/HangingProtocol' readOnly: true nullable: true optional_hanging_protocols: type: array items: $ref: '#/components/schemas/HangingProtocol' readOnly: true view_content: readOnly: true description: type: string readOnly: true index: type: integer nullable: true readOnly: true required: - api_url - description - hanging_protocol - index - optional_hanging_protocols - pk - view_content DisplaySetPostRequest: type: object properties: title: type: string default: '' maxLength: 255 reader_study: type: string minLength: 1 values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePostRequest' order: type: integer maximum: 2147483647 minimum: 0 Evaluation: type: object properties: pk: type: string format: uuid readOnly: true title: Id method: type: string format: uuid nullable: true submission: $ref: '#/components/schemas/Submission' created: type: string format: date-time readOnly: true published: type: boolean outputs: type: array items: $ref: '#/components/schemas/ComponentInterfaceValue' readOnly: true rank: type: integer maximum: 2147483647 minimum: 0 description: The position of this result on the leaderboard. If the value is zero, then the result is unranked. rank_score: type: number format: double rank_per_metric: {} status: type: string readOnly: true title: type: string readOnly: true required: - created - outputs - pk - status - submission - title ExternalEvaluation: type: object properties: pk: type: string format: uuid readOnly: true title: Id method: type: string format: uuid nullable: true submission: $ref: '#/components/schemas/Submission' created: type: string format: date-time readOnly: true published: type: boolean outputs: type: array items: $ref: '#/components/schemas/ComponentInterfaceValue' readOnly: true rank: type: integer maximum: 2147483647 minimum: 0 description: The position of this result on the leaderboard. If the value is zero, then the result is unranked. rank_score: type: number format: double rank_per_metric: {} status: type: string readOnly: true title: type: string readOnly: true algorithm_model: type: object additionalProperties: {} nullable: true readOnly: true algorithm_image: type: object additionalProperties: {} readOnly: true claimed_by: type: integer nullable: true phase_pk: type: string required: - algorithm_image - algorithm_model - created - outputs - phase_pk - pk - status - submission - title ExternalEvaluationUpdate: type: object properties: metrics: {} status: $ref: '#/components/schemas/StatusEnum' error_message: type: string maxLength: 1024 required: - status EyeChoiceEnum: enum: - OD - OS - U - NA type: string description: |- * `OD` - Oculus Dexter (right eye) * `OS` - Oculus Sinister (left eye) * `U` - Unknown * `NA` - Not applicable Feedback: type: object properties: session: type: string format: uri screenshot: type: string format: uri user_comment: type: string context: nullable: true required: - session - user_comment FeedbackRequest: type: object properties: session: type: string format: uri screenshot: type: string format: binary user_comment: type: string minLength: 1 context: nullable: true required: - session - user_comment FieldOfViewEnum: enum: - F1M - F2 - F3M - F4 - F5 - F6 - F7 - U description: |- * `F1M` - F1M * `F2` - F2 * `F3M` - F3M * `F4` - F4 * `F5` - F5 * `F6` - F6 * `F7` - F7 * `U` - Unknown * `None` - Not applicable Follow: type: object properties: pk: type: integer readOnly: true title: ID flag: type: string maxLength: 255 required: - pk FollowRequest: type: object properties: flag: type: string maxLength: 255 GCAPIVersion: type: object properties: latest_version: type: string lowest_supported_version: type: string required: - latest_version - lowest_supported_version HangingProtocol: type: object properties: json: {} title: type: string maxLength: 255 pk: type: string format: uuid readOnly: true title: Id svg_icon: type: string readOnly: true required: - json - pk - svg_icon - title HangingProtocolRequest: type: object properties: json: {} title: type: string minLength: 1 maxLength: 255 required: - json - title HyperlinkedComponentInterfaceValue: type: object properties: interface: $ref: '#/components/schemas/ComponentInterface' value: nullable: true file: type: string format: uri nullable: true image: type: string format: uri readOnly: true nullable: true pk: type: integer readOnly: true title: Id required: - image - interface - pk HyperlinkedImage: type: object properties: pk: type: string format: uuid readOnly: true title: Id name: type: string maxLength: 4096 files: type: array items: $ref: '#/components/schemas/ImageFile' readOnly: true width: type: integer maximum: 2147483647 minimum: -2147483648 height: type: integer maximum: 2147483647 minimum: -2147483648 depth: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true color_space: $ref: '#/components/schemas/ColorSpaceEnum' modality: allOf: - $ref: '#/components/schemas/ImagingModality' readOnly: true nullable: true eye_choice: allOf: - $ref: '#/components/schemas/EyeChoiceEnum' description: |- Is this (retina) image from the right or left eye? * `OD` - Oculus Dexter (right eye) * `OS` - Oculus Sinister (left eye) * `U` - Unknown * `NA` - Not applicable stereoscopic_choice: nullable: true description: |- Is this the left or right image of a stereoscopic pair? * `L` - Left * `R` - Right * `U` - Unknown * `None` - Not applicable oneOf: - $ref: '#/components/schemas/StereoscopicChoiceEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' field_of_view: nullable: true description: |- What is the field of view of this image? * `F1M` - F1M * `F2` - F2 * `F3M` - F3M * `F4` - F4 * `F5` - F5 * `F6` - F6 * `F7` - F7 * `U` - Unknown * `None` - Not applicable oneOf: - $ref: '#/components/schemas/FieldOfViewEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' shape_without_color: type: array items: type: integer description: |- Return the shape of the image without the color channel. Returns ------- The shape of the image in NumPy ordering [(t), (z), y, x] readOnly: true shape: type: array items: type: integer description: |- Return the shape of the image with the color channel. Returns ------- The shape of the image in NumPy ordering [(t), (z), y, x, (c)] readOnly: true voxel_width_mm: type: number format: double nullable: true voxel_height_mm: type: number format: double nullable: true voxel_depth_mm: type: number format: double nullable: true api_url: type: string readOnly: true patient_id: type: string maxLength: 64 patient_name: type: string maxLength: 324 patient_birth_date: type: string format: date nullable: true patient_age: type: string maxLength: 4 patient_sex: oneOf: - $ref: '#/components/schemas/PatientSexEnum' - $ref: '#/components/schemas/BlankEnum' study_date: type: string format: date nullable: true study_instance_uid: type: string maxLength: 64 series_instance_uid: type: string maxLength: 64 study_description: type: string maxLength: 64 series_description: type: string maxLength: 64 window_center: type: number format: double nullable: true window_width: type: number format: double nullable: true segments: nullable: true required: - api_url - color_space - files - height - modality - name - pk - shape - shape_without_color - width HyperlinkedJob: type: object description: Serializer with hyperlinks for use in public API properties: pk: type: string format: uuid readOnly: true title: Id url: type: string format: uri readOnly: true api_url: type: string readOnly: true algorithm_image: type: string format: uri inputs: type: array items: $ref: '#/components/schemas/HyperlinkedComponentInterfaceValue' outputs: type: array items: $ref: '#/components/schemas/HyperlinkedComponentInterfaceValue' status: type: string readOnly: true rendered_result_text: type: string readOnly: true started_at: type: string format: date-time nullable: true completed_at: type: string format: date-time nullable: true hanging_protocol: allOf: - $ref: '#/components/schemas/HangingProtocol' readOnly: true nullable: true optional_hanging_protocols: type: array items: $ref: '#/components/schemas/HangingProtocol' readOnly: true view_content: readOnly: true algorithm: type: string format: uri readOnly: true required: - algorithm - algorithm_image - api_url - hanging_protocol - inputs - optional_hanging_protocols - outputs - pk - rendered_result_text - status - url - view_content ImageFile: type: object properties: pk: type: string format: uuid readOnly: true title: Id image: type: string format: uuid nullable: true file: type: string format: uri image_type: $ref: '#/components/schemas/ImageTypeEnum' required: - file - pk ImageTypeEnum: enum: - MHD - TIFF - DZI type: string description: |- * `MHD` - MHD * `TIFF` - TIFF * `DZI` - DZI ImagingModality: type: object properties: modality: type: string maxLength: 16 required: - modality JobPost: type: object description: Serializer without hyperlinks for internal use properties: pk: type: string format: uuid readOnly: true title: Id inputs: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePost' status: type: string readOnly: true required: - inputs - pk - status JobPostRequest: type: object description: Serializer without hyperlinks for internal use properties: algorithm: type: string format: uri writeOnly: true inputs: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePostRequest' required: - algorithm - inputs LocationEnum: enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - KP - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - KR - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - US - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW type: string description: |- * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Türkiye * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe LookUpTable: type: object properties: pk: type: integer readOnly: true title: ID slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ title: type: string maxLength: 255 description: type: string nullable: true color: type: string pattern: '^\[(?:((?: ?-?\d*(?:\.\d+)? ){3}(?:-?\d*(?:\.\d+)?)) ?, ?)+((?:-?\d*(?:\.\d+)? ){3}(?:\d*(:?\.\d+)? ?))\]$' alpha: type: string pattern: '^\[(?:((?: ?-?\d*(?:\.\d+)? ){1}(?:-?\d*(?:\.\d+)?)) ?, ?)+((?:-?\d*(?:\.\d+)? ){1}(?:\d*(:?\.\d+)? ?))\]$' color_invert: type: string pattern: '^\[(?:((?: ?-?\d*(?:\.\d+)? ){3}(?:-?\d*(?:\.\d+)?)) ?, ?)+((?:-?\d*(?:\.\d+)? ){3}(?:\d*(:?\.\d+)? ?))\]$' alpha_invert: type: string pattern: '^\[(?:((?: ?-?\d*(?:\.\d+)? ){1}(?:-?\d*(?:\.\d+)?)) ?, ?)+((?:-?\d*(?:\.\d+)? ){1}(?:\d*(:?\.\d+)? ?))\]$' range_min: type: integer maximum: 32767 minimum: -32768 range_max: type: integer maximum: 32767 minimum: -32768 relative: type: boolean color_interpolation: $ref: '#/components/schemas/ColorInterpolationEnum' color_interpolation_invert: $ref: '#/components/schemas/ColorInterpolationEnum' required: - alpha - color - pk - slug - title Notification: type: object properties: read: type: boolean NotificationRequest: type: object properties: read: type: boolean NullEnum: enum: - null PaginatedAlgorithmImageList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/AlgorithmImage' PaginatedAlgorithmList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Algorithm' PaginatedAnswerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Answer' PaginatedArchiveItemList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ArchiveItem' PaginatedArchiveList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Archive' PaginatedComponentInterfaceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ComponentInterface' PaginatedDisplaySetList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DisplaySet' PaginatedEvaluationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Evaluation' PaginatedFeedbackList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Feedback' PaginatedFollowList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Follow' PaginatedHyperlinkedImageList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/HyperlinkedImage' PaginatedHyperlinkedJobList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/HyperlinkedJob' PaginatedNotificationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Notification' PaginatedPublicChallengeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PublicChallenge' PaginatedQuestionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Question' PaginatedRawImageUploadSessionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RawImageUploadSession' PaginatedReaderStudyList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ReaderStudy' PaginatedSessionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Session' PaginatedUserUploadList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/UserUpload' PaginatedWorkstationConfigList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/WorkstationConfig' PaginatedWorkstationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Workstation' Part: type: object properties: ETag: type: string PartNumber: type: integer maximum: 10000 minimum: 1 LastModified: type: string format: date-time Size: type: integer minimum: 0 required: - ETag - LastModified - PartNumber - Size PartRequest: type: object properties: ETag: type: string minLength: 1 PartNumber: type: integer maximum: 10000 minimum: 1 LastModified: type: string format: date-time Size: type: integer minimum: 0 required: - ETag - LastModified - PartNumber - Size PatchedAnswerRequest: type: object properties: answer: nullable: true display_set: type: string format: uri question: type: string format: uri last_edit_duration: type: string nullable: true PatchedArchiveItemPostRequest: type: object properties: title: type: string default: '' maxLength: 255 archive: type: string format: uri values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePostRequest' PatchedDisplaySetPostRequest: type: object properties: title: type: string default: '' maxLength: 255 reader_study: type: string minLength: 1 values: type: array items: $ref: '#/components/schemas/ComponentInterfaceValuePostRequest' order: type: integer maximum: 2147483647 minimum: 0 PatchedExternalEvaluationRequest: type: object properties: method: type: string format: uuid nullable: true submission: $ref: '#/components/schemas/SubmissionRequest' published: type: boolean rank: type: integer maximum: 2147483647 minimum: 0 description: The position of this result on the leaderboard. If the value is zero, then the result is unranked. rank_score: type: number format: double rank_per_metric: {} claimed_by: type: integer nullable: true phase_pk: type: string minLength: 1 PatchedExternalEvaluationUpdateRequest: type: object properties: metrics: {} status: $ref: '#/components/schemas/StatusEnum' error_message: type: string minLength: 1 maxLength: 1024 PatchedFollowRequest: type: object properties: flag: type: string maxLength: 255 PatchedNotificationRequest: type: object properties: read: type: boolean PatchedUserUploadCompleteRequest: type: object properties: parts: type: array items: $ref: '#/components/schemas/PartRequest' writeOnly: true PatchedUserUploadPresignedURLsRequest: type: object properties: part_numbers: type: array items: type: integer maximum: 10000 minimum: 1 writeOnly: true PatientSexEnum: enum: - M - F - O type: string description: |- * `M` - Male * `F` - Female * `O` - Other Phase: type: object properties: challenge: $ref: '#/components/schemas/Challenge' title: type: string description: The title of this phase. maxLength: 64 slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ required: - challenge - slug - title PhaseRequest: type: object properties: challenge: $ref: '#/components/schemas/ChallengeRequest' title: type: string minLength: 1 description: The title of this phase. maxLength: 64 required: - challenge - title PublicChallenge: type: object properties: api_url: type: string readOnly: true url: type: string format: uri readOnly: true slug: type: string readOnly: true title: type: string description: The name of the challenge that is displayed on the All Challenges page. If this is blank the short name of the challenge will be used. maxLength: 64 description: type: string description: Short summary of this project, max 1024 characters. maxLength: 1024 public: type: boolean description: Helper property for consistency with other objects readOnly: true status: type: string readOnly: true logo: type: string format: uri description: A logo for this challenge. Should be square with a resolution of 640x640 px or higher. submission_types: type: array items: type: string readOnly: true start_date: type: string format: date-time nullable: true readOnly: true end_date: type: string format: date-time nullable: true readOnly: true publications: type: array items: type: string readOnly: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true incentives: type: array items: type: string readOnly: true required: - api_url - created - end_date - incentives - modified - public - publications - slug - start_date - status - submission_types - url Question: type: object properties: answer_type: type: string readOnly: true api_url: type: string description: API url for this ``Question``. readOnly: true form_direction: type: string readOnly: true help_text: type: string image_port: type: string readOnly: true default_annotation_color: type: string description: Default color for displaying and creating annotations for this question pattern: ^#[a-fA-F0-9]{6}$ maxLength: 7 pk: type: string format: uuid readOnly: true title: Id question_text: type: string reader_study: type: string format: uri readOnly: true required: type: boolean options: type: array items: $ref: '#/components/schemas/CategoricalOption' readOnly: true interface: allOf: - $ref: '#/components/schemas/ComponentInterface' readOnly: true nullable: true overlay_segments: description: 'The schema that defines how categories of values in the overlay images are differentiated. Example usage: [{"name": "background", "visible": true, "voxel_value": 0},{"name": "tissue", "visible": true, "voxel_value": 1}]. If a categorical overlay is shown, it is possible to show toggles to change the visibility of the different overlay categories. To do so, configure the categories that should be displayed. Data from the algorithm''s output.json can be added as an extra label to each toggle using jinja templating. For example: [{"name": "Level 0", "visible": false, "voxel_value": 0, "metric_template": "{{metrics.volumes[0]}} mm³"}]. ' look_up_table: allOf: - $ref: '#/components/schemas/LookUpTable' readOnly: true nullable: true widget: type: string readOnly: true answer_min_value: type: integer maximum: 32767 minimum: -32768 nullable: true description: Minimum value for answers of type Number. Can only be set in combination with the 'Number input' or 'Number Range' widgets. answer_max_value: type: integer maximum: 32767 minimum: -32768 nullable: true description: Maximum value for answers of type Number. Can only be set in combination with the 'Number input' or 'Number Range' widgets. answer_step_size: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,3})?$ nullable: true description: Step size for answers of type Number. Defaults to 1, allowing only integer values. Can only be set in combination with the 'Number input' or 'Number Range' widgets. answer_min_length: type: integer maximum: 32767 minimum: 0 nullable: true description: Minimum length for answers of type Text. Can only be set in combination with the 'Text Input' or 'Text Area' widgets. answer_max_length: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum length for answers of type Text. Can only be set in combination with the 'Text Input' or 'Text Area' widgets. answer_match_pattern: type: string description: Regular expression to match a pattern for answers of type Text. Can only be set in combination with the 'Text Input' or 'Text Area' widgets. empty_answer_confirmation: type: boolean description: Require an explicit confirmation when saving an empty answer to this question. empty_answer_confirmation_label: type: string description: Label to show when confirming an empty answer. interactive_algorithms: type: array items: type: string readOnly: true required: - answer_type - api_url - form_direction - image_port - interactive_algorithms - interface - look_up_table - options - pk - question_text - reader_study - widget RawImageUploadSession: type: object properties: pk: type: string format: uuid readOnly: true title: Id creator: type: integer nullable: true status: type: string readOnly: true error_message: type: string nullable: true image_set: type: array items: type: string format: uri readOnly: true api_url: type: string readOnly: true user_uploads: type: array items: type: string format: uuid uploads: type: array items: type: string format: uri required: - api_url - image_set - pk - status - uploads RawImageUploadSessionRequest: type: object properties: creator: type: integer nullable: true error_message: type: string nullable: true minLength: 1 user_uploads: type: array items: type: string format: uuid archive: type: string minLength: 1 writeOnly: true answer: type: string format: uuid writeOnly: true interface: type: string minLength: 1 writeOnly: true archive_item: type: string format: uuid writeOnly: true display_set: type: string format: uuid writeOnly: true uploads: type: array items: type: string format: uri required: - uploads ReaderStudy: type: object properties: api_url: type: string readOnly: true url: type: string format: uri readOnly: true slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ logo: type: string format: uri readOnly: true description: type: string nullable: true help_text: type: string description: The cleaned help text from the markdown sources readOnly: true pk: type: string format: uuid readOnly: true title: Id questions: type: array items: $ref: '#/components/schemas/Question' readOnly: true title: type: string maxLength: 255 is_educational: type: boolean description: If checked, readers get the option to verify their answers against the uploaded ground truth. This also means that the uploaded ground truth will be readily available to the readers. instant_verification: type: boolean description: In an educational reader study, enabling this setting will allow the user to go through the reader study faster. The 'Save and continue' button will be replaced by a 'Verify and continue' button which will show the answer verification pop up and allow the user to save and go to the next case upon dismissal. has_ground_truth: type: boolean readOnly: true allow_answer_modification: type: boolean description: If true, readers are allowed to modify their answers for a case by navigating back to previous cases. 'Allow case navigation' must be checked as well to enable this setting. allow_case_navigation: type: boolean description: If true, readers are allowed to navigate back and forth between cases in this reader study. allow_show_all_annotations: type: boolean description: If true, readers are allowed to show/hide all annotations for a case. roll_over_answers_for_n_cases: type: integer maximum: 32767 minimum: 0 description: The number of cases for which answers should roll over. It can be used for repeated readings with slightly different hangings. For instance, if set to 1. Case 2 will start with the answers from case 1; whereas case 3 starts anew but its answers will roll over to case 4. Setting it to 0 (default) means answers will not roll over. required: - api_url - has_ground_truth - help_text - logo - pk - questions - slug - title - url Session: type: object properties: pk: type: string format: uuid readOnly: true title: Id status: type: string readOnly: true required: - pk - status SimpleImage: type: object properties: pk: type: string format: uuid readOnly: true title: Id name: type: string maxLength: 4096 required: - name - pk StatusEnum: enum: - Succeeded - Failed type: string description: |- * `Succeeded` - Succeeded * `Failed` - Failed StereoscopicChoiceEnum: enum: - L - R - U description: |- * `L` - Left * `R` - Right * `U` - Unknown * `None` - Not applicable Submission: type: object properties: pk: type: string format: uuid readOnly: true title: Id phase: $ref: '#/components/schemas/Phase' created: type: string format: date-time readOnly: true creator: $ref: '#/components/schemas/User' comment: type: string description: You can add a comment here to help you keep track of your submissions. maxLength: 128 predictions_file: type: string format: uri supplementary_file: type: string format: uri supplementary_url: type: string format: uri description: A URL associated with this submission. maxLength: 200 algorithm_image: type: string format: uri readOnly: true required: - algorithm_image - created - creator - phase - pk SubmissionRequest: type: object properties: phase: $ref: '#/components/schemas/PhaseRequest' creator: $ref: '#/components/schemas/UserRequest' comment: type: string description: You can add a comment here to help you keep track of your submissions. maxLength: 128 predictions_file: type: string format: binary supplementary_file: type: string format: binary supplementary_url: type: string format: uri description: A URL associated with this submission. maxLength: 200 required: - creator - phase Timezone: type: object properties: timezone: $ref: '#/components/schemas/TimezoneEnum' required: - timezone TimezoneEnum: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu - localtime type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Asmera` - Africa/Asmera * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Timbuktu` - Africa/Timbuktu * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Atka` - America/Atka * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Buenos_Aires` - America/Buenos_Aires * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Catamarca` - America/Catamarca * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Coral_Harbour` - America/Coral_Harbour * `America/Cordoba` - America/Cordoba * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Ensenada` - America/Ensenada * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fort_Wayne` - America/Fort_Wayne * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Godthab` - America/Godthab * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Indianapolis` - America/Indianapolis * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Jujuy` - America/Jujuy * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Knox_IN` - America/Knox_IN * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Louisville` - America/Louisville * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Mendoza` - America/Mendoza * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montreal` - America/Montreal * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nipigon` - America/Nipigon * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Pangnirtung` - America/Pangnirtung * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Acre` - America/Porto_Acre * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rainy_River` - America/Rainy_River * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Rosario` - America/Rosario * `America/Santa_Isabel` - America/Santa_Isabel * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Shiprock` - America/Shiprock * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Thunder_Bay` - America/Thunder_Bay * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Virgin` - America/Virgin * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/South_Pole` - Antarctica/South_Pole * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Ashkhabad` - Asia/Ashkhabad * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Calcutta` - Asia/Calcutta * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Chongqing` - Asia/Chongqing * `Asia/Chungking` - Asia/Chungking * `Asia/Colombo` - Asia/Colombo * `Asia/Dacca` - Asia/Dacca * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Harbin` - Asia/Harbin * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Istanbul` - Asia/Istanbul * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kashgar` - Asia/Kashgar * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Katmandu` - Asia/Katmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macao` - Asia/Macao * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Rangoon` - Asia/Rangoon * `Asia/Riyadh` - Asia/Riyadh * `Asia/Saigon` - Asia/Saigon * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Tel_Aviv` - Asia/Tel_Aviv * `Asia/Thimbu` - Asia/Thimbu * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ujung_Pandang` - Asia/Ujung_Pandang * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Ulan_Bator` - Asia/Ulan_Bator * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faeroe` - Atlantic/Faeroe * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/ACT` - Australia/ACT * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Canberra` - Australia/Canberra * `Australia/Currie` - Australia/Currie * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/LHI` - Australia/LHI * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/NSW` - Australia/NSW * `Australia/North` - Australia/North * `Australia/Perth` - Australia/Perth * `Australia/Queensland` - Australia/Queensland * `Australia/South` - Australia/South * `Australia/Sydney` - Australia/Sydney * `Australia/Tasmania` - Australia/Tasmania * `Australia/Victoria` - Australia/Victoria * `Australia/West` - Australia/West * `Australia/Yancowinna` - Australia/Yancowinna * `Brazil/Acre` - Brazil/Acre * `Brazil/DeNoronha` - Brazil/DeNoronha * `Brazil/East` - Brazil/East * `Brazil/West` - Brazil/West * `CET` - CET * `CST6CDT` - CST6CDT * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Canada/Saskatchewan` - Canada/Saskatchewan * `Canada/Yukon` - Canada/Yukon * `Chile/Continental` - Chile/Continental * `Chile/EasterIsland` - Chile/EasterIsland * `Cuba` - Cuba * `EET` - EET * `EST` - EST * `EST5EDT` - EST5EDT * `Egypt` - Egypt * `Eire` - Eire * `Etc/GMT` - Etc/GMT * `Etc/GMT+0` - Etc/GMT+0 * `Etc/GMT+1` - Etc/GMT+1 * `Etc/GMT+10` - Etc/GMT+10 * `Etc/GMT+11` - Etc/GMT+11 * `Etc/GMT+12` - Etc/GMT+12 * `Etc/GMT+2` - Etc/GMT+2 * `Etc/GMT+3` - Etc/GMT+3 * `Etc/GMT+4` - Etc/GMT+4 * `Etc/GMT+5` - Etc/GMT+5 * `Etc/GMT+6` - Etc/GMT+6 * `Etc/GMT+7` - Etc/GMT+7 * `Etc/GMT+8` - Etc/GMT+8 * `Etc/GMT+9` - Etc/GMT+9 * `Etc/GMT-0` - Etc/GMT-0 * `Etc/GMT-1` - Etc/GMT-1 * `Etc/GMT-10` - Etc/GMT-10 * `Etc/GMT-11` - Etc/GMT-11 * `Etc/GMT-12` - Etc/GMT-12 * `Etc/GMT-13` - Etc/GMT-13 * `Etc/GMT-14` - Etc/GMT-14 * `Etc/GMT-2` - Etc/GMT-2 * `Etc/GMT-3` - Etc/GMT-3 * `Etc/GMT-4` - Etc/GMT-4 * `Etc/GMT-5` - Etc/GMT-5 * `Etc/GMT-6` - Etc/GMT-6 * `Etc/GMT-7` - Etc/GMT-7 * `Etc/GMT-8` - Etc/GMT-8 * `Etc/GMT-9` - Etc/GMT-9 * `Etc/GMT0` - Etc/GMT0 * `Etc/Greenwich` - Etc/Greenwich * `Etc/UCT` - Etc/UCT * `Etc/UTC` - Etc/UTC * `Etc/Universal` - Etc/Universal * `Etc/Zulu` - Etc/Zulu * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belfast` - Europe/Belfast * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kiev` - Europe/Kiev * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Nicosia` - Europe/Nicosia * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Tiraspol` - Europe/Tiraspol * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Uzhgorod` - Europe/Uzhgorod * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zaporozhye` - Europe/Zaporozhye * `Europe/Zurich` - Europe/Zurich * `Factory` - Factory * `GB` - GB * `GB-Eire` - GB-Eire * `GMT` - GMT * `GMT+0` - GMT+0 * `GMT-0` - GMT-0 * `GMT0` - GMT0 * `Greenwich` - Greenwich * `HST` - HST * `Hongkong` - Hongkong * `Iceland` - Iceland * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Iran` - Iran * `Israel` - Israel * `Jamaica` - Jamaica * `Japan` - Japan * `Kwajalein` - Kwajalein * `Libya` - Libya * `MET` - MET * `MST` - MST * `MST7MDT` - MST7MDT * `Mexico/BajaNorte` - Mexico/BajaNorte * `Mexico/BajaSur` - Mexico/BajaSur * `Mexico/General` - Mexico/General * `NZ` - NZ * `NZ-CHAT` - NZ-CHAT * `Navajo` - Navajo * `PRC` - PRC * `PST8PDT` - PST8PDT * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Enderbury` - Pacific/Enderbury * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Johnston` - Pacific/Johnston * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Ponape` - Pacific/Ponape * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Samoa` - Pacific/Samoa * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Truk` - Pacific/Truk * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `Pacific/Yap` - Pacific/Yap * `Poland` - Poland * `Portugal` - Portugal * `ROC` - ROC * `ROK` - ROK * `Singapore` - Singapore * `Turkey` - Turkey * `UCT` - UCT * `US/Alaska` - US/Alaska * `US/Aleutian` - US/Aleutian * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/East-Indiana` - US/East-Indiana * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Indiana-Starke` - US/Indiana-Starke * `US/Michigan` - US/Michigan * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `US/Samoa` - US/Samoa * `UTC` - UTC * `Universal` - Universal * `W-SU` - W-SU * `WET` - WET * `Zulu` - Zulu * `localtime` - localtime TimezoneRequest: type: object properties: timezone: $ref: '#/components/schemas/TimezoneEnum' required: - timezone User: type: object properties: username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 required: - username UserProfile: type: object properties: user: $ref: '#/components/schemas/User' mugshot: type: string format: uri readOnly: true default: '' institution: type: string maxLength: 100 department: type: string maxLength: 100 location: $ref: '#/components/schemas/LocationEnum' website: type: string maxLength: 150 required: - department - institution - location - mugshot - user UserRequest: type: object properties: username: type: string minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 required: - username UserUpload: type: object properties: pk: type: string format: uuid readOnly: true title: Id created: type: string format: date-time readOnly: true filename: type: string readOnly: true key: type: string readOnly: true s3_upload_id: type: string readOnly: true status: type: string readOnly: true api_url: type: string readOnly: true required: - api_url - created - filename - key - pk - s3_upload_id - status UserUploadComplete: type: object properties: pk: type: string format: uuid readOnly: true title: Id created: type: string format: date-time readOnly: true filename: type: string readOnly: true key: type: string readOnly: true s3_upload_id: type: string readOnly: true status: type: string readOnly: true api_url: type: string readOnly: true required: - api_url - created - filename - key - pk - s3_upload_id - status UserUploadCreate: type: object properties: pk: type: string format: uuid readOnly: true title: Id created: type: string format: date-time readOnly: true filename: type: string maxLength: 128 key: type: string readOnly: true s3_upload_id: type: string readOnly: true status: type: string readOnly: true api_url: type: string readOnly: true required: - api_url - created - filename - key - pk - s3_upload_id - status UserUploadCreateRequest: type: object properties: filename: type: string minLength: 1 maxLength: 128 required: - filename UserUploadParts: type: object properties: pk: type: string format: uuid readOnly: true title: Id created: type: string format: date-time readOnly: true filename: type: string readOnly: true key: type: string readOnly: true s3_upload_id: type: string readOnly: true status: type: string readOnly: true api_url: type: string readOnly: true parts: type: array items: $ref: '#/components/schemas/Part' readOnly: true required: - api_url - created - filename - key - parts - pk - s3_upload_id - status UserUploadPresignedURLs: type: object properties: pk: type: string format: uuid readOnly: true title: Id created: type: string format: date-time readOnly: true filename: type: string readOnly: true key: type: string readOnly: true s3_upload_id: type: string readOnly: true status: type: string readOnly: true api_url: type: string readOnly: true presigned_urls: type: object additionalProperties: type: string readOnly: true required: - api_url - created - filename - key - pk - presigned_urls - s3_upload_id - status WindowPreset: type: object properties: pk: type: integer readOnly: true title: ID slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ title: type: string maxLength: 255 description: type: string nullable: true center: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true width: type: integer maximum: 2147483647 minimum: 1 nullable: true lower_percentile: type: integer maximum: 100 minimum: 0 nullable: true upper_percentile: type: integer maximum: 100 minimum: 0 nullable: true required: - pk - slug - title Workstation: type: object properties: pk: type: string format: uuid readOnly: true title: Id title: type: string maxLength: 255 slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ url: type: string format: uri readOnly: true required: - pk - slug - title - url WorkstationConfig: type: object properties: pk: type: string format: uuid readOnly: true title: Id slug: type: string readOnly: true pattern: ^[-a-zA-Z0-9_]+$ title: type: string maxLength: 255 description: type: string nullable: true created: type: string format: date-time readOnly: true modified: type: string format: date-time readOnly: true creator: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. readOnly: true image_context: type: string readOnly: true window_presets: type: array items: $ref: '#/components/schemas/WindowPreset' readOnly: true default_window_preset: $ref: '#/components/schemas/WindowPreset' default_slab_thickness_mm: type: number format: double default_slab_render_method: type: string readOnly: true default_orientation: type: string readOnly: true default_overlay_alpha: type: number format: double overlay_luts: type: array items: $ref: '#/components/schemas/LookUpTable' readOnly: true default_overlay_lut: $ref: '#/components/schemas/LookUpTable' default_overlay_interpolation: type: string readOnly: true default_image_interpolation: type: string readOnly: true default_limit_view_area_to_image_volume: type: boolean description: When enabled, the view area is limited to the image volume, ensuring that changes in orientation and panning do not obscure parts of the image ghosting_slice_depth: type: integer maximum: 32767 minimum: 0 description: The number of slices a polygon annotation should remain visible for on slices surrounding the annotation slice. overlay_segments: description: 'The schema that defines how categories of values in the overlay images are differentiated. Example usage: [{"name": "background", "visible": true, "voxel_value": 0},{"name": "tissue", "visible": true, "voxel_value": 1}]. If a categorical overlay is shown, it is possible to show toggles to change the visibility of the different overlay categories. To do so, configure the categories that should be displayed. Data from the algorithm''s output.json can be added as an extra label to each toggle using jinja templating. For example: [{"name": "Level 0", "visible": false, "voxel_value": 0, "metric_template": "{{metrics.volumes[0]}} mm³"}]. ' key_bindings: description: The schema that overwrites the mapping between keyboard shortcuts and viewer actions default_zoom_scale: type: number format: double default_brush_size: type: string format: decimal pattern: ^-?\d{0,9}(?:\.\d{0,7})?$ nullable: true description: Default brush diameter in millimeters for creating annotations default_annotation_color: type: string nullable: true description: Default color for displaying and creating annotations pattern: ^#[a-fA-F0-9]{6}$ maxLength: 7 default_annotation_line_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Default line width in pixels for displaying and creating annotations show_image_info_plugin: type: boolean description: A plugin that shows meta-data information derived from image headers as well as any configured case text for reader studies show_display_plugin: type: boolean description: A plugin that allows control over display properties such as window preset, slab thickness, or orientation show_image_switcher_plugin: type: boolean description: A plugin that allows switching images when viewing algorithm outputs show_algorithm_output_plugin: type: boolean description: A plugin that shows algorithm outputs, including navigation controls show_overlay_plugin: type: boolean description: A plugin that contains overlay-related controls, such as the overlay-selection tool and overlay-segmentation visibility show_annotation_statistics_plugin: type: boolean description: A plugin that allows analysis of segmentations. It shows voxel value statistics of annotated areas. show_swivel_tool: type: boolean description: A tool that allows swiveling the image around axes to view a custom orientation show_invert_tool: type: boolean description: A tool/button that allows inverting the displayed pixel colors of an image show_flip_tool: type: boolean description: A tool/button that allows vertical flipping/mirroring of an image show_window_level_tool: type: boolean description: A tool that allows selection of window presets and changing the window width/center show_reset_tool: type: boolean description: A tool/button that resets all display properties of the images to defaults show_overlay_selection_tool: type: boolean description: A tool that allows switching overlay images when viewing algorithm outputs show_lut_selection_tool: type: boolean title: Show overlay-lut selection tool description: A tool that allows switching between the overlay-lut presets show_annotation_counter_tool: type: boolean description: A tool that can be used to show summary statistics of annotations within an area enabled_preprocessors: type: array items: type: string readOnly: true auto_jump_center_of_gravity: type: boolean description: Enables a jump to center of gravity of the first output when viewing algorithm outputs or the first overlay segment when viewing a reader study link_images: type: boolean description: Start with the images linked link_panning: type: boolean description: When panning and the images are linked, they share any new position link_zooming: type: boolean description: When zooming and the images are linked, they share any new zoom level link_slicing: type: boolean description: When scrolling and the images are linked, they share any slice changes link_orienting: type: boolean description: When orienting and the images are linked, they share any new orientation link_windowing: type: boolean description: When changing window setting and the images are linked, they share any new window width/center link_inverting: type: boolean description: When inverting images and the images are linked, they share any new invert state link_flipping: type: boolean description: When flipping images and the images are linked, they share any new flip state point_bounding_box_size_mm: type: number format: double required: - created - creator - default_image_interpolation - default_orientation - default_overlay_alpha - default_overlay_interpolation - default_overlay_lut - default_slab_render_method - default_slab_thickness_mm - default_window_preset - default_zoom_scale - enabled_preprocessors - image_context - modified - overlay_luts - pk - point_bounding_box_size_mm - slug - title - window_presets securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid knoxApiToken: type: http scheme: bearer