{
  "openapi": "3.0.1",
  "info": {
    "title": "Currency Descriptions",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of currency descriptions.",
    "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 Descriptions",
      "description": "Provide RESTful services to manage Currency Descriptions."
    }
  ],
  "paths": {
    "/currency-descriptions": {
      "get": {
        "tags": [
          "Currency Descriptions"
        ],
        "description": "Get a collection of currency descriptions.",
        "operationId": "getCurrencyDescriptions",
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The text description of the currency in the language identified by LANGUAGE_ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "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"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of currency descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyDescriptionCollection"
                }
              }
            }
          },
          "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 Descriptions"
        ],
        "description": "Create a currency description.",
        "operationId": "createCurrencyDescription",
        "requestBody": {
          "description": "Text descriptions for each of the currency.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurrencyDescriptionRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the currency description.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCurrencyDescriptionsById": {
                "operationRef": "#/paths/~1currency-descriptions~1code:{code},languageId:{languageId}/get",
                "parameters": {
                  "code": "$request.body#/code",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /currency-descriptions/code:{code},languageId:{languageId}`.\n"
              },
              "DeleteCurrencyDescriptionsById": {
                "operationRef": "#/paths/~1currency-descriptions~1code:{code},languageId:{languageId}/delete",
                "parameters": {
                  "code": "$request.body#/code",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /currency-descriptions/code:{code},languageId:{languageId}`.\n"
              },
              "UpdateCurrencyDescriptionsById": {
                "operationRef": "#/paths/~1currency-descriptions~1code:{code},languageId:{languageId}/patch",
                "parameters": {
                  "code": "$request.body#/code",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /currency-descriptions/code:{code},languageId:{languageId}`.\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": "CurrencyDescription"
      }
    },
    "/currency-descriptions/code:{code},languageId:{languageId}": {
      "get": {
        "tags": [
          "Currency Descriptions"
        ],
        "description": "Get a currency description.",
        "operationId": "getCurrencyDescriptionById",
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "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"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Text descriptions for each of the currency.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyDescription"
                }
              }
            }
          },
          "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 Descriptions"
        ],
        "description": "Delete a currency description.",
        "operationId": "deleteCurrencyDescriptionById",
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "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 Descriptions"
        ],
        "description": "Update a currency description.",
        "operationId": "updateCurrencyDescriptionById",
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Text descriptions for each of the currency.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurrencyDescriptionRequest"
              }
            }
          },
          "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": "CurrencyDescription"
      }
    }
  },
  "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."
      },
      "CurrencyDescription": {
        "required": [
          "code",
          "languageId"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table."
          },
          "languageId": {
            "type": "integer",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The text description of the currency in the language identified by LANGUAGE_ID.",
            "nullable": true
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The self link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "Text descriptions for each of the currency."
      },
      "CurrencyDescriptionRequest": {
        "required": [
          "code",
          "languageId"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "This is a currency code as per ISO 4217 standards. Foreign key that references column SETCCURR in the SETCURR table."
          },
          "languageId": {
            "type": "integer",
            "description": "Language ID of the Language. Foreign key that references the LANGUAGE_ID column in the Language table. For a list of language components, see the LANGUAGE table.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The text description of the currency in the language identified by LANGUAGE_ID.",
            "nullable": true
          }
        },
        "description": "Text descriptions for each of the currency."
      },
      "CurrencyDescriptionCollection": {
        "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/CurrencyDescription"
            }
          }
        },
        "description": "A collection of currency descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}