{
  "openapi": "3.0.1",
  "info": {
    "title": "Offer Descriptions",
    "description": "Create and administer offer 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": "Offer Descriptions",
      "description": "Provide RESTful services to manage offer descriptions."
    }
  ],
  "paths": {
    "/offer-descriptions": {
      "get": {
        "tags": [
          "Offer Descriptions"
        ],
        "description": "Get a collection of offer descriptions.",
        "operationId": "getOfferDescriptions",
        "parameters": [
          {
            "name": "offerId",
            "in": "query",
            "description": "The offer ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The offer description in the language.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.name",
            "in": "query",
            "description": "The unique system-generated code for identifying the workspace. This identifier is not the name that is assigned to the workspace by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.taskGroup",
            "in": "query",
            "description": "The unique system-generated code for identifying the task group. This identifier is not the name that is assigned to the task group by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.task",
            "in": "query",
            "description": "The unique system-generated code for identifying the task. This identifier is not the name that is assigned to the task by the Workspace Manager.",
            "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 offer descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferDescriptionCollection"
                }
              }
            }
          },
          "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": [
          "Offer Descriptions"
        ],
        "description": "Create an offer description.",
        "operationId": "createOfferDescription",
        "parameters": [
          {
            "name": "workspace.name",
            "in": "query",
            "description": "The unique system-generated code for identifying the workspace. This identifier is not the name that is assigned to the workspace by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.taskGroup",
            "in": "query",
            "description": "The unique system-generated code for identifying the task group. This identifier is not the name that is assigned to the task group by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.task",
            "in": "query",
            "description": "The unique system-generated code for identifying the task. This identifier is not the name that is assigned to the task by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The Offer description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OfferDescription.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the offer-descriptions.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetOfferDescriptionsByofferIdandlanguageId": {
                "operationRef": "#/paths/~1offer-descriptions~1offerId:{offerId},languageId:{languageId}/get",
                "parameters": {
                  "offerId": "$request.body#/offerId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `offerId`,`languageId` value used in the request body can be used as the `offerId`,`languageId` parameter in `GET /offer-descriptions/offerId:{offerId},languageId:{languageId}`.\n"
              },
              "DeleteOfferDescriptionsByofferIdandlanguageId": {
                "operationRef": "#/paths/~1offer-descriptions~1offerId:{offerId},languageId:{languageId}/delete",
                "parameters": {
                  "offerId": "$request.body#/offerId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `offerId`,`languageId` value used in the request body can be used as the `offerId`,`languageId` parameter in `DELETE /offer-descriptions/offerId:{offerId},languageId:{languageId}`.\n"
              },
              "UpdateOfferDescriptionsByofferIdandlanguageId": {
                "operationRef": "#/paths/~1offer-descriptions~1offerId:{offerId},languageId:{languageId}/patch",
                "parameters": {
                  "offerId": "$request.body#/offerId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `offerId`,`languageId` value used in the request body can be used as the `offerId`,`languageId` parameter in `PATCH /offer-descriptions/offerId:{offerId},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": "OfferDescription"
      }
    },
    "/offer-descriptions/offerId:{offerId},languageId:{languageId}": {
      "get": {
        "tags": [
          "Offer Descriptions"
        ],
        "description": "Get an offer description.",
        "operationId": "getOfferDescriptionById",
        "parameters": [
          {
            "name": "offerId",
            "in": "path",
            "description": "The offer ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "workspace.name",
            "in": "query",
            "description": "The unique system-generated code for identifying the workspace. This identifier is not the name that is assigned to the workspace by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.taskGroup",
            "in": "query",
            "description": "The unique system-generated code for identifying the task group. This identifier is not the name that is assigned to the task group by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.task",
            "in": "query",
            "description": "The unique system-generated code for identifying the task. This identifier is not the name that is assigned to the task by the Workspace Manager.",
            "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": "The Offer description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferDescription"
                }
              }
            }
          },
          "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": [
          "Offer Descriptions"
        ],
        "description": "Delete an offer description.",
        "operationId": "deleteOfferDescriptionById",
        "parameters": [
          {
            "name": "offerId",
            "in": "path",
            "description": "The offer ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "workspace.name",
            "in": "query",
            "description": "The unique system-generated code for identifying the workspace. This identifier is not the name that is assigned to the workspace by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.taskGroup",
            "in": "query",
            "description": "The unique system-generated code for identifying the task group. This identifier is not the name that is assigned to the task group by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.task",
            "in": "query",
            "description": "The unique system-generated code for identifying the task. This identifier is not the name that is assigned to the task by the Workspace Manager.",
            "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": [
          "Offer Descriptions"
        ],
        "description": "Update an offer description.",
        "operationId": "updateOfferDescriptionById",
        "parameters": [
          {
            "name": "offerId",
            "in": "path",
            "description": "The offer ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "workspace.name",
            "in": "query",
            "description": "The unique system-generated code for identifying the workspace. This identifier is not the name that is assigned to the workspace by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.taskGroup",
            "in": "query",
            "description": "The unique system-generated code for identifying the task group. This identifier is not the name that is assigned to the task group by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspace.task",
            "in": "query",
            "description": "The unique system-generated code for identifying the task. This identifier is not the name that is assigned to the task by the Workspace Manager.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The Offer description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OfferDescription.request"
              }
            }
          },
          "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": "OfferDescription"
      }
    }
  },
  "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."
      },
      "OfferDescription": {
        "type": "object",
        "properties": {
          "offerId": {
            "type": "string",
            "description": "The offer 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 offer description in the language."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The Offer description."
      },
      "OfferDescription.request": {
        "type": "object",
        "properties": {
          "offerId": {
            "type": "string",
            "description": "The offer 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 offer description in the language."
          }
        },
        "description": "The Offer description."
      },
      "OfferDescriptionCollection": {
        "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/OfferDescription"
            }
          }
        },
        "description": "A collection of offer descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}