Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

data-connectivity_reference-artifact-summary-collection -

This is the collection of Reference details summaries, it may be a collection of lightweight details or full definitions.


  • Description
  • Usage
  • Required Parameters
  • Optional Parameters
  • Global Parameters
  • Examples

Retrieves a list of all reference info of a dcms artifact.

oci data-connectivity reference-artifact-summary-collection list-reference-artifacts [OPTIONS]

--dcms-artifact-id [text]

The ID of a dcms artifact (DataAsset or Endpoint).

--registry-id [text]

The registry Ocid.


Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--exclude-types [text]

Types which wont be listed while listing dataAsset/Connection

--favorites-query-param [text]

If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL.

Accepted values are:


--fields [text]

Specifies the fields to get for an object.

--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:

--limit [integer]

Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination <>.

--name [text]

Used to filter by the name of the object.

--page [text]

For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination <>.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--service-artifact-id [text]

Unique key of the service.

--sort-by [text]

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

Accepted values are:

displayName, id, timeCreated

--sort-order [text]

Specifies sort order to use, either ASC (ascending) or DESC (descending).

Accepted values are:


--type [text]

Type of the object to filter the results with.

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --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, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Copy the following CLI commands into a file named Run the command by typing “bash” 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 display_name=<substitute-value-of-display_name> #
    export dcms_artifact_id=<substitute-value-of-dcms_artifact_id> #
    registry_id=$(oci data-connectivity registry create --display-name $display_name --query --raw-output)
    oci data-connectivity reference-artifact-summary-collection list-reference-artifacts --dcms-artifact-id $dcms_artifact_id --registry-id $registry_id


2016, 2022, Oracle
May 17, 2022 3.9.1

Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.