{
  "openapi": "3.0.1",
  "info": {
    "title": "Quantity Units",
    "version": "9.1.20.0",
    "description": "Create and administer quantity units.",
    "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-units": {
      "get": {
        "tags": [
          "quantity-units"
        ],
        "description": "Get a collection of Quantity Units.",
        "operationId": "getQuantityUnits",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The Qunatity Unit ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "A customizable field.",
            "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 Quantity Units, such as kilogram, meter, liter, pound, foot, quart etc.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityUnitCollection"
                }
              }
            }
          },
          "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-units"
        ],
        "description": "Create a Quantity Unit.",
        "operationId": "createQuantityUnit",
        "requestBody": {
          "description": "A Quantity Unit.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuantityUnit"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Quantity Units.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetQuantityUnitsById": {
                "operationRef": "#/paths/~1quantity-units~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-units/{id}`.\n"
              },
              "DeleteQuantityUnitsById": {
                "operationRef": "#/paths/~1quantity-units~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-units/{id}`.\n"
              },
              "UpdateQuantityUnitsById": {
                "operationRef": "#/paths/~1quantity-units~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-units/{id}`.  \n"
              },
              "GetQuantityUnitsDescriptionsByQuantityUnitsId": {
                "operationRef": "#/paths/~1quantity-units~1{id}~1descriptions/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-units/{id}/descriptions`.\n"
              },
              "GetQuantityUnitsConversionsToByQuantityUnitsId": {
                "operationRef": "#/paths/~1quantity-units~1{id}~1conversions-to/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-units/{id}/conversions-to`.\n"
              },
              "GetQuantityUnitsConversionFromByQuantityUnitsId": {
                "operationRef": "#/paths/~1quantity-units~1{id}~1conversions-from/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-units/{id}/conversions-from`.\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": "QuantityUnit"
      }
    },
    "/quantity-units/{id}": {
      "get": {
        "tags": [
          "quantity-units"
        ],
        "description": "Get a Quantity Unit.",
        "operationId": "getQuantityUnitById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "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 Quantity Unit.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityUnits"
                }
              }
            }
          },
          "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-units"
        ],
        "description": "Delete a Quantity Unit.",
        "operationId": "deleteQuantityUnitById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "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-units"
        ],
        "description": "Update a Quantity Unit.",
        "operationId": "updateQuantityUnitById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "A Quantity Unit.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QuantityUnit"
              }
            }
          },
          "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": "QuantityUnit"
      }
    },
    "/quantity-units/{id}/descriptions": {
      "get": {
        "tags": [
          "quantity-units"
        ],
        "operationId": "getDescriptionsOfQuantityUnit",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "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 Quantity Unit descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityUnitDescriptionCollection"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    },
    "/quantity-units/{id}/conversions-to": {
      "get": {
        "tags": [
          "quantity-units"
        ],
        "operationId": "getConversionsToOfQuantityUnit",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "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 quantity unit conversion descriptions.",
            "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"
                }
              }
            }
          }
        }
      }
    },
    "/quantity-units/{id}/conversions-from": {
      "get": {
        "tags": [
          "quantity-units"
        ],
        "operationId": "getConversionsFromOfQuantityUnit",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Qunatity Unit ID.",
            "required": true,
            "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 quantity unit conversion descriptions.",
            "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "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."
      },
      "QuantityUnits": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Qunatity Unit ID."
          },
          "field1": {
            "type": "string",
            "description": "A customizable field."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "conversions-to": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "conversions-from": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "A Quantity Unit."
      },
      "QuantityUnit": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Qunatity Unit ID."
          },
          "field1": {
            "type": "string",
            "description": "A customizable field."
          }
        },
        "description": "A Quantity Unit."
      },
      "QuantityUnitCollection": {
        "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/QuantityUnits"
            }
          }
        },
        "description": "A collection of Quantity Units, such as kilogram, meter, liter, pound, foot, quart etc."
      },
      "QuantityUnitDescription": {
        "type": "object",
        "properties": {
          "quantityUnitId": {
            "type": "string",
            "description": "The Quantity Unit ID."
          },
          "languageId": {
            "type": "integer",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The Quantity Unit description in the language."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "A Quantity Unit description."
      },
      "QuantityUnitDescriptionCollection": {
        "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/QuantityUnitDescription"
            }
          }
        },
        "description": "A collection of Quantity Unit descriptions."
      },
      "QuantityUnitConversion": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The quantity Unit ConversionId 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 from QTYUNIT_ID_FROM to QTYUNIT_ID_TO by either Multiplying OR Dividing, Modes  M = multiply by FACTOR  And D = divide by FACTOR. Conversion from QTYUNIT_ID_TO to QTYUNIT_ID_FROM 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 QuantityUnit conversion rules, MODES 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 QuantityUnit converted to."
          },
          "fromQuantityUnit": {
            "type": "string",
            "description": "A String to specify the QuantityUnit converted from."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "Each row of this table represents a rule. It can be used to convert a quantity amount from one QuantityUnit (unit of measurement) to another QuantityUnit."
      },
      "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/QuantityUnitConversion"
            }
          }
        },
        "description": "A quantity unit conversion descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}