{
  "openapi": "3.0.1",
  "info": {
    "title": "Quantity Unit Conversions",
    "description": "Create and administer a collection of quantity unit conversions",
    "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"
          ]
        }
      }
    }
  ],
  "paths": {
    "/quantity-unit-conversions": {
      "get": {
        "tags": [
          "quantity-unit-conversions"
        ],
        "description": "Get a collection of quantity unit conversions.",
        "operationId": "getQuantityUnitConversions",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The quantity unit conversion ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "conversionFactor",
            "in": "query",
            "description": "The conversion factor. Implicit conversion rules are derived from explicit rules by combining conversion factors.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "multiplyOrDivide",
            "in": "query",
            "description": "A single character that is used to to convert the quantity unit by either multiplying or dividing. The different modes are  M = multiply by factor, and D = divide by factor. A reverse conversion of the quantity unit using the inverse operation is implicitly defined.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "updatable",
            "in": "query",
            "description": "A single character that acts as a flag intended to be used by a user interface that manages quantity unit conversion rules. The different modes are N = the conversion factor is irrevocable, It should never be changed. Y = the conversion factor can be changed.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "toQuantityUnit",
            "in": "query",
            "description": "A string to specify the quantity unit converted to.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromQuantityUnit",
            "in": "query",
            "description": "A string to specify the quantity unit converted from.",
            "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"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of quantity unit conversions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityUnitConversionCollection"
                }
              }
            }
          },
          "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": [
          "quantity-unit-conversions"
        ],
        "description": "Create a quantity unit conversion.",
        "operationId": "createQuantityUnitConversion",
        "requestBody": {
          "description": "The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuantityUnitConversion"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Quantity Unit Conversions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetQuantityUnitConversionsByQuantityUnitConversionId": {
                "operationRef": "#/paths/~1quantity-unit-conversions~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /quantity-unit-conversions/{id}`.\n"
              },
              "DeleteQuantityUnitConversionsByQuantityUnitConversionId": {
                "operationRef": "#/paths/~1quantity-unit-conversions~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /quantity-unit-conversions/{id}`.\n"
              },
              "UpdateQuantityUnitConversionsByQuantityUnitConversionId": {
                "operationRef": "#/paths/~1quantity-unit-conversions~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /quantity-unit-conversions/{id}`.\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": "QuantityUnitConversion"
      }
    },
    "/quantity-unit-conversions/{id}": {
      "get": {
        "tags": [
          "quantity-unit-conversions"
        ],
        "description": "Get a quantity unit conversion.",
        "operationId": "getQuantityUnitConversionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The quantity unit conversion ID.",
            "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": "The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityUnitConversions"
                }
              }
            }
          },
          "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": [
          "quantity-unit-conversions"
        ],
        "description": "Delete a quantity unit conversion.",
        "operationId": "deleteQuantityUnitConversionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The quantity unit conversion ID.",
            "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": [
          "quantity-unit-conversions"
        ],
        "description": "Update a quantity unit conversion.",
        "operationId": "updateQuantityUnitConversionById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The quantity unit conversion ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuantityUnitConversion"
              }
            }
          },
          "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": "QuantityUnitConversion"
      }
    }
  },
  "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."
      },
      "QuantityUnitConversion": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The quantity unit conversion ID.",
            "format": "int32"
          },
          "conversionFactor": {
            "type": "number",
            "description": "The conversion factor. Implicit conversion rules are derived from explicit rules by combining conversion factors."
          },
          "multiplyOrDivide": {
            "type": "string",
            "description": "A single character that is used to to convert the quantity unit by either multiplying or dividing. The different modes are  M = multiply by factor, and D = divide by factor. A reverse conversion of the quantity unit using the inverse operation is implicitly defined."
          },
          "updatable": {
            "type": "string",
            "description": "A single character that acts as a flag intended to be used by a user interface that manages quantity unit conversion rules. The different modes are N = the conversion factor is irrevocable, It should never be changed. Y = the conversion factor can be changed."
          },
          "toQuantityUnit": {
            "type": "string",
            "description": "A string to specify the quantity unit converted to."
          },
          "fromQuantityUnit": {
            "type": "string",
            "description": "A string to specify the quantity unit converted from."
          }
        },
        "description": "The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one."
      },
      "QuantityUnitConversions": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The quantity unit conversion ID.",
            "format": "int32"
          },
          "conversionFactor": {
            "type": "number",
            "description": "The conversion factor. Implicit conversion rules are derived from explicit rules by combining conversion factors."
          },
          "multiplyOrDivide": {
            "type": "string",
            "description": "A single character that is used to to convert the quantity unit by either multiplying or dividing. The different modes are  M = multiply by factor, and D = divide by factor. A reverse conversion of the quantity unit using the inverse operation is implicitly defined."
          },
          "updatable": {
            "type": "string",
            "description": "A single character that acts as a flag intended to be used by a user interface that manages quantity unit conversion rules. The different modes are N = the conversion factor is irrevocable, It should never be changed. Y = the conversion factor can be changed."
          },
          "toQuantityUnit": {
            "type": "string",
            "description": "A string to specify the quantity unit converted to."
          },
          "fromQuantityUnit": {
            "type": "string",
            "description": "A string to specify the quantity unit converted from."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one."
      },
      "QuantityUnitConversionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/QuantityUnitConversions"
            }
          }
        },
        "description": "A collection of quantity unit conversions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}