{
  "openapi": "3.0.1",
  "info": {
    "title": "Calculation Ranges",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of calculation ranges.",
    "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": "Calculation Ranges",
      "description": "Provide RESTful service to manage calculation ranges."
    }
  ],
  "paths": {
    "/calculation-ranges": {
      "get": {
        "tags": [
          "Calculation Ranges"
        ],
        "description": "Get a collection of calculation range.",
        "operationId": "getCalculationRanges",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The calculation range ID.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "cumulative",
            "in": "query",
            "description": "Valid values, 0 = only the matching Calculation Range with the highest RANGE START value is used. 1 = all matching Calculation Ranges are used. The calculated monetary amounts are summed to arrive at the final result.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "rangeStart",
            "in": "query",
            "description": "If a lookup number is greater than or equal to RANGE START, or if RANGE START is NULL, this row matches the lookup number.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "markForDelete",
            "in": "query",
            "description": "Reserved for HCL Internal use.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationMethodId",
            "in": "query",
            "description": "The Calculation Range Method that determines a monetary amount from the Calculation Range Lookup Result.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationScaleId",
            "in": "query",
            "description": "The Calculation Scale of which this Calculation Range is a part.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "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 calculation range.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalculationRangeCollection"
                }
              }
            }
          },
          "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": [
          "Calculation Ranges"
        ],
        "description": "Create a calculation range.",
        "operationId": "createCalculationRange",
        "requestBody": {
          "description": "A calculation ranges.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculationRanges"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the calculation Ranges .",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCalculationRangesById": {
                "operationRef": "#/paths/~1calculation-ranges~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 /calculation-ranges/{id}`.\n"
              },
              "DeleteCalculationRangesById": {
                "operationRef": "#/paths/~1calculation-ranges~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 /calculation-ranges/{id}`.\n"
              },
              "UpdateCalculationRangesById": {
                "operationRef": "#/paths/~1calculation-ranges~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 /calculation-ranges/{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": "CalculationRange"
      }
    },
    "/calculation-ranges/{id}": {
      "get": {
        "tags": [
          "Calculation Ranges"
        ],
        "description": "Get a calculation range.",
        "operationId": "getCalculationRangeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The calculation range 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"
            }
          },
          {
            "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 calculation ranges.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalculationRange"
                }
              }
            }
          },
          "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": [
          "Calculation Ranges"
        ],
        "description": "Delete a calculation range.",
        "operationId": "deleteCalculationRangeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The calculation range 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": [
          "Calculation Ranges"
        ],
        "description": "Update a calculation range.",
        "operationId": "updateCalculationRangeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The calculation range ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A calculation ranges.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculationRanges"
              }
            }
          },
          "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": "CalculationRange"
      }
    }
  },
  "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."
      },
      "CalculationRanges": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The calculation range ID.",
            "format": "int32"
          },
          "cumulative": {
            "type": "integer",
            "description": "Valid values, 0 = only the matching Calculation Range with the highest RANGE START value is used. 1 = all matching Calculation Ranges are used. The calculated monetary amounts are summed to arrive at the final result.",
            "format": "int32"
          },
          "rangeStart": {
            "type": "number",
            "description": "If a lookup number is greater than or equal to RANGE START, or if RANGE START is NULL, this row matches the lookup number."
          },
          "field1": {
            "type": "number",
            "description": "Customizable.",
            "nullable": true
          },
          "field2": {
            "type": "number",
            "description": "Customizable.",
            "nullable": true
          },
          "field3": {
            "type": "string",
            "description": "Customizable.",
            "nullable": true
          },
          "markForDelete": {
            "type": "integer",
            "description": "Reserved for HCL Internal use.",
            "format": "int32"
          },
          "calculationMethodId": {
            "type": "integer",
            "description": "The Calculation Range Method that determines a monetary amount from the Calculation Range Lookup Result.",
            "format": "int32"
          },
          "calculationScaleId": {
            "type": "integer",
            "description": "The Calculation Scale of which this Calculation Range is a part.",
            "format": "int32"
          }
        }
      },
      "CalculationRange": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The calculation range ID.",
            "format": "int32"
          },
          "cumulative": {
            "type": "integer",
            "description": "Valid values, 0 = only the matching Calculation Range with the highest RANGE START value is used. 1 = all matching Calculation Ranges are used. The calculated monetary amounts are summed to arrive at the final result.",
            "format": "int32"
          },
          "rangeStart": {
            "type": "number",
            "description": "If a lookup number is greater than or equal to RANGE START, or if RANGE START is NULL, this row matches the lookup number."
          },
          "field1": {
            "type": "number",
            "description": "Customizable.",
            "nullable": true
          },
          "field2": {
            "type": "number",
            "description": "Customizable.",
            "nullable": true
          },
          "field3": {
            "type": "string",
            "description": "Customizable.",
            "nullable": true
          },
          "markForDelete": {
            "type": "integer",
            "description": "Reserved for HCL Internal use.",
            "format": "int32"
          },
          "calculationMethodId": {
            "type": "integer",
            "description": "The Calculation Range Method that determines a monetary amount from the Calculation Range Lookup Result.",
            "format": "int32"
          },
          "calculationScaleId": {
            "type": "integer",
            "description": "The Calculation Scale of which this Calculation Range is a part.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "A calculation ranges."
      },
      "CalculationRangeCollection": {
        "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/CalculationRange"
            }
          }
        },
        "description": "A collection of calculation range."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}