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-labeling-service-dataplane_annotation-analytics-aggregation-collection -

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they’re summarizing. Any filters applied to the list API, have to show up in the aggregation.


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

Summarize the annotations created for a given dataset.

oci data-labeling-service-dataplane annotation-analytics-aggregation-collection summarize-annotation-analytics [OPTIONS]

--compartment-id, -c [text]

The ID of the compartment in which to list resources.

--dataset-id [text]

Filter the results by the OCID of the dataset.

--annotation-group-by [text]

The field to group by. If no value is specified, updatedBy is used by default.

Accepted values are:

label, updatedBy

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

--label [text]

It summarizes annotations with the specified label.

--lifecycle-state [text]

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

Accepted values are:


--limit [integer]

The maximum number of items to return.

--page [text]

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

--sort-by [text]

The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, updatedBy is used by default.

Accepted values are:

count, label, updatedBy

--sort-order [text]

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

Accepted values are:


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 compartment_id=<substitute-value-of-compartment_id> #
    export dataset_id=<substitute-value-of-dataset_id> #
    oci data-labeling-service-dataplane annotation-analytics-aggregation-collection summarize-annotation-analytics --compartment-id $compartment_id --dataset-id $dataset_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.