{
  "openapi": "3.0.1",
  "info": {
    "title": "Message Types",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of message types.",
    "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": "Message Types",
      "description": "Provide RESTful services to manage message types."
    }
  ],
  "paths": {
    "/message-types": {
      "get": {
        "tags": [
          "Message Types"
        ],
        "description": "Get a collection of message types.",
        "operationId": "getMessageTypes",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The message type id.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "direction",
            "in": "query",
            "description": "The direction of transmission this message is valid for, 1=outgoing, 2=incoming, or 3=send-receive.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Short name for message type.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "viewName",
            "in": "query",
            "description": "Name of view associated with this message type. This view must be registered to be usable in message transmission. This is a mandatory field.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "Description of the message type.",
            "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 message types.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessageTypeCollection"
                }
              }
            }
          },
          "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": [
          "Message Types"
        ],
        "description": "Create a message type.",
        "operationId": "createMessageType",
        "requestBody": {
          "description": "A message type",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MessageType"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Message Types.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetMessageTypesById": {
                "operationRef": "#/paths/~1message-types~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 /message-types/{id}`.\n"
              },
              "DeleteMessageTypesById": {
                "operationRef": "#/paths/~1message-types~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 /message-types/{id}`.\n"
              },
              "UpdateMessageTypesById": {
                "operationRef": "#/paths/~1message-types~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 /message-types/{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": "MessageType"
      }
    },
    "/message-types/{id}": {
      "get": {
        "tags": [
          "Message Types"
        ],
        "description": "Get a message type.",
        "operationId": "getMessageTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The message type 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 message type",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessageTypes"
                }
              }
            }
          },
          "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": [
          "Message Types"
        ],
        "description": "Delete a message type.",
        "operationId": "deleteMessageTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The message type 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": [
          "Message Types"
        ],
        "description": "Update a message type.",
        "operationId": "updateMessageTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The message type id.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A message type",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MessageType"
              }
            }
          },
          "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": "MessageType"
      }
    }
  },
  "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."
      },
      "MessageTypes": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The message type id.",
            "format": "int32"
          },
          "direction": {
            "type": "integer",
            "description": "The direction of transmission this message is valid for, 1=outgoing, 2=incoming, or 3=send-receive.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "Short name for message type."
          },
          "viewName": {
            "type": "string",
            "description": "Name of view associated with this message type. This view must be registered to be usable in message transmission. This is a mandatory field."
          },
          "description": {
            "type": "string",
            "description": "Description of the message type."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "A message type"
      },
      "MessageType": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The message type id.",
            "format": "int32"
          },
          "direction": {
            "type": "integer",
            "description": "The direction of transmission this message is valid for, 1=outgoing, 2=incoming, or 3=send-receive.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "Short name for message type."
          },
          "viewName": {
            "type": "string",
            "description": "Name of view associated with this message type. This view must be registered to be usable in message transmission. This is a mandatory field."
          },
          "description": {
            "type": "string",
            "description": "Description of the message type."
          }
        },
        "description": "A message type"
      },
      "MessageTypeCollection": {
        "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/MessageTypes"
            }
          }
        },
        "description": "A collection of message types."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}