Merge branch '10081-cwl-run-same-job' into 9988-cwl-arv-hints
[arvados.git] / doc / api / methods / container_requests.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: API Methods
5 title: "container_requests"
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/container_requests@
12
13 Required arguments are displayed in %{background:#ccffcc}green%.
14
15 h2(#create). create
16
17 Create a new ContainerRequest.
18
19 Arguments:
20
21 table(table table-bordered table-condensed).
22 |_. Argument |_. Type |_. Description |_. Location |_. Example |
23 {background:#ccffcc}.|container_request|object|See "ContainerRequest resource":{{site.baseurl}}/api/schema/ContainerRequest.html|request body||
24
25 The request body must include the required attributes command, container_image, cwd, and output_path. It can also inlcude other attributes such as environment, mounts, and runtime_constraints.
26
27 h2. delete
28
29 Delete an existing ContainerRequest.
30
31 Arguments:
32
33 table(table table-bordered table-condensed).
34 |_. Argument |_. Type |_. Description |_. Location |_. Example |
35 {background:#ccffcc}.|uuid|string|The UUID of the ContainerRequest in question.|path||
36
37 h2. get
38
39 Get a ContainerRequest's metadata by UUID.
40
41 Arguments:
42
43 table(table table-bordered table-condensed).
44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
45 {background:#ccffcc}.|uuid|string|The UUID of the ContainerRequest in question.|path||
46
47 h2. list
48
49 List container_requests.
50
51 Arguments:
52
53 table(table table-bordered table-condensed).
54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
55 |limit|integer (default 100)|Maximum number of container_requests to return.|query||
56 |order|string|Order in which to return matching container_requests.|query||
57 |filters|array|Conditions for filtering container_requests.|query||
58
59 See the create method documentation for more information about ContainerRequest-specific filters.
60
61 h2. update
62
63 Update attributes of an existing ContainerRequest.
64
65 Arguments:
66
67 table(table table-bordered table-condensed).
68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
69 {background:#ccffcc}.|uuid|string|The UUID of the ContainerRequest in question.|path||
70 |container_request|object||query||
71
72 {% include 'notebox_begin' %}
73 Setting the priority of a committed container_request to 0 may cancel a running container assigned for it.
74 See "Canceling a ContainerRequest":{{site.baseurl}}/api/schema/ContainerRequest.html#cancel_container for further details.
75 {% include 'notebox_end' %}