invoke-raw-json-command

Description

Invokes the raw command on the specified digital twin instance.

Usage

oci iot digital-twin-instance invoke-raw-json-command [OPTIONS]

Required Parameters

--digital-twin-instance-id [text]

The OCID of digital twin instance.

--request-endpoint [text]

Device endpoint where request should be forwarded to.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--request-data [complex type]

request data This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--request-data-content-type [text]

Mime content type of json data, default is application/json

--request-duration [text]

Specified duration by which to send the request by.

--response-duration [text]

Specified duration by which to receive the response by.

--response-endpoint [text]

Device endpoint from which response is expected to come.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --connection-timeout, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --proxy, --query, --raw-output, --read-timeout, --realm-specific-endpoint, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export iot_domain_id=<substitute-value-of-iot_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/iot/digital-twin-instance/create.html#cmdoption-iot-domain-id
    export request_endpoint=<substitute-value-of-request_endpoint> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/iot/digital-twin-instance/invoke-raw-json-command.html#cmdoption-request-endpoint

    digital_twin_instance_id=$(oci iot digital-twin-instance create --iot-domain-id $iot_domain_id --query data.id --raw-output)

    oci iot digital-twin-instance invoke-raw-json-command --digital-twin-instance-id $digital_twin_instance_id --request-endpoint $request_endpoint