khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update ocs-api-overview.rst

Browse Source 
- Updated the displayed data to resemble the actual query results as of v17.0.2
- Added `GET /ocs/v1.php/cloud/users` paragraph
- Fixed some typos
This commit is contained in:
bpcurse
2020-01-06 06:11:39 +01:00
committed by GitHub
parent d18e54c3f9
commit e5a3fb3aa6
1 changed files with 70 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
developer_manual/client_apis/OCS/ocs-api-overview.rst
View File

@@ -44,24 +44,74 @@ This request returns the available metadata of a user. Admin users can see the i
<itemsperpage></itemsperpage>
</meta>
<data>
<enabled>true</enabled>
<enabled>1</enabled>
<storageLocation>/path/to/storage/location/userid</storageLocation>
<id>userid</id>
<lastLogin>1578283711000</lastLogin>
<backend>Database</database>
<subadmin/>
<quota>
<free>338696790016</free>
<used>7438874</used>
<total>338704228890</total>
<relative>0</relative>
<quota>-3</quota>
<free>20632824998</free>
<used>842011482</used>
<total>21474836480</total>
<relative>3.92</relative>
<quota>21474836480</quota>
</quota>
<email>user@foo.de</email>
<displayname>admin</displayname>
<displayname>John Doe</displayname>
<phone></phone>
<address></address>
<webpage></webpage>
<twitter>schiessle</twitter>
<website>https://example.com</website>
<twitter></twitter>
<groups>
<element>1st group</element>
<element>2nd group</element>
<element>3rd group</element>
<element>... group</element>
</groups>
<language>de</language>
<locale>de_DE</locale>
<backendCapabilities>
<setDisplayName>1</setDisplayName>
<setPassword>1</setPassword>
</backendCapabilities>
</data>
</ocs>
User metadata - List user IDs
-----------------------------
This request returns a list containing all user IDs. Only admin users can query the list.
.. code::
GET /ocs/v1.php/cloud/users
.. code:: xml
<?xml version="1.0"?>
<ocs>
<meta>
<status>ok</status>
<statuscode>100</statuscode>
<message>OK</message>
<totalitems></totalitems>
<itemsperpage></itemsperpage>
</meta>
<data>
<users>
<element>1st_user</element>
<element>2nd_user</element>
<element>3rd_user</element>
<element>..._user</element>
</users>
</data>
</ocs>
Capabilities API
----------------
@@ -86,11 +136,12 @@ Clients can obtain capabilities provided by the Nextcloud server and its apps vi
</meta>
<data>
<version>
<major>12</major>
<major>17</major>
<minor>0</minor>
<micro>0</micro>
<string>12.0 beta 4</string>
<micro>2</micro>
<string>17.0.2</string>
<edition></edition>
<extendedSupport></extendedSupport>
</version>
<capabilities>
<core>
@@ -105,7 +156,7 @@ Clients can obtain capabilities provided by the Nextcloud server and its apps vi
Theming capabilities
--------------------
Values of the theming app are exposed though the capabilities API, allowing client developers to adjust the look of clients to the theming of different Nextcloud instances.
Values of the theming app are exposed through the capabilities API, allowing client developers to adjust the look of clients to the theming of different Nextcloud instances.
.. code:: xml
@@ -114,8 +165,12 @@ Values of the theming app are exposed though the capabilities API, allowing clie
<url>https://nextcloud.com</url>
<slogan>A safe home for all your data</slogan>
<color>#0082c9</color>
<color-text>#ffffff</color-text>
<color-element>#006295</color-element>
<logo>http://cloud.example.com/index.php/apps/theming/logo?v=1</logo>
<background>http://cloud.example.com/index.php/apps/theming/logo?v=1</background>
<background-plain></background-plain>
<background-default></background-default>
</theming>
@@ -128,8 +183,8 @@ It might be required to give a 3rd party access to a file however you do not
want to hand over credentials to the 3rd party. An example of this is playing
files in an external media player on mobile devices.
To solve this issue there is a way to request a unique public link to a single.
This link will be valid for 24 hours after wards it will be removed.
To solve this issue there is a way to request a unique public link to a single file.
This link will be valid for 24 hours afterwards it will be removed.
To obtain a direct link: