Mercurial > hg > orthanc
changeset 6945:7f50469de86e
doc: clarify Timeout argument in DICOM jobs
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Thu, 11 Jun 2026 10:47:07 +0200 |
| parents | 093efd260e36 |
| children | 94af24a493de |
| files | OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp |
| diffstat | 1 files changed, 8 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp Fri Jun 05 18:51:51 2026 +0200 +++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestModalities.cpp Thu Jun 11 10:47:07 2026 +0200 @@ -227,7 +227,7 @@ .SetDescription("Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: " "https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo") .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-ECHO command, in seconds. Orthanc will close the DICOM association if no C-ECHO answer is received within this time period.", false) + "DICOM SCU Timeout for this C-ECHO command, in seconds. Orthanc will close the DICOM association if no C-ECHO answer is received within this time period.", false) .SetUriArgument("id", "Identifier of the modality of interest"); return; } @@ -683,7 +683,7 @@ .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String, "Local AET that is used for this commands, defaults to `DicomAet` configuration option or `LocalAet` in the `DicomModalities`. ", false) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-FIND command and subsequent C-GET/C-MOVE retrievals, in seconds (new in Orthanc 1.9.1). Orthanc will close the related DICOM associations if no DICOM messages are received within this time period.", false) + "DICOM SCU Timeout for this C-FIND command and subsequent C-GET/C-MOVE retrievals, in seconds (new in Orthanc 1.9.1). Orthanc will close the related DICOM associations if no DICOM messages are received within this time period.", false) .SetAnswerField("ID", RestApiCallDocumentation::Type_String, "Identifier of the query, to be used with `/queries/{id}`") .SetAnswerField("Path", RestApiCallDocumentation::Type_String, @@ -1033,7 +1033,7 @@ "AET of the target modality. By default, the AET of Orthanc is used, as defined in the " "`DicomAet` configuration option.", false) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-MOVE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE sub-operations or responses) are received within this time period.", false) + "DICOM SCU Timeout for this C-MOVE or C-GET command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE sub-operations or responses) are received within this time period.", false) .SetRequestField(KEY_RETRIEVE_METHOD, RestApiCallDocumentation::Type_String, "Force usage of C-MOVE or C-GET to retrieve the resource. If note defined in the payload, " "the retrieve method is defined in the DicomDefaultRetrieveMethod configuration or in " @@ -1246,7 +1246,7 @@ .SetRequestField(KEY_QUERY, RestApiCallDocumentation::Type_JsonObject, "Associative array containing the filter on the values of the DICOM tags", true) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-FIND command, in seconds (new in Orthanc 1.9.1)", false) + "DICOM SCU Timeout for this C-FIND command, in seconds (new in Orthanc 1.9.1)", false) .SetAnswerField("ID", RestApiCallDocumentation::Type_JsonObject, "Identifier of the query, to be used with `/queries/{id}`") .SetAnswerField("Path", RestApiCallDocumentation::Type_JsonObject, @@ -1503,7 +1503,7 @@ "Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: " "https://orthanc.uclouvain.be/book/users/storage-commitment.html#chaining-c-store-with-storage-commitment", false) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-STORE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE responses) are received within this time period.", false) + "DICOM SCU Timeout for this C-STORE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE responses) are received within this time period.", false) .SetUriArgument("id", "Identifier of the modality of interest"); return; } @@ -1671,7 +1671,7 @@ "Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU " "commands, defaults to `DicomAet` configuration option in order to do a simple query/retrieve", false) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-MOVE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE sub-operations or responses) are received within this time period.", false) + "DICOM SCU Timeout for this C-MOVE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE sub-operations or responses) are received within this time period.", false) .SetUriArgument("id", "Identifier of the modality of interest"); return; } @@ -1720,7 +1720,7 @@ .SetRequestField(KEY_LOCAL_AET, RestApiCallDocumentation::Type_String, "Local AET that is used for this commands, defaults to `DicomAet` configuration option or `LocalAet` in the `DicomModalities`. ", false) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the C-GET command, in seconds. Orthanc will close the DICOM association if no DICOM messages are received within this time period.", false) + "DICOM SCU Timeout for this C-GET command, in seconds. Orthanc will close the DICOM association if no DICOM messages are received within this time period.", false) .SetUriArgument("id", "Identifier of the modality of interest"); return; } @@ -2363,7 +2363,7 @@ "be checked by storage commitment. This is a list of JSON objects that must contain the " "`SOPClassUID` and `SOPInstanceUID` fields.", true) .SetRequestField(KEY_TIMEOUT, RestApiCallDocumentation::Type_Number, - "Timeout for the storage commitment command (new in Orthanc 1.9.1)", false) + "DICOM SCU Timeout for this storage commitment command (new in Orthanc 1.9.1)", false) .SetAnswerField("ID", RestApiCallDocumentation::Type_JsonObject, "Identifier of the storage commitment report, to be used with `/storage-commitment/{id}`") .SetAnswerField("Path", RestApiCallDocumentation::Type_JsonObject,
