doc/api/methods/logs.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "logs"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. Creation
  16
  17 Any user may create Log entries for any event they find useful. User-generated Logs have no intrinsic meaning to other users or to the Arvados system itself; it is up to each user to choose appropriate log event types and summaries for their project.
  18
  19 h3. System Logs
  20
  21 Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.
  22
  23 h2. Resource
  24
  25 Each Log has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  26
  27 table(table table-bordered table-condensed).
  28 |_. Attribute|_. Type|_. Description|_. Example|
  29 |object_uuid|string|||
  30 |event_at|datetime|||
  31 |event_type|string|A user-defined category or type for this event.|@LOGIN@|
  32 |summary|text|||
  33 |properties|hash|||
  34
  35 h2. Methods
  36
  37 h3. create
  38
  39 Create a new log entry.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 |log|object||query||
  46
  47 h3. delete
  48
  49 Delete an existing log entry. This method can only be used by privileged (system administrator) users.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  56
  57 h3. get
  58
  59 Retrieve a log entry.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  66
  67 h3. list
  68
  69 List log entries.
  70
  71 Arguments:
  72
  73 table(table table-bordered table-condensed).
  74 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  75 |limit|integer (default 100)|Maximum number of log entries to return.|query||
  76 |order|string|Order in which to return matching log entries.|query||
  77 |filters|array|Conditions for filtering log entries.|query||
  78
  79 h3. update
  80
  81 Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  88 |log|object||query||