{
  "openapi": "3.0.1",
  "info": {
    "title": "Number Usage Descriptions",
    "description": "Create and administer number usage 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": "Number Usage Descriptions",
      "description": "Provide RESTful services to manage number usage descriptions."
    }
  ],
  "paths": {
    "/number-usage-descriptions": {
      "get": {
        "tags": [
          "Number Usage Descriptions"
        ],
        "description": "Get a collection of NumberUsage descriptions.",
        "operationId": "getNumberUsageDescriptions",
        "parameters": [
          {
            "name": "numberUsageId",
            "in": "query",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The Language used for the NumberUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "A brief description of the NumberUsage, suitable for display by an administration user interface that works with NumberUsages.",
            "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 NumberUsage descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberUsageDescriptionCollection"
                }
              }
            }
          },
          "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": [
          "Number Usage Descriptions"
        ],
        "description": "Create a NumberUsage description.",
        "operationId": "createNumberUsageDescription",
        "requestBody": {
          "description": "Language-dependent information for a NumberUsage.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberUsageDescription.requestbody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {}
          },
          "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": "NumberUsageDescription"
      }
    },
    "/number-usage-descriptions/numberUsageId:{numberUsageId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Number Usage Descriptions"
        ],
        "description": "Get a NumberUsage description.",
        "operationId": "getNumberUsageDescriptionById",
        "parameters": [
          {
            "name": "numberUsageId",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language used for the NumberUsage.",
            "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": "Language-dependent information for a NumberUsage.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberUsageDescription"
                }
              }
            }
          },
          "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": [
          "Number Usage Descriptions"
        ],
        "description": "Delete a NumberUsage description.",
        "operationId": "deleteNumberUsageDescriptionById",
        "parameters": [
          {
            "name": "numberUsageId",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language used for the NumberUsage.",
            "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": [
          "Number Usage Descriptions"
        ],
        "description": "Update a NumberUsage description.",
        "operationId": "updateNumberUsageDescriptionById",
        "parameters": [
          {
            "name": "numberUsageId",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The Language used for the NumberUsage.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Language-dependent information for a NumberUsage.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberUsageDescription.requestbody"
              }
            }
          },
          "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": "NumberUsageDescription"
      }
    }
  },
  "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."
      },
      "NumberUsageDescription": {
        "type": "object",
        "properties": {
          "numberUsageId": {
            "type": "integer",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language used for the NumberUsage.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the NumberUsage, suitable for display by an administration user interface that works with NumberUsages."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            },
            "required": [
              "self"
            ]
          }
        },
        "description": "Language-dependent information for a NumberUsage."
      },
      "NumberUsageDescription.requestbody": {
        "type": "object",
        "properties": {
          "numberUsageId": {
            "type": "integer",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language used for the NumberUsage.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the NumberUsage, suitable for display by an administration user interface that works with NumberUsages."
          }
        },
        "description": "Language-dependent information for a NumberUsage."
      },
      "NumberUsageDescriptionCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/NumberUsageDescription"
            }
          }
        },
        "description": "A collection of NumberUsage descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}