changeset 6332:c2394342db8e

doc
author Alain Mazy <am@orthanc.team>
date Thu, 02 Oct 2025 12:38:04 +0200
parents 09654a76d69d
children d60175123eb0
files NEWS OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp
diffstat 2 files changed, 3 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Tue Sep 30 15:56:43 2025 +0200
+++ b/NEWS	Thu Oct 02 12:38:04 2025 +0200
@@ -14,7 +14,7 @@
 * Fix: C-Get SCU jobs or HTTP responses were always successful even if the C-Get operation
   actually failed.
 * C-Store, C-Move and C-Get jobs and HTTP responses now include a new "DimseErrorStatus" 
-  field if the operation fails.
+  field (ONLY if the operation fails).
 
 
 Maintenance
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp	Tue Sep 30 15:56:43 2025 +0200
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestApi.cpp	Thu Oct 02 12:38:04 2025 +0200
@@ -493,7 +493,7 @@
                        "If `true`, run the job in asynchronous mode, which means that the REST API call will immediately "
                        "return, reporting the identifier of a job. Prefer this flavor wherever possible.", false)
       .SetRequestField(KEY_PRIORITY, RestApiCallDocumentation::Type_Number,
-                       "In asynchronous mode, the priority of the job. The higher the value, the higher the priority.", false)
+                       "In asynchronous mode, the priority of the job. The higher the value, the higher the priority.  Default value is `0`", false)
       .SetAnswerField("ID", RestApiCallDocumentation::Type_String, "In asynchronous mode, identifier of the job")
       .SetAnswerField("Path", RestApiCallDocumentation::Type_String, "In asynchronous mode, path to access the job in the REST API");
   }
@@ -504,7 +504,7 @@
     DocumentSubmitGenericJob(call);
     call.GetDocumentation()
       .SetRequestField(KEY_PERMISSIVE, RestApiCallDocumentation::Type_Boolean,
-                       "If `true`, ignore errors during the individual steps of the job.", false)
+                       "If `true`, ignore errors during the individual steps of the job.  Default value is `false`.", false)
       .SetRequestField(KEY_USER_DATA, RestApiCallDocumentation::Type_JsonObject,
                        "User data that will travel along with the job.", false);
   }