AGNX

Wiki

User Tools

Site Tools

Trace:
dev:sapi:get_item_info

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
dev:sapi:get_item_info [2022/04/20 18:00] – [JSON OUTPUT (content-type: text/plain)] vikkidev:sapi:get_item_info [2022/04/20 18:08] (current) – vikki
Line 8: Line 8:
 **Description:** Returns information about an item (file or folder). Information you want to retrieve is specified using the fields parameter, which is a string consisting of comma separated field names. **Description:** Returns information about an item (file or folder). Information you want to retrieve is specified using the fields parameter, which is a string consisting of comma separated field names.
  
-**INPUT (via GET or POST)**+---- 
 + 
 +===== INPUT (via GET or POST) =====
  
 Mandatory parameters are: **sid, path**\\  Mandatory parameters are: **sid, path**\\ 
 Optional parameters are: **fields, ofmt** Optional parameters are: **fields, ofmt**
  
----- 
  
 ==== sid ==== ==== sid ====
 Session id of the login user. [mandatory] Session id of the login user. [mandatory]
  
- 
----- 
  
 ==== path ==== ==== path ====
Line 29: Line 28:
   * <ff:'Courier New'>path=/Company Share/Minutes/</ff> - get information about the folder Minutes in "Company Share"   * <ff:'Courier New'>path=/Company Share/Minutes/</ff> - get information about the folder Minutes in "Company Share"
  
----- 
  
 ==== fields ==== ==== fields ====
Line 50: Line 48:
   * **lock_owner** is the lock owner for a lock placed on the item. Value is in the form of and "email" e.g. name@host that identifies a user account, but does not necessarily mean a valid email address. Only applicable to files and NOT folders. For folders, this value is always empty. The (legacy) lock value above is "yes" if this value is not empty.   * **lock_owner** is the lock owner for a lock placed on the item. Value is in the form of and "email" e.g. name@host that identifies a user account, but does not necessarily mean a valid email address. Only applicable to files and NOT folders. For folders, this value is always empty. The (legacy) lock value above is "yes" if this value is not empty.
   * **ucar** is the JSON object the represents the UCAR settings associated with this item. Currently only applicable to folders in Company Share and Company HomePage. For folders elsewhere and regular files, the value returned is empty. An example of such a JSON object is documented in an example below, as the value of the property "ucar". Subject to user privilege, only ucar groups of which the user is member of will be shown.   * **ucar** is the JSON object the represents the UCAR settings associated with this item. Currently only applicable to folders in Company Share and Company HomePage. For folders elsewhere and regular files, the value returned is empty. An example of such a JSON object is documented in an example below, as the value of the property "ucar". Subject to user privilege, only ucar groups of which the user is member of will be shown.
- 
----- 
  
 ==== ofmt ==== ==== ofmt ====
Line 64: Line 60:
 ---- ----
  
-==== Legacy "flat" OUTPUT (content-type: text/plain) ====+===== Legacy "flat" OUTPUT (content-type: text/plain) =====
  
 Successful return: Successful return:
Line 84: Line 80:
 ---- ----
  
-==== JSON OUTPUT (content-type: text/plain) ====+===== JSON OUTPUT (content-type: text/plain) =====
  
 Successful return: Successful return:
dev/sapi/get_item_info.1650448814.txt.gz · Last modified: 2022/04/20 18:00 by vikki

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki