Mercurial > hg > orthanc-book
changeset 287:eeb2c72dd5df
api doc: asynchronous
author | Alain Mazy <alain@mazy.be> |
---|---|
date | Tue, 24 Sep 2019 17:44:21 +0200 |
parents | 833d4ec1c1e8 |
children | 2e71e7cc0ec5 |
files | OpenAPI/orthanc-openapi.yaml |
diffstat | 1 files changed, 3 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/OpenAPI/orthanc-openapi.yaml Tue Sep 24 10:15:55 2019 +0200 +++ b/OpenAPI/orthanc-openapi.yaml Tue Sep 24 17:44:21 2019 +0200 @@ -270,7 +270,9 @@ items: type: string Asynchronous: - description: true to create a job and return immediately, false to wait for job completion + description: true to create a job and return immediately, false to wait for job completion. + The response will vary according to this parameter. If the call is synchronous, you'll receive + a completed job in the response while if the call is asynchronous, you'll receive a job identifier. type: boolean example: { "Resources" : ["62cdfbea-07c71f0c-cd643b19-841a306a-01221339"],