X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7e52fd153f2d16f94061ef1eabfe653d4a83852a..b9262c0e8c04f6b3d68f1ca301cc2ec56c2ef164:/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 574c8ede77..5a7ac325c3 100644 --- a/doc/api/methods/logs.html.textile.liquid +++ b/doc/api/methods/logs.html.textile.liquid @@ -5,22 +5,25 @@ navmenu: API Methods title: "logs" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@ -UUID type: @57u5n@ +Object type: @57u5n@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-57u5n-0123456789abcde@ h2. Resource -Each Log has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each Log has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| -|object_uuid|string||| +|object_uuid|string|The arvados object that is the subject of the log.|| |event_at|datetime||| |event_type|string|A user-defined category or type for this event.|@LOGIN@| |summary|text||| @@ -36,6 +39,10 @@ Arvados uses Logs to record creation, deletion, and updates of other Arvados res h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + h3. create Create a new log entry. @@ -70,13 +77,7 @@ h3. list List log entries. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|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|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update