​
epx catalogs

Reads catalogs, visible or not. STATUS and VISIBLE are separate Emporix fields and can disagree. ROOT CATEGORIES counts the categories assigned directly to the catalog. Its reads need no OAuth scope. Its writes require the catalog.catalog_manage scope. Command: epx catalogs [flags], epx catalogs [command] Flags: only the global flags. Subcommands

​
epx catalogs create

Create a catalog. Creates a catalog from the JSON in --file, shaped as epx catalogs get ID -o json shows one: name and description (maps of languages to text), visibility, publishedSites and categoryIds (root categories); Emporix generates the id unless the body gives one. It answers with the id; an id that exists already is a conflict (exit 5). Changes data: on a terminal, epx asks before it sends POST. --yes sends without asking (required without a terminal, or with --file -); --dry-run prints the request instead of sending it. Requires the catalog.catalog_manage scope. Command: epx catalogs create [flags] Flags
  • --dry-run
    Print the request instead of sending it (excludes -o).
  • --file <PATH>
    JSON request body in PATH, sent byte for byte (- reads standard input; sending it then needs --yes; required).
  • -o, --output <format>
    Format of the response: json or yaml. Default: json.
  • --yes
    Send without asking (required without a terminal, or with --file -).
Also takes the global flags.

​
epx catalogs delete

Delete a catalog. Deletes the catalog ID, as epx catalogs list shows it. Deletes data, which cannot be undone. On a terminal, epx sends DELETE only once you type ID at its prompt. --yes sends without asking (required without a terminal); --dry-run prints the request instead of sending it. Requires the catalog.catalog_manage scope. Command: epx catalogs delete ID [flags] Flags
  • --dry-run
    Print the request instead of sending it (excludes -o).
  • -o, --output <format>
    Format of the response: json or yaml. Default: json.
  • --yes
    Send without asking (required without a terminal).
Also takes the global flags.

​
epx catalogs for-category

List the catalogs a category is assigned to. Reads catalogs, visible or not. STATUS and VISIBLE are separate Emporix fields and can disagree. ROOT CATEGORIES counts the categories assigned directly to the catalog. CATEGORY_ID is the id of a category assigned to catalogs directly, a root category (an unindented row of epx category-trees list); a category below one, or an unknown id, lists nothing. No OAuth scope is needed. Command: epx catalogs for-category CATEGORY_ID [flags] Flags
  • --columns <names>
    Print only these columns of table and csv, in this order: comma-separated names (any case) among ID, NAME, STATUS, VISIBLE, FROM, TO, SITES, ROOT CATEGORIES.
  • --language <language>
    Language of localized table text; a missing translation shows another, labeled (-o json prints all). Default: en.
  • --limit <n>
    Print at most n items; paged reads stop early where they safely can (0: every item).
  • --no-headers
    Print table and csv without the header row.
  • -o, --output <format>
    Output format: table, json, yaml or csv (csv: the table’s rows; json and yaml: the whole response). Default: table.
  • --sort <order>
    Emporix sort order, passed as given, e.g. code or name.en:desc,code; fields mostly as in -o json (Emporix may ignore an unknown one).
  • --stream
    Print items as JSON Lines as soon as they are checked, page by page on paged lists, reading up to 10000 pages where a list without it stops after 1000: a check failing on a later page exits 1 after the pages before it (excludes -o, --columns and --no-headers).
Also takes the global flags.

​
epx catalogs get

Show one catalog. Reads catalogs, visible or not. STATUS and VISIBLE are separate Emporix fields and can disagree. ROOT CATEGORIES counts the categories assigned directly to the catalog. No OAuth scope is needed. Command: epx catalogs get ID [flags] Flags
  • --columns <names>
    Print only these columns of table and csv, in this order: comma-separated names (any case) among ID, NAME, STATUS, VISIBLE, FROM, TO, SITES, ROOT CATEGORIES.
  • --language <language>
    Language of localized table text; a missing translation shows another, labeled (-o json prints all). Default: en.
  • --no-headers
    Print table and csv without the header row.
  • -o, --output <format>
    Output format: table, json, yaml or csv (csv: the table’s rows; json and yaml: the whole response). Default: table.
Also takes the global flags.

​
epx catalogs list

List catalogs. Reads catalogs, visible or not. STATUS and VISIBLE are separate Emporix fields and can disagree. ROOT CATEGORIES counts the categories assigned directly to the catalog. No OAuth scope is needed. Command: epx catalogs list [flags] Flags
  • --columns <names>
    Print only these columns of table and csv, in this order: comma-separated names (any case) among ID, NAME, STATUS, VISIBLE, FROM, TO, SITES, ROOT CATEGORIES.
  • --language <language>
    Language of localized table text; a missing translation shows another, labeled (-o json prints all). Default: en.
  • --limit <n>
    Print at most n items; paged reads stop early where they safely can (0: every item).
  • --no-headers
    Print table and csv without the header row.
  • -o, --output <format>
    Output format: table, json, yaml or csv (csv: the table’s rows; json and yaml: the whole response). Default: table.
  • --sort <order>
    Emporix sort order, passed as given, e.g. code or name.en:desc,code; fields mostly as in -o json (Emporix may ignore an unknown one).
  • --stream
    Print items as JSON Lines as soon as they are checked, page by page on paged lists, reading up to 10000 pages where a list without it stops after 1000: a check failing on a later page exits 1 after the pages before it (excludes -o, --columns and --no-headers).
Also takes the global flags.

​
epx catalogs patch

Change members of a catalog. Changes the members of the catalog ID that the JSON in --file gives, and keeps the others. Emporix requires metadata.version in the body, as epx catalogs get ID -o json shows it, and answers a version that is not the catalog’s as it answers an unknown catalog, with 404 Not Found: epx then exits with 5, a conflict (read the catalog again before you retry), also for an unknown ID, and with 4 without a version. Changes data: on a terminal, epx asks before it sends PATCH. --yes sends without asking (required without a terminal, or with --file -); --dry-run prints the request instead of sending it. Requires the catalog.catalog_manage scope. Command: epx catalogs patch ID [flags] Flags
  • --dry-run
    Print the request instead of sending it (excludes -o).
  • --file <PATH>
    JSON request body in PATH, sent byte for byte (- reads standard input; sending it then needs --yes; required).
  • -o, --output <format>
    Format of the response: json or yaml. Default: json.
  • --yes
    Send without asking (required without a terminal, or with --file -).
Also takes the global flags.

​
epx catalogs update

Upsert a catalog. Replaces the catalog ID with the JSON in --file, or creates it with that id when there is none (an upsert); the body has the members of create’s but the id. With metadata.version, as epx catalogs get ID -o json shows it, Emporix refuses the write as a conflict (exit 5) when the catalog changed since it was read. Changes data: on a terminal, epx asks before it sends PUT. --yes sends without asking (required without a terminal, or with --file -); --dry-run prints the request instead of sending it. Requires the catalog.catalog_manage scope. Command: epx catalogs update ID [flags] Flags
  • --dry-run
    Print the request instead of sending it (excludes -o).
  • --file <PATH>
    JSON request body in PATH, sent byte for byte (- reads standard input; sending it then needs --yes; required).
  • -o, --output <format>
    Format of the response: json or yaml. Default: json.
  • --yes
    Send without asking (required without a terminal, or with --file -).
Also takes the global flags.