1 "get"

2 *****
3
4 * Description
5
6 * Usage
7
8 * Required Parameters
9
10 * Optional Parameters
11
12 * Global Parameters
13
14 * Examples
15
16
17 Description
18 ===========
19
20 Gets the details of a work request.
21
22
23 Usage
24 =====
25
26 oci work-requests work-request get [OPTIONS]
27
28
29 Required Parameters
30 ===================
31
32 --work-request-id [text]
33
34 The OCID of the work request.
35
36
37 Optional Parameters
38 ===================
39
40 --from-json [text]
41
42 Provide input to this command as a JSON document from a file using the
43 file://path-to/file syntax.
44
45 The "--generate-full-command-json-input" option can be used to
46 generate a sample json file to be used with this command option. The
47 key names are pre-populated and match the command option names
48 (converted to camelCase format, e.g. compartment-id –> compartmentId),
49 while the values of the keys need to be populated by the user before
50 using the sample file as an input to this command. For any command
51 option that accepts multiple values, the value of the key can be a
52 JSON array.
53
54 Options can still be provided on the command line. If an option exists
55 in both the JSON document and the command line then the command line
56 specified value will be used.
57
58 For examples on usage of this option, please see our “using CLI with
59 advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
60 nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
61
62
63 Global Parameters
64 =================
65
66 Use "oci --help" for help on global parameters.
67
68 "--auth-purpose", "--auth", "--cert-bundle", "--cli-rc-file", "--
69 config-file", "--debug", "--defaults-file", "--endpoint", "--generate-
70 full-command-json-input", "--generate-param-json-input", "--help", "--
71 latest-version", "--max-retries", "--no-retry", "--opc-client-request-
72 id", "--opc-request-id", "--output", "--profile", "--query", "--raw-
73 output", "--region", "--release-info", "--request-id", "--version",
74 "-?", "-d", "-h", "-v"
75
76
77 Examples
78 ========
79
80 Copy the following CLI commands into a file named example.sh. Run the
81 command by typing “bash example.sh” and replacing the example
82 parameters with your own.
83
84 Please note this sample will only work in the POSIX-compliant bash-
85 like shell. You need to set up the OCI configuration and appropriate
86 security policies before trying the examples.
87
88 export work_request_id=<substitute-value-of-work_request_id> #
https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdr
ef/work-requests/work-request/get.html#cmdoption-work-request-id
89
90 oci work-requests work-request get --work-request-id $work_request_id
91