GuidesPipeline API ReferenceChangelog
Guides
  1. Command Line Interface
  2. OLP CLI Command reference

catalog subset

catalog subset

The OLP CLI supports the following:

  • add a subset to a catalog
  • show subset details
  • list subsets of a catalog
  • remove a subset from a catalog
  • fingerprint details of a catalog's subsets

catalog subset add

Adds the specified subset to a catalog.

olp catalog subset add <catalog HRN> <data subset ID> <data subset name> [command options]

Required parameters:

  • <catalog HRN> The HRN of the catalog.
  • <data subset ID> The ID of the subset.
  • <data subset name> The name of the subset.
  • Either of the following subset types:
    • --areas <areas> The space-separated list of area IDs.
    • --layers <layers> The space-separated list of layer IDs to match subsets.
  • --areaScheme <area scheme> The area scheme of a data subset. Required when --areas is used.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below adds a data subset of the areas type with pol and deu area IDs to the catalog catalog1.

olp catalog subset add hrn:here:data::org:catalog1 areas-subset "Areas subset" \
--areas deu pol --area-scheme hrn:here:areascheme::olp-here:default-countries \
--scope hrn:here:authorization::org:project/project1
olp catalog subset add hrn:here:data::org:catalog1 areas-subset "Areas subset" ^
--areas deu pol --area-scheme hrn:here:areascheme::olp-here:default-countries ^
--scope hrn:here:authorization::org:project/project1

Output:

Data subset areas-subset has been added to the catalog

The command below adds a data subset of the layers type with layer-1 layer ID's to the catalog catalog1.

olp catalog subset add hrn:here:data::org:catalog1 layers-subset "Layers subset" \
--layers layer-1 \
--scope hrn:here:authorization::org:project/project1
olp catalog subset add hrn:here:data::org:catalog1 layers-subset "Layers subset" ^
--layers layer-1 ^
--scope hrn:here:authorization::org:project/project1

Output:

Data subset layers-subset has been added to the catalog

catalog subset show

Displays the details of a catalog data subset.

olp catalog subset show <catalog HRN> <data subset ID> [command options]

Required parameters:

  • <catalog HRN> The HRN of the catalog.
  • <data subset ID> The ID of the subset.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays areas ID's or layer ID's for the data subset, each on a new line.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below shows the details of the areas-subset data subset for the catalog catalog1.

olp catalog subset show hrn:here:data::org:catalog1 areas-subset \
--scope hrn:here:authorization::org:project/project1
olp catalog subset show hrn:here:data::org:catalog1 areas-subset ^
--scope hrn:here:authorization::org:project/project1

Output:

Details of the areas-subset data subset:

name:                    Areas subset
type:                    areas
created:                 2025-10-27T12:16:21.973112Z
areas:                  
                         deu
                         pol

catalog subset list

Lists all data subset that available for a catalog.

olp catalog subset list <catalog HRN> [command options]

Required parameters:

  • <catalog HRN> The HRN of the catalog.

Optional parameters:

  • --limit The maximum number of data subsets returned, the default value is 50.
  • --areas Area ID's to filter data subsets. Only the area ID from the Area Scheme assigned to the catalog can be used.
  • --layers Layer ID's to filter data subsets. Only the layer ID from the catalog can be used.
  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays ID, type, and name of data subsets, each on a new line.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below lists data subsets of the catalog catalog1 that has deu or pol area ID's in the areas data subset.

olp catalog subset list hrn:here:data::org:catalog1 \
--areas deu pol \
--scope hrn:here:authorization::org:project/project1
olp catalog subset show hrn:here:data::org:catalog1 areas-subset ^
--areas deu pol ^
--scope hrn:here:authorization::org:project/project1

Output:

ID              type                name
areas-subset    areas               Areas subset

catalog subset remove

Removes a catalog data subset.

olp catalog subset remove <catalog HRN> <data subset ID> [command options]

Required parameters:

  • <catalog HRN> The HRN of the catalog.
  • <data subset ID> The ID of the subset.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below removes the areas-subset data subset from the catalog catalog1.

olp catalog subset remove hrn:here:data::org:catalog1 areas-subset \
--scope hrn:here:authorization::org:project/project1
olp catalog subset remove hrn:here:data::org:catalog1 areas-subset ^
--scope hrn:here:authorization::org:project/project1

Output:

Data subset areas-subset has been removed from the catalog

catalog subset fingerprint

Displays the details of a catalog data subsets fingerprint.

olp catalog subset fingerprint <catalog HRN> [command options]

Required parameters:

  • <catalog HRN> The HRN of the catalog.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays data subsets fingerprint of a catalog.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials setup.

Example:

The command below shows the data subset fingerprint details for the catalog catalog1.

olp catalog subset fingerprint hrn:here:data::org:catalog1 \
--scope hrn:here:authorization::org:project/project1
olp catalog subset fingerprint hrn:here:data::org:catalog1 ^
--scope hrn:here:authorization::org:project/project1

Output:

Details of the hrn:here:data::org:catalog1 data subsets fingerprint

fingerprint:             0a78b993e3e06e74ca3b312defcdfce4a3e01fac
data subsets:            
                         areas-subset
                         layers-subset
areas:                   
                         deu
                         pol
layers:                  
                         layer1

Updated 10 days ago