Changeset 2429 in main for trunk/docs


Ignore:
Timestamp:
05/27/13 09:53:01 (6 years ago)
Author:
pcosquer
Message:

api: adds a route to lock several files in one transactionnal block

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/en/devel/http-api.rst

    r2417 r2429  
    522522     
    523523 
     524.. py:function:: lock_files 
     525     
     526    .. versionadded:: 1.1 
     527 
     528    Locks several files in one transactional block. 
     529 
     530    Files are set by a POST parameter, ``files`` which must be a json list 
     531    of ids of :class:`.DocumentFile` to be locked. 
     532 
     533    If one file can not be locked, no files are locked. 
     534 
     535    :url: :samp:`{server}/api/lock_files` 
     536    :type: POST 
     537    :login required: yes 
     538    :implemented by: :func:`plmapp.views.api.lock_files` 
     539    :post param: files, a list of ids of document files 
     540    :returned fields: None 
     541     
     542 
Note: See TracChangeset for help on using the changeset viewer.