{
  "openapi": "3.0.1",
  "info": {
    "title": "Profiles",
    "version": "9.1.20.0",
    "description": "Create and administer profiles.",
    "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"
          ]
        }
      }
    }
  ],
  "paths": {
    "/profiles": {
      "get": {
        "tags": [
          "profiles"
        ],
        "description": "Get a collection of profiles.",
        "operationId": "getProfiles",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The profile id",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The Store ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "deviceFormatId",
            "in": "query",
            "description": "Indicates what default format to use for this profile element.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "usersView",
            "in": "query",
            "description": "Specifying whether USER view preferences are available and should be accessed for this profile.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lowPriority",
            "in": "query",
            "description": "The lowest priority for which this profile entry is valid (default is 0).",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "highPriority",
            "in": "query",
            "description": "The highest priority for which this profile entry is valid (default is 0).",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "archive",
            "in": "query",
            "description": "If set to 1, messages of this message type will be archived after being successfully sent.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "transportId",
            "in": "query",
            "description": "The transport.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "messageTypeId",
            "in": "query",
            "description": "The message type",
            "schema": {
              "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 profiles.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileCollection"
                },
                "example": {
                  "href": "https://10.190.66.162:8000/rest/admin/v2/profiles",
                  "items": [
                    {
                      "id": -1,
                      "storeId": 0,
                      "deviceFormatId": -3,
                      "usersView": "N",
                      "lowPriority": 0,
                      "highPriority": 60,
                      "archive": 1,
                      "transportId": -101,
                      "messageTypeId": 715838384,
                      "links": {
                        "self": {
                          "href": "https://localhost:8000/rest/admin/v2/profiles/1"
                        },
                        "transports": {
                          "href": "https://10.190.66.10:8000/rest/admin/v2/transports/-101"
                        },
                        "message-types": {
                          "href": "https://localhost:8000/rest/admin/v2/message-types/715838384"
                        }
                      }
                    }
                  ],
                  "count": 52
                }
              }
            }
          },
          "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": [
          "profiles"
        ],
        "description": "Create a profile.",
        "operationId": "createProfile",
        "requestBody": {
          "description": "A profile.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Profiles"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Shipping Arrangements.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetProfilesById": {
                "operationRef": "#/paths/~1profiles~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 /profiles/{id}`.\n"
              },
              "DeleteProfilesById": {
                "operationRef": "#/paths/~1profiles~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 /profiles/{id}`.\n"
              },
              "UpdateProfilesById": {
                "operationRef": "#/paths/~1/profiles~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 /profiles/{id}`.\n"
              },
              "GetTransportsProfilesById": {
                "operationRef": "#/paths/~1profiles~1{id}~1transports/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /profiles/{id}/transports`.\n"
              },
              "GetMessageTypeProfilesById": {
                "operationRef": "#/paths/~1profiles~1{id}~1message-types/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /profiles/{id}/message-types`.\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": "Profile"
      }
    },
    "/profiles/{id}": {
      "get": {
        "tags": [
          "profiles"
        ],
        "description": "Get a profile.",
        "operationId": "getProfileById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The profile 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 profile.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "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": [
          "profiles"
        ],
        "description": "Delete a profile.",
        "operationId": "deleteProfileById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The profile 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": [
          "profiles"
        ],
        "description": "Update a profile.",
        "operationId": "updateProfileById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The profile id",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A profile.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Profiles"
              }
            }
          },
          "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": "Profile"
      }
    },
    "/profiles/{id}/transports": {
      "get": {
        "tags": [
          "profiles"
        ],
        "description": "Finds the transport in a profile.",
        "operationId": "getTransportsOfProfile",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The profile 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": "An store transport.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transport"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    },
    "/profiles/{id}/message-types": {
      "get": {
        "tags": [
          "profiles"
        ],
        "description": "Finds the message type in a profile.",
        "operationId": "getMessageTypesOfProfile",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The profile 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/MessageType"
                },
                "example": {
                  "id": 715838384,
                  "direction": 0,
                  "name": "demo",
                  "viewName": "demo",
                  "description": "demo desc",
                  "links": {
                    "self": {
                      "href": "https://localhost:8000/rest/admin/v2/message-type/715838384"
                    }
                  }
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
      },
      "Profile": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The profile id",
            "format": "int32"
          },
          "storeId": {
            "type": "integer",
            "description": "The Store ID.",
            "format": "int32"
          },
          "deviceFormatId": {
            "type": "integer",
            "description": "Indicates what default format to use for this profile element.",
            "format": "int32"
          },
          "usersView": {
            "type": "string",
            "description": "Specifying whether USER view preferences are available and should be accessed for this profile."
          },
          "lowPriority": {
            "type": "integer",
            "description": "The lowest priority for which this profile entry is valid (default is 0).",
            "format": "int32"
          },
          "highPriority": {
            "type": "integer",
            "description": "The highest priority for which this profile entry is valid (default is 0).",
            "format": "int32"
          },
          "archive": {
            "type": "integer",
            "description": "If set to 1, messages of this message type will be archived after being successfully sent.",
            "format": "int32"
          },
          "transportId": {
            "type": "integer",
            "description": "The transport.",
            "format": "int32"
          },
          "messageTypeId": {
            "type": "integer",
            "description": "The message type",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                }
              },
              "transports": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                }
              },
              "message-types": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                }
              }
            }
          }
        },
        "description": "A profile."
      },
      "Profiles": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The profile id",
            "format": "int32"
          },
          "storeId": {
            "type": "integer",
            "description": "The Store ID.",
            "format": "int32"
          },
          "deviceFormatId": {
            "type": "integer",
            "description": "Indicates what default format to use for this profile element.",
            "format": "int32"
          },
          "usersView": {
            "type": "string",
            "description": "Specifying whether USER view preferences are available and should be accessed for this profile."
          },
          "lowPriority": {
            "type": "integer",
            "description": "The lowest priority for which this profile entry is valid (default is 0).",
            "format": "int32"
          },
          "highPriority": {
            "type": "integer",
            "description": "The highest priority for which this profile entry is valid (default is 0).",
            "format": "int32"
          },
          "archive": {
            "type": "integer",
            "description": "If set to 1, messages of this message type will be archived after being successfully sent.",
            "format": "int32"
          },
          "transportId": {
            "type": "integer",
            "description": "The transport.",
            "format": "int32"
          },
          "messageTypeId": {
            "type": "integer",
            "description": "The message type",
            "format": "int32"
          }
        }
      },
      "ProfileCollection": {
        "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/Profile"
            }
          }
        },
        "description": "A collection of profiles."
      },
      "Transport": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The transport ID.",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "The code of the transport."
          },
          "name": {
            "type": "string",
            "description": "The name of the transport."
          },
          "description": {
            "type": "string",
            "description": "The description."
          },
          "timeout": {
            "type": "integer",
            "description": "The timeout.",
            "format": "int32"
          },
          "implemented": {
            "type": "string",
            "description": "If it is implemented."
          },
          "addressable": {
            "type": "string",
            "description": "If it is addressable."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "An store transport."
      },
      "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."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "A message type"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}