You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: devel/api/usage/index.rst
+44-16Lines changed: 44 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -281,29 +281,39 @@ Example:
281
281
282
282
Tracking dataset upload progress
283
283
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
284
-
When an upload request is executed, GeoNode creates an “upload object” and keeps updating its state and progress (it’s a property attribute, calculated on getting the response) attributes as the resource is being created and configured in Geoserver.
285
-
The states used include:
286
-
-READY
287
-
-RUNNING
288
-
-PENDING
289
-
-WAITING
290
-
-INCOMPLETE
291
-
-COMPLETE
292
-
-INVALID
293
-
-PROCESSED
294
-
295
-
When the dataset is successfully uploaded, the final state of the upload isset to ``PROCESSED``and progress is calculated as``100.0``.
296
-
297
-
In order to view ongoing uploads, and their states, you can use the API``GET/api/v2/uploads``or``GET/api/v2/uploads/{id}``if the upload idis known. You can also filter uploads with state.
298
-
Eg ``GET/api/v2/uploads?filter{state}=PROCESSED``
284
+
When an upload request is executed, GeoNode creates an "Execution request"and keeps updating its state and progress (it’s a property attribute, calculated on getting the response) attributes as the resource is being created and configured in Geoserver.
285
+
An execution can be in one of the following status:
286
+
-``ready``
287
+
-``running``
288
+
-``failed``
289
+
-``finished``
290
+
291
+
When the dataset is successfully uploaded, the final state of the upload isset to ``finished``.
292
+
293
+
In order to view status of the execution, the API method ``GET/api/v2/executionrequest/{execution_id}`` where ``{execution_id}``is the value returned by the initial call to the upload API.
294
+
295
+
The returned object contains, beyond all the information related to the execution, the inputs that were passed to the execution request, and output params specific to the type of execution.
296
+
In the case of a dataset upload, the output params contain the URL of the catalog page for the new datast.
0 commit comments