khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 10:46:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

fix(TaskProcessing): Fix typo in URL and remove a non-existing endpoint

Browse Source 
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
This commit is contained in:
Marcel Klehr
2024-12-16 09:46:37 +01:00
parent 6eac0ea62b
commit 084a3986b7
1 changed files with 1 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst
View File

@@ -177,7 +177,7 @@ Get task file contents
.. versionadded:: 30.0.0
* Method: ``GET``
* Endpoint: ``/task/{id}/file/{fileId}``
* Endpoint: ``/tasks/{id}/file/{fileId}``
* Response:
- Status code:
@@ -187,70 +187,3 @@ Get task file contents
- Data:
+ If ``200 OK`` this endpoint returns the raw data of the file
+ ``message`` - Only provided when not ``200 OK``, an error message in the user's language, ready to be displayed
Set task progress
-----------------
.. versionadded:: 30.0.0
* Method: ``GET``
* Endpoint: ``/task/{id}/progress``
* Data:
+-----------------+-------------+--------------------------------------------------------------------------------+
| field | type | Description |
+-----------------+-------------+--------------------------------------------------------------------------------+
|``progress`` | float | A number between 0-1 indicating the task progress |
+-----------------+-------------+--------------------------------------------------------------------------------+
* Response:
- Status code:
+ ``200 OK``
+ ``404 Not Found`` - When the task could not be found
- Data:
- Data:
+ ``input`` - Only provided in case of ``200 OK``, the task input, array
+ ``type`` - Only provided in case of ``200 OK``, the task type, string
+ ``id`` - Only provided in case of ``200 OK``, the assigned task id, int
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see backend API
+ ``userId`` - Only provided in case of ``200 OK``, the originating userId of the task, string
+ ``appId`` - Only provided in case of ``200 OK``, the originating appId of the task, string
+ ``customId`` - Only provided in case of ``200 OK``, the custom id of the task, string
+ ``output`` - Only provided in case of ``200 OK``, the output from the model, array or null
+ ``message`` - Only provided when not ``200 OK``, an error message in the user's language, ready to be displayed
Set task result
---------------
.. versionadded:: 30.0.0
* Method: ``POST``
* Endpoint: ``/task/{id}/result``
* Data:
+-----------------+-------------+--------------------------------------------------------------------------------+
| field | type | Description |
+-----------------+-------------+--------------------------------------------------------------------------------+
|``output`` | array | The task output if the task was successful (optional) |
+-----------------+-------------+--------------------------------------------------------------------------------+
|``errorMessage`` | string | The error message if the task failed (optional) |
+-----------------+-------------+--------------------------------------------------------------------------------+
* Response:
- Status code:
+ ``200 OK``
+ ``404 Not Found`` - When the task could not be found
- Data:
- Data:
+ ``input`` - Only provided in case of ``200 OK``, the task input, array
+ ``type`` - Only provided in case of ``200 OK``, the task type, string
+ ``id`` - Only provided in case of ``200 OK``, the assigned task id, int
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see backend API
+ ``userId`` - Only provided in case of ``200 OK``, the originating userId of the task, string
+ ``appId`` - Only provided in case of ``200 OK``, the originating appId of the task, string
+ ``customId`` - Only provided in case of ``200 OK``, the custom id of the task, string
+ ``output`` - Only provided in case of ``200 OK``, the output from the model, array or null
+ ``message`` - Only provided when not ``200 OK``, an error message in the user's language, ready to be displayed