{
  "openapi": "3.0.1",
  "info": {
    "title": "Currency Format Descriptions",
    "description": "Create and administer a collection of currency format descriptions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Currency Format Descriptions",
      "description": "Provide RESTful services to manage Currency Format Descriptions."
    }
  ],
  "paths": {
    "/currency-format-descriptions": {
      "get": {
        "tags": [
          "Currency Format Descriptions"
        ],
        "description": "Get a collection of currency format descriptions.",
        "operationId": "getCurrencyFormatDescriptions",
        "parameters": [
          {
            "name": "languageId",
            "in": "query",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currencySymbol",
            "in": "query",
            "description": "The currency symbol.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customizedCurrencyCode",
            "in": "query",
            "description": "An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currencyPrefixPositive",
            "in": "query",
            "description": "The prefix to use when the monetary amount is positive. If this field and CURRENCYSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currencyPrefixNegative",
            "in": "query",
            "description": "The prefix to use when the monetary amount is negative. If this field and CURRENCYSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currencySuffixPositive",
            "in": "query",
            "description": "The suffix to use when the monetary amount is positive. If this field and CURRENCYPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currencySuffixNegative",
            "in": "query",
            "description": "The suffix to use when the monetary amount is negative. If this field and CURRENCYPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "displayLocale",
            "in": "query",
            "description": "The Java locale used to create a currency NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "radixPoint",
            "in": "query",
            "description": "The radix point for the NumberFormat object. For example, when formatting dollars for the U.S. English Language, this would be the decimal point character. If this is null, then the decimal separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupingCharacter",
            "in": "query",
            "description": "The grouping character used by the NumberFormat object. For example, when formatting dollars for the U.S. English Language this would be the thousands separator. If this is null, then the grouping separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberPattern",
            "in": "query",
            "description": "The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "A description of the currency, suitable for display to customers in a currency selection list.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The storeId.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "The currency.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberUsg",
            "in": "query",
            "description": "This currency formatting rule should be used when formatting monetary amounts for this usage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of currency format descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyFormatDescriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Currency Format Descriptions"
        ],
        "description": "Create a currency format description.",
        "operationId": "createCurrencyFormatDescription",
        "requestBody": {
          "description": "Language-dependent part of a currency formatting rule.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurrencyFormatDescriptionRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the currency description.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCurrencyFormatDescriptionsById": {
                "operationRef": "#/paths/~1currency-format-descriptions~1languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}/get",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency",
                  "numberUsg": "$request.body#/numberUsg"
                },
                "description": "The `languageId`,`storeId`,`currency`,`numberUsg` value used in the request body can be used as the `languageId`,`storeId`,`currency`,`numberUsg` parameter in `GET /currency-format-descriptions/languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}`.\n"
              },
              "DeleteCurrencyFormatDescriptionsById": {
                "operationRef": "#/paths/~1currency-format-descriptions~1languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}/delete",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency",
                  "numberUsg": "$request.body#/numberUsg"
                },
                "description": "The `languageId`,`storeId`,`currency`,`numberUsg` value used in the request body can be used as the `languageId`,`storeId`,`currency`,`numberUsg` parameter in `DELETE /currency-format-descriptions/languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}`.\n"
              },
              "UpdateCurrencyFormatDescriptionsById": {
                "operationRef": "#/paths/~1currency-format-descriptions~1languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}/patch",
                "parameters": {
                  "languageId": "$request.body#/languageId",
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency",
                  "numberUsg": "$request.body#/numberUsg"
                },
                "description": "The `languageId`,`storeId`,`currency`,`numberUsg` value used in the request body can be used as the `languageId`,`storeId`,`currency`,`numberUsg` parameter in `PATCH /currency-format-descriptions/languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "CurrencyFormatDescription"
      }
    },
    "/currency-format-descriptions/languageId:{languageId},storeId:{storeId},currency:{currency},numberUsg:{numberUsg}": {
      "get": {
        "tags": [
          "Currency Format Descriptions"
        ],
        "description": "Get a currency format description.",
        "operationId": "getCurrencyFormatDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The storeId.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "The currency.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberUsg",
            "in": "path",
            "description": "The numberUsg.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Language-dependent part of a currency formatting rule.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyFormatDescription"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Currency Format Descriptions"
        ],
        "description": "Delete a currency format description.",
        "operationId": "deleteCurrencyFormatDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The storeId.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "The currency.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberUsg",
            "in": "path",
            "description": "The numberUsg.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Currency Format Descriptions"
        ],
        "description": "Update a currency format description.",
        "operationId": "updateCurrencyFormatDescriptionById",
        "parameters": [
          {
            "name": "languageId",
            "in": "path",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The storeId.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "The currency.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "numberUsg",
            "in": "path",
            "description": "The numberUsg.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Language-dependent part of a currency formatting rule.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurrencyFormatDescriptionRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "CurrencyFormatDescription"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "CurrencyFormatDescriptionRequest": {
        "required": [
          "languageId",
          "storeId",
          "currency",
          "numberUsg"
        ],
        "type": "object",
        "properties": {
          "languageId": {
            "type": "integer",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "format": "int32"
          },
          "currencySymbol": {
            "type": "string",
            "description": "The currency symbol."
          },
          "customizedCurrencyCode": {
            "type": "string",
            "description": "An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.",
            "nullable": true
          },
          "currencyPrefixPositive": {
            "type": "string",
            "description": "The prefix to use when the monetary amount is positive. If this field and CURRENCYSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencyPrefixNegative": {
            "type": "string",
            "description": "The prefix to use when the monetary amount is negative. If this field and CURRENCYSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencySuffixPositive": {
            "type": "string",
            "description": "The suffix to use when the monetary amount is positive. If this field and CURRENCYPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencySuffixNegative": {
            "type": "string",
            "description": "The suffix to use when the monetary amount is negative. If this field and CURRENCYPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.",
            "nullable": true
          },
          "displayLocale": {
            "type": "string",
            "description": "The Java locale used to create a currency NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.",
            "nullable": true
          },
          "radixPoint": {
            "type": "string",
            "description": "The radix point for the NumberFormat object. For example, when formatting dollars for the U.S. English Language, this would be the decimal point character. If this is null, then the decimal separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "nullable": true
          },
          "groupingCharacter": {
            "type": "string",
            "description": "The grouping character used by the NumberFormat object. For example, when formatting dollars for the U.S. English Language this would be the thousands separator. If this is null, then the grouping separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "nullable": true
          },
          "numberPattern": {
            "type": "string",
            "description": "The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "A description of the currency, suitable for display to customers in a currency selection list.",
            "nullable": true
          },
          "storeId": {
            "type": "integer",
            "description": "A storeId.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "The currency."
          },
          "numberUsg": {
            "type": "integer",
            "description": "The numberUsg.",
            "format": "int32"
          }
        },
        "description": "Language-dependent part of a currency formatting rule."
      },
      "CurrencyFormatDescription": {
        "required": [
          "languageId",
          "storeId",
          "currency",
          "numberUsg"
        ],
        "type": "object",
        "properties": {
          "languageId": {
            "type": "integer",
            "description": "The language. For a list of language components, see the LANGUAGE table.",
            "format": "int32"
          },
          "currencySymbol": {
            "type": "string",
            "description": "The currency symbol."
          },
          "customizedCurrencyCode": {
            "type": "string",
            "description": "An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.",
            "nullable": true
          },
          "currencyPrefixPositive": {
            "type": "string",
            "description": "The prefix to use when the monetary amount is positive. If this field and CURRENCYSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencyPrefixNegative": {
            "type": "string",
            "description": "The prefix to use when the monetary amount is negative. If this field and CURRENCYSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencySuffixPositive": {
            "type": "string",
            "description": "The suffix to use when the monetary amount is positive. If this field and CURRENCYPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.",
            "nullable": true
          },
          "currencySuffixNegative": {
            "type": "string",
            "description": "The suffix to use when the monetary amount is negative. If this field and CURRENCYPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.",
            "nullable": true
          },
          "displayLocale": {
            "type": "string",
            "description": "The Java locale used to create a currency NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.",
            "nullable": true
          },
          "radixPoint": {
            "type": "string",
            "description": "The radix point for the NumberFormat object. For example, when formatting dollars for the U.S. English Language, this would be the decimal point character. If this is null, then the decimal separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "nullable": true
          },
          "groupingCharacter": {
            "type": "string",
            "description": "The grouping character used by the NumberFormat object. For example, when formatting dollars for the U.S. English Language this would be the thousands separator. If this is null, then the grouping separator of the currency NumberFormat, associated with the DisplayLocale, will be used.",
            "nullable": true
          },
          "numberPattern": {
            "type": "string",
            "description": "The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "A description of the currency, suitable for display to customers in a currency selection list.",
            "nullable": true
          },
          "storeId": {
            "type": "integer",
            "description": "A storeId.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "The currency."
          },
          "numberUsg": {
            "type": "integer",
            "description": "The numberUsg.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the self link."
                  }
                },
                "description": ""
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "Language-dependent part of a currency formatting rule."
      },
      "CurrencyFormatDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The resource."
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int32"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/CurrencyFormatDescription"
            }
          }
        },
        "description": "A collection of currency format descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}