Mercurial > hg > orthanc-book

comparison OpenAPI/orthanc-openapi.json @ 763:4e9dc26a5cb9 Orthanc-1.9.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc 1.9.7
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 31 Aug 2021 11:24:43 +0200
parents 11ca20599c75
children 01fa632daae9
comparison
equal deleted inserted replaced
762:b3fe7b0a09fc 763:4e9dc26a5cb9
1 { 1 {
2 "info" : { 2 "info" : {
3 "description" : "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).", 3 "description" : "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source](https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).",
4 "title" : "Orthanc API", 4 "title" : "Orthanc API",
5 "version" : "1.9.6" 5 "version" : "1.9.7"
6 }, 6 },
7 "openapi" : "3.0.0", 7 "openapi" : "3.0.0",
8 "paths" : { 8 "paths" : {
9 "/changes" : { 9 "/changes" : {
10 "delete" : { 10 "delete" : {
3263 "content" : { 3263 "content" : {
3264 "application/json" : { 3264 "application/json" : {
3265 "schema" : { 3265 "schema" : {
3266 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)", 3266 "description" : "JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)",
3267 "example" : [ 3267 "example" : [
3268 "0190e616-f520-4128-98f1-ab681bd4633a", 3268 "0c686aae-1509-4179-a8c5-1824c180bb84",
3269 "0a43a06e-f53a-45e5-8a2e-ce9702f81247", 3269 "f30d99df-3a10-480f-96a9-d0701550f07c"
3270 "4ee11497-4381-4979-b999-d96b9566bef1",
3271 "..."
3272 ] 3270 ]
3273 } 3271 }
3274 } 3272 }
3275 }, 3273 },
3276 "description" : "" 3274 "description" : ""
7009 "connectivity-checks", 7007 "connectivity-checks",
7010 "dicom-web", 7008 "dicom-web",
7011 "gdcm", 7009 "gdcm",
7012 "mysql-index", 7010 "mysql-index",
7013 "mysql-storage", 7011 "mysql-storage",
7012 "odbc-index",
7013 "odbc-storage",
7014 "postgresql-index", 7014 "postgresql-index",
7015 "postgresql-storage", 7015 "postgresql-storage",
7016 "serve-folders", 7016 "serve-folders",
7017 "stone-rtviewer",
7017 "stone-webviewer", 7018 "stone-webviewer",
7019 "tcia",
7018 "transfers", 7020 "transfers",
7019 "web-viewer", 7021 "web-viewer",
7020 "worklists", 7022 "worklists",
7021 "wsi" 7023 "wsi"
7022 ] 7024 ]
13257 }, 13259 },
13258 "KeepSource" : { 13260 "KeepSource" : {
13259 "description" : "If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.", 13261 "description" : "If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.",
13260 "type" : "boolean" 13262 "type" : "boolean"
13261 }, 13263 },
13264 "Level" : {
13265 "description" : "Level of the modification (`Patient`, `Study`, `Series` or `Instance`). If absent, the level defaults to `Instance`, but is set to `Patient` if `PatientID` is modified, to `Study` if `StudyInstanceUID` is modified, or to `Series` if `SeriesInstancesUID` is modified. (new in Orthanc 1.9.7)",
13266 "type" : "string"
13267 },
13262 "Permissive" : { 13268 "Permissive" : {
13263 "description" : "If `true`, ignore errors during the individual steps of the job.", 13269 "description" : "If `true`, ignore errors during the individual steps of the job.",
13264 "type" : "boolean" 13270 "type" : "boolean"
13265 }, 13271 },
13266 "Priority" : { 13272 "Priority" : {
14309 "parameters" : [], 14315 "parameters" : [],
14310 "responses" : { 14316 "responses" : {
14311 "200" : { 14317 "200" : {
14312 "content" : { 14318 "content" : {
14313 "text/plain" : { 14319 "text/plain" : {
14314 "example" : "orthanc_count_instances 2552 1629103886979\northanc_count_patients 8 1629103886979\northanc_count_series 26 1629103886979\northanc_count_studies 8 1629103886979\northanc_dicom_cache_count 231 1629098711537\northanc_dicom_cache_size 114.333038 1629098711537\northanc_disk_size_mb 1018.65021 1629103886979\northanc_jobs_completed 10 1629103886979\northanc_jobs_failed 4 1629103886979\northanc_jobs_pending 0 1629103886979\northanc_jobs_running 0 1629103886979\northanc_jobs_success 6 1629103886979\northanc_rest_api_active_requests 1 1629103886977\northanc_rest_api_duration_ms 1790 1629103882403\northanc_storage_read_duration_ms 52 1629103881241\northanc_uncompressed_size_mb 1018.65021 1629103886979\n" 14320 "example" : "orthanc_count_instances 2552 1630401803782\northanc_count_patients 8 1630401803782\northanc_count_series 26 1630401803782\northanc_count_studies 8 1630401803782\northanc_dicom_cache_count 213 1630393626028\northanc_dicom_cache_size 125.938728 1630393626028\northanc_disk_size_mb 1018.65021 1630401803782\northanc_jobs_completed 2 1630401803782\northanc_jobs_failed 0 1630401803782\northanc_jobs_pending 0 1630401803782\northanc_jobs_running 0 1630401803782\northanc_jobs_success 2 1630401803782\northanc_rest_api_active_requests 1 1630401803781\northanc_rest_api_duration_ms 353 1630401802149\northanc_storage_read_duration_ms 0 1630401797848\northanc_uncompressed_size_mb 1018.65021 1630401803782\n"
14315 } 14321 }
14316 }, 14322 },
14317 "description" : "" 14323 "description" : ""
14318 } 14324 }
14319 }, 14325 },
14328 "parameters" : [], 14334 "parameters" : [],
14329 "responses" : { 14335 "responses" : {
14330 "200" : { 14336 "200" : {
14331 "content" : { 14337 "content" : {
14332 "text/plain" : { 14338 "text/plain" : {
14333 "example" : "20210816T085127", 14339 "example" : "20210831T092323",
14334 "schema" : { 14340 "schema" : {
14335 "description" : "The UTC time" 14341 "description" : "The UTC time"
14336 } 14342 }
14337 } 14343 }
14338 }, 14344 },
14350 "parameters" : [], 14356 "parameters" : [],
14351 "responses" : { 14357 "responses" : {
14352 "200" : { 14358 "200" : {
14353 "content" : { 14359 "content" : {
14354 "text/plain" : { 14360 "text/plain" : {
14355 "example" : "20210816T085127", 14361 "example" : "20210831T092323",
14356 "schema" : { 14362 "schema" : {
14357 "description" : "The local time" 14363 "description" : "The local time"
14358 } 14364 }
14359 } 14365 }
14360 }, 14366 },