list-records

Description

List Record in the specified compartment.

Usage

oci data-labeling-service-dataplane record-collection list-records [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ID of the compartment in which to list resources.

--dataset-id [text]

Filter results by the OCID of the dataset.

Optional Parameters

--all

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

--annotation-labels-contains [text]

Allows the user to filter records based on the related annotations.

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

--id [text]

Unique OCID identifier

--is-labeled [boolean]

Whether the record has been labeled and has associated annotations.

--lifecycle-state [text]

A filter to return only resources their lifecycleState matches the given lifecycleState.

Accepted values are:

ACTIVE, DELETED, INACTIVE
--limit [integer]

The maximum number of items to return.

--name [text]

Name of the record

--page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

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

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

Accepted values are:

name, timeCreated
--sort-order [text]

The sort order to use, either ‘asc’ or ‘desc’.

Accepted values are:

ASC, DESC

Examples

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-labeling-service-dataplane/record-collection/list-records.html#cmdoption-compartment-id
    export dataset_id=<substitute-value-of-dataset_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-labeling-service-dataplane/record-collection/list-records.html#cmdoption-dataset-id

    oci data-labeling-service-dataplane record-collection list-records --compartment-id $compartment_id --dataset-id $dataset_id