{
  "openapi": "3.0.1",
  "info": {
    "title": "Calculation Scale Descriptions",
    "description": "Create and administer a collection of the language-dependent calculation scale descriptions.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Calculation Scale Descriptions",
      "description": "Provide RESTful service to calculation scale descriptions."
    }
  ],
  "paths": {
    "/calculation-scale-descriptions": {
      "get": {
        "tags": [
          "Calculation Scale Descriptions"
        ],
        "description": "Get a collection of language-dependent Calculation Scale Description.",
        "operationId": "getCalculationScaleDescriptions",
        "parameters": [
          {
            "name": "calculationScaleId",
            "in": "query",
            "description": "The Calculation Scale ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The Language ID, The language for which this information applies.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The description of the Calculation Scale.",
            "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 language-dependent Calculation Scale Description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalculationScaleDescriptionCollection"
                }
              }
            }
          },
          "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 Scale Descriptions"
        ],
        "description": "Create a language-dependent calculation scale description.",
        "operationId": "createCalculationScaleDescription",
        "requestBody": {
          "description": "A Language-dependent information for a Calculation Scale.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculationScaleDescriptions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Calculation Scale Description .",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCalculationScaleDescriptionByCalculationScaleIdAndlanguageId": {
                "operationRef": "#/paths/~1calculationScaleDescriptions~1calculationScaleId:{calculationScaleId},languageId:{languageId}/get",
                "parameters": {
                  "calculationScaleId": "$request.body#/calculationScaleId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `calculationScaleId` and `languageId` value used in the request body can be used as the `calculationScaleId` and `languageId` parameter in `GET /calculation-scale-descriptions/calculationScaleId:{calculationScaleId},languageId:{languageId}`.\n"
              },
              "DeleteCalculationScaleDescriptionByCalculationScaleIdAndlanguageId": {
                "operationRef": "#/paths/~1calculationScaleDescriptions~1calculationScaleId:{calculationScaleId},languageId:{languageId}/delete",
                "parameters": {
                  "calculationScaleId": "$request.body#/calculationScaleId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `calculationScaleId` and `languageId` value used in the request body can be used as the `calculationScaleId` and `languageId` parameter in `DELETE /calculation-scale-descriptions/calculationScaleId:{calculationScaleId},languageId:{languageId}`.\n"
              },
              "UpdateCalculationScaleDescriptionByCalculationScaleIdAndlanguageId": {
                "operationRef": "#/paths/~1calculationScaleDescriptions~1calculationScaleId:{calculationScaleId},languageId:{languageId}/patch",
                "parameters": {
                  "calculationScaleId": "request.body#/calculationScaleId",
                  "languageId": "request.body#/languageId"
                },
                "description": "The `calculationScaleId` and `languageId` value used in the request body can be used as the `calculationScaleId` and `languageId` parameter in `PATCH /calculation-scale-descriptions/calculationScaleId:{calculationScaleId},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": "CalculationScaleDescription"
      }
    },
    "/calculation-scale-descriptions/calculationScaleId:{calculationScaleId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Calculation Scale Descriptions"
        ],
        "description": "Get a calculation scale description of a language-dependent.",
        "operationId": "getCalculationScaleDescriptionById",
        "parameters": [
          {
            "name": "calculationScaleId",
            "in": "path",
            "description": "The Calculation Scale ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID, The language for which this information applies.",
            "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": "A Language-dependent information for a Calculation Scale.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CalculationScaleDescription"
                }
              }
            }
          },
          "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 Scale Descriptions"
        ],
        "description": "Delete a language-dependent calculation scale description.",
        "operationId": "deleteCalculationScaleDescriptionById",
        "parameters": [
          {
            "name": "calculationScaleId",
            "in": "path",
            "description": "The Calculation Scale ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID, The language for which this information applies.",
            "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 Scale Descriptions"
        ],
        "description": "Update a language-dependent calculation scale description.",
        "operationId": "updateCalculationScaleDescriptionById",
        "parameters": [
          {
            "name": "calculationScaleId",
            "in": "path",
            "description": "The Calculation Scale ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language ID, The language for which this information applies.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A Language-dependent information for a Calculation Scale.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculationScaleDescriptions"
              }
            }
          },
          "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": "CalculationScaleDescription"
      }
    }
  },
  "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."
      },
      "CalculationScaleDescriptions": {
        "required": [
          "calculationScaleId",
          "languageId"
        ],
        "type": "object",
        "properties": {
          "calculationScaleId": {
            "type": "integer",
            "description": "The Calculation Scale ID.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language ID, The language for which this information applies.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The description of the Calculation Scale."
          }
        }
      },
      "CalculationScaleDescription": {
        "required": [
          "calculationScaleId",
          "languageId"
        ],
        "type": "object",
        "properties": {
          "calculationScaleId": {
            "type": "integer",
            "description": "The Calculation Scale ID.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language ID, The language for which this information applies.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "The description of the Calculation Scale."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "A Language-dependent information for a Calculation Scale."
      },
      "CalculationScaleDescriptionCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/CalculationScaleDescription"
            }
          },
          "href": {
            "type": "string"
          }
        },
        "description": "A collection of language-dependent Calculation Scale Description."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}