X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b54d7820e899733ce10b8960b1f04d0481f2e11f..f82085bd3a31d92c49db6b210e8737def65be6cb:/doc/api/methods/logs.html.textile.liquid diff --git a/doc/api/methods/logs.html.textile.liquid b/doc/api/methods/logs.html.textile.liquid index b7934e50db..c5895d78a2 100644 --- a/doc/api/methods/logs.html.textile.liquid +++ b/doc/api/methods/logs.html.textile.liquid @@ -6,14 +6,16 @@ title: "logs" ... -h1. logs +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html + +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@ Required arguments are displayed in %{background:#ccffcc}green%. h2. create -Create a new Log. +Create a new log entry. Arguments: @@ -23,76 +25,43 @@ table(table table-bordered table-condensed). h2. delete -Delete an existing Log. +Delete an existing log entry. This method can only be used by privileged (system administrator) users. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path|| - -h2. destroy - -destroy logs - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path|| h2. get -Gets a Log's metadata by UUID. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path|| - -h2. index - -index logs +Retrieve a log entry. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| +{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path|| h2. list -List logs. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of logs to return.|query|| -|order|string|Order in which to return matching logs.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching logs.|query|| -|where|object|Conditions for filtering logs.|query|| - -h2. show - -show logs +List log entries. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +|limit|integer (default 100)|Maximum number of log entries to return.|query|| +|order|string|Order in which to return matching log entries.|query|| +|filters|array|Conditions for filtering log entries.|query|| h2. update -Update attributes of an existing Log. +Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path|| +{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path|| |log|object||query||