Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • URL: /services/metadata/catalog
    • HTTP method: GET
    • Description: retrieves the available metadata for a catalog product
    • HTTP method: GET
    • Parameters:
      • "id": product identifier (required)
      • "format=json": to return the metadata in JSON format (optional - by default format=html i.e. the metadata is returned wrapped within an HTML table)
    • Response: text/html (default) or application/json
    • Examples:
  • URL: /services/metadata/catalog
    • HTTP method: POST
    • Description: updates or inserts metadata fields for an existing product
    • Parameters:
      • "id": product identifier (required)
      • "metadata.<field name>=<field value>": name and value of metadata field to insert or update. Product metadata fields need to be pre-pended with "metadata." to be distinguished from other HTTP control flow parameters. More than one metadata field can be specified in the same request. To add more than one value for the same field, use multiple "metadata.<field_name>=..." expressions. (optional, but must me specified for the request to be meaningful)
      • Response: text/html containing the full product metadata
    • Examples:
  • URL: /services/metadata/update
    • HTTP method: POST
    • Description: alternate endpoint (with slightly different functionality) to update Description: updates one or more metadata fields for an existing product, while preserving all the other metadata fields
    • HTTP method: POST
    • Parameters:
      • "id": product identifier (either "id" or "name" is required)
      • "name": product name (either "id" or "name" is required)
      • "metadata.<field name>=<field value>": name and value of metadata field to insert or update. Product metadata fields need to be pre-pended with "metadata." to be distinguished from other HTTP control flow parameters. More than one metadata field can be specified in the same request. To add more than one value for the same field, use multiple "metadata.<field_name>=..." expressions. (optional, but must me specified for the request to be meaningful)
      • "replace=false" to add the new value(s) to the existing ones for that metadata field (optional: by default replace=true, meaning the new value(s) will override the existing ones)
      • "remove=true" to remove an existing metadata field (optional: by default remove=false, meaning the specified values will be added to the field)
    • Response: text/plain with content of the form "id=<product id>"
    • Examples:
  • URL: /services/metadata/staging
    • HTTP method: GET
    • Description: retrieves the staging metadata (content of <product_id>.met file) of an existing product, if availableHTTP method: GET
    • Parameters:
      • "id": product identifier (required)
      • "format=json": to return the metadata in JSON format (optional - by default format=html i.e. the metadata is returned wrapped within an HTML table)
    • Response: text/html (default) or application/json
    • Examples: