agent-generator-cli 1.0.0 → 1.0.2

package/source/openapi-specifications/v1.0/support/CustomButton.json

@@ -0,0 +1,1898 @@
+{
+  "openapi" : "3.1.0",
+  "info" : {
+    "title" : "CustomButton",
+    "version" : "1.0.0",
+    "x-clan-group" : "integration",
+    "x-module-group" : "marketplace"
+  },
+  "paths" : {
+    "/api/v1/customButtons/{buttonId}" : {
+      "get" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Get details of a custom button",
+        "description" : "This API is used to fetch details of a custom button.",
+        "operationId" : "getButton",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/buttonId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/getButtonResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.READ" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "ReadAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "4854d623d49da7fcda9dcc30baa58a82",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.getButton"
+        }
+      },
+      "delete" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Delete a custom button",
+        "description" : "This API is used to delete a custom button.",
+        "operationId" : "deleteButton",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/buttonId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "204" : {
+            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.DELETE" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "WriteAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "e0d1d4f35cd587685b6bb5695b38cbad",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.deleteButton"
+        }
+      },
+      "patch" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Update the custom button",
+        "description" : "This API is used to update the details associated with a custom button.",
+        "operationId" : "updateButtonInvokeUrl",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/buttonId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "requestBody" : {
+          "$ref" : "#/components/requestBodies/invokeUrlRequest"
+        },
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/updateButtonInvokeUrlResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "WriteAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "4b4795b296d8c2a60147749f23192202",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.updateButton"
+        }
+      }
+    },
+    "/api/v1/myAccessibleCustomButtons" : {
+      "get" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Get my accessible custom buttons",
+        "description" : "This API fetches custom buttons that are accessible by a particular user.",
+        "operationId" : "getMyAccessibleButtons",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/module"
+        }, {
+          "$ref" : "#/components/parameters/departmentId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/getMyAccessibleButtonResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.READ" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "ReadAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "461aac7210365261b4de827b8dc6f955",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.getMyAccessibleButtons"
+        }
+      }
+    },
+    "/api/v1/customButtons/{buttonId}/execute" : {
+      "post" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Execute a custom button",
+        "description" : "This API is used to execute the action associated with a custom button that was configured during its creation.",
+        "operationId" : "executeButton",
+        "parameters" : [ {
+          "$ref" : "#/components/parameters/buttonId"
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "requestBody" : {
+          "$ref" : "#/components/requestBodies/executeButtonRequest"
+        },
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/executeButtonResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "WriteAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "245b27f9ead68582738a77d1fd9337a5",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.executeButton"
+        }
+      }
+    },
+    "/api/v1/customButtons" : {
+      "get" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "List the custom buttons",
+        "description" : "This API is used to fetch a list of custom buttons and their corresponding details.",
+        "operationId" : "getButtons",
+        "parameters" : [ {
+          "name" : "include",
+          "in" : "query",
+          "description" : "Fetches the profiles, department, actor and layout details of the custom button. The allowed values are: @profiles@, @department@, @actor@ and @layouts@",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null" ],
+            "description" : "Fetches the profiles, department, actor and layout details of the custom button. The allowed values are: @profiles@, @department@, @actor@ and @layouts@",
+            "enum" : [ "profiles", "department", "actor", "layouts" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "x-custom-parameters-attributes" : {
+              "split" : ",",
+              "entity" : "Include"
+            },
+            "x-audience" : [ "company-internal" ]
+          }
+        }, {
+          "$ref" : "#/components/parameters/departmentId"
+        }, {
+          "$ref" : "#/components/parameters/module"
+        }, {
+          "name" : "limit",
+          "in" : "query",
+          "description" : "The number of custom buttons that need to be fetched.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "description" : "The number of custom buttons that need to be fetched.",
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "name" : "name",
+          "in" : "query",
+          "description" : "The name of the custom button.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null" ],
+            "description" : "The name of the custom button.",
+            "maxLength" : 30,
+            "minLength" : 3
+          }
+        }, {
+          "name" : "from",
+          "in" : "query",
+          "description" : "The starting index number from which the custom buttons should be fetched.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "description" : "The starting index number from which the custom buttons should be fetched.",
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "name" : "location",
+          "in" : "query",
+          "description" : "The location of the custom button on the desk.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null" ],
+            "description" : "The location of the custom button on the desk.",
+            "enum" : [ "desk.ticket.detail.moreaction" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        }, {
+          "name" : "layoutId",
+          "in" : "query",
+          "description" : "IDs of Layouts for which the custom buttons should be fetched.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "description" : "IDs of Layouts for which the custom buttons should be fetched.",
+            "pattern" : "([0-9]+)"
+          }
+        }, {
+          "name" : "isEnable",
+          "in" : "query",
+          "description" : "Fetches enabled custom buttons for a specified location, if location is provided. If the location is not provided, the key fetches all the enabled custom buttons regardless of the location.",
+          "required" : false,
+          "style" : "form",
+          "explode" : true,
+          "schema" : {
+            "type" : [ "boolean", "null" ],
+            "description" : "Fetches enabled custom buttons for a specified location, if location is provided. If the location is not provided, the key fetches all the enabled custom buttons regardless of the location."
+          }
+        }, {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/getButtonsResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.READ" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "ReadAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "3f26874cc5a8cf5124170e1ef7bfdb71",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.getButtons"
+        }
+      },
+      "post" : {
+        "tags" : [ "CustomButton" ],
+        "summary" : "Create a custom button",
+        "description" : "This API is used to create a custom button.",
+        "operationId" : "createButtonInvokeUrl",
+        "parameters" : [ {
+          "$ref" : "../common/Common.json#/components/parameters/orgId"
+        } ],
+        "requestBody" : {
+          "$ref" : "#/components/requestBodies/createButtonInvokeUrl_invokeUrlRequest"
+        },
+        "responses" : {
+          "200" : {
+            "$ref" : "#/components/responses/createButtonCustomFunctionResponse"
+          },
+          "422" : {
+            "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
+          },
+          "500" : {
+            "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
+          },
+          "403" : {
+            "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
+          }
+        },
+        "security" : [ {
+          "org-oauth" : [ "Desk.accessAll.ALL" ]
+        }, {
+          "iam-oauth2-schema" : [ "Desk.settings.CREATE" ]
+        } ],
+        "x-audience" : [ "company-internal" ],
+        "x-custom-url-attribute" : {
+          "security" : {
+            "throttle" : {
+              "policy" : "WriteAPI_Standard_UserPolicy"
+            },
+            "extraparams" : {
+              "disable" : true,
+              "ignore" : false
+            },
+            "authentication" : { }
+          },
+          "clan-group" : "integration",
+          "apihash" : "5f29b7850bb4566d82238103631d9f30",
+          "module-group" : "marketplace",
+          "apimethod" : "com.zoho.desk.app.button.api.CustomButtonService.createButton"
+        }
+      }
+    }
+  },
+  "components" : {
+    "schemas" : {
+      "invokeUrlAction" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "encodeType" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "UTF_8" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "href" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[0-9a-zA-Z][-.\\w]*(:[0-9])*(/?)([a-zA-Z0-9\\-\\.\\?\\,|\\:\\'\\/\\+=&%\\$#_\\[\\]@!\\(\\)\\*;~]*)?$)|[*]"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "INVOKE_URL" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "openType" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "NEW_TAB" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "encodeType", "href", "id", "openType", "type" ]
+      },
+      "commonFields" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "module" : {
+            "type" : [ "string", "null" ],
+            "description" : "API name of the module to which the custom button belongs.",
+            "enum" : [ "tickets" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "departmentId" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "description" : "The ID of the department to which the custom button belongs.",
+            "pattern" : "([0-9]+)"
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "description" : "Name of the custom button.",
+            "maxLength" : 30,
+            "minLength" : 0
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "description" : "Description of the custom button.",
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "profileIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          },
+          "location" : {
+            "type" : [ "string", "null" ],
+            "description" : "The location of the custom button on the desk.",
+            "enum" : [ "desk.ticket.detail.moreaction" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "layoutIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          },
+          "visibilityType" : {
+            "type" : [ "string", "null" ],
+            "description" : "The visibility of custom button in the Layouts. The allowed values are @NO_LAYOUT@,@SPECIFIC_LAYOUT@ and @ALL_LAYOUT@",
+            "enum" : [ "SPECIFIC_LAYOUT" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "isEnable" : {
+            "type" : [ "boolean", "null" ],
+            "description" : "Specifies whether the visibility of the custom button for the particular location should be enabled or disabled."
+          }
+        },
+        "required" : [ "departmentId", "description", "isEnable", "layoutIds", "location", "module", "name", "profileIds", "visibilityType" ]
+      },
+      "commonResponseData" : {
+        "additionalProperties" : false,
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/commonFields"
+        }, {
+          "type" : [ "null", "object" ],
+          "properties" : {
+            "modifiedTime" : {
+              "type" : [ "string", "null" ],
+              "maxLength" : 100,
+              "minLength" : 0,
+              "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
+            },
+            "createdBy" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "createdTime" : {
+              "type" : [ "string", "null" ],
+              "maxLength" : 100,
+              "minLength" : 0,
+              "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
+            },
+            "modifiedBy" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "id" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            }
+          },
+          "required" : [ "createdBy", "createdTime", "id", "modifiedBy", "modifiedTime" ]
+        } ]
+      },
+      "invokeUrlButtonResponse" : {
+        "additionalProperties" : false,
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/commonResponseData"
+        }, {
+          "type" : [ "null", "object" ],
+          "properties" : {
+            "action" : {
+              "$ref" : "#/components/schemas/invokeUrlAction"
+            }
+          },
+          "required" : [ "action" ]
+        } ]
+      },
+      "customFunctionAction" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 30,
+            "minLength" : 0
+          },
+          "description" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "CUSTOM_FUNCTION" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "description", "id", "name", "type" ]
+      },
+      "customFunctionButtonResponse" : {
+        "additionalProperties" : false,
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/commonResponseData"
+        }, {
+          "type" : [ "null", "object" ],
+          "properties" : {
+            "action" : {
+              "$ref" : "#/components/schemas/customFunctionAction"
+            }
+          },
+          "required" : [ "action" ]
+        } ]
+      },
+      "myAccessibleButtonResponse" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "sequenceNumber" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int32",
+            "pattern" : "([0-9]+)"
+          },
+          "module" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "tickets" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "API name of the module.",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "name" : {
+            "type" : [ "string", "null" ],
+            "maxLength" : 30,
+            "minLength" : 0
+          },
+          "location" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "desk.ticket.detail.moreaction" ],
+            "maxLength" : 100,
+            "minLength" : 0,
+            "x-custom-parameters-attributes" : {
+              "removeExif" : false,
+              "filterMatchedContent" : false,
+              "antivirus" : false,
+              "replacementString" : "",
+              "allowInvalid" : false,
+              "descrption" : "The location of the custom button on the desk.",
+              "secret" : false,
+              "preserveCharsLimit" : 10,
+              "trim" : false,
+              "internalParam" : false,
+              "preserveChars" : "0,5",
+              "importUrl" : false,
+              "decrypt" : false
+            }
+          },
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "layoutIds" : {
+            "type" : [ "null", "array" ],
+            "items" : {
+              "type" : [ "string", "null", "integer" ],
+              "format" : "int64",
+              "pattern" : "([0-9]+)"
+            },
+            "uniqueItems" : false
+          },
+          "visibilityType" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "SPECIFIC_LAYOUT" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "id", "layoutIds", "location", "module", "name", "sequenceNumber", "visibilityType" ]
+      },
+      "myAccessibleInvokeUrlButtons" : {
+        "additionalProperties" : false,
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/myAccessibleButtonResponse"
+        }, {
+          "type" : [ "null", "object" ],
+          "properties" : {
+            "action" : {
+              "$ref" : "#/components/schemas/invokeUrlAction"
+            }
+          },
+          "required" : [ "action" ]
+        } ]
+      },
+      "myAccessibleCustomFunctionButtons" : {
+        "additionalProperties" : false,
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/myAccessibleButtonResponse"
+        }, {
+          "type" : [ "null", "object" ],
+          "properties" : {
+            "action" : {
+              "$ref" : "#/components/schemas/customFunctionAction"
+            }
+          },
+          "required" : [ "action" ]
+        } ]
+      },
+      "arrayOfButtonResponse" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "oneOf" : [ {
+            "$ref" : "#/components/schemas/myAccessibleInvokeUrlButtons"
+          }, {
+            "$ref" : "#/components/schemas/myAccessibleCustomFunctionButtons"
+          } ]
+        }
+      },
+      "arrayOfResponse" : {
+        "type" : [ "null", "array" ],
+        "items" : {
+          "oneOf" : [ {
+            "$ref" : "#/components/schemas/invokeUrlButtonResponse"
+          }, {
+            "$ref" : "#/components/schemas/customFunctionButtonResponse"
+          } ]
+        }
+      },
+      "customFunctionActionRequest" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "id" : {
+            "type" : [ "string", "null", "integer" ],
+            "format" : "int64",
+            "pattern" : "([0-9]+)"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "enum" : [ "CUSTOM_FUNCTION" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "id", "type" ]
+      },
+      "invokeUrlActionRequest" : {
+        "type" : [ "null", "object" ],
+        "additionalProperties" : false,
+        "properties" : {
+          "encodeType" : {
+            "type" : [ "string", "null" ],
+            "description" : "The encoding type to encode the provided data. The allowed values are @UTF_8@, @UTF_16@, @ISO_8859_1@, @ISO_8859_9@, @GB2312@, @BIG_5@, @SHIFT_JIS@",
+            "enum" : [ "UTF_8" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "href" : {
+            "type" : [ "string", "null" ],
+            "description" : "The URL to be invoked.",
+            "maxLength" : 100,
+            "minLength" : 0,
+            "pattern" : "(^(ht|f)tp(s?)\\://[0-9a-zA-Z][-.\\w]*(:[0-9])*(/?)([a-zA-Z0-9\\-\\.\\?\\,|\\:\\'\\/\\+=&%\\$#_\\[\\]@!\\(\\)\\*;~]*)?$)|[*]"
+          },
+          "type" : {
+            "type" : [ "string", "null" ],
+            "description" : "Action execution type. Allowed values are @INVOKE_URL@, @CUSTOM_FUNCTION@",
+            "enum" : [ "INVOKE_URL" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          },
+          "openType" : {
+            "type" : [ "string", "null" ],
+            "description" : "Indicates where the provided action link should be opened. The allowed values are @NEW_TAB@, @NEW_WINDOW@ and @SAME_TAB@",
+            "enum" : [ "NEW_TAB" ],
+            "maxLength" : 100,
+            "minLength" : 0
+          }
+        },
+        "required" : [ "encodeType", "href", "openType", "type" ]
+      }
+    },
+    "responses" : {
+      "getButtonResponse" : {
+        "description" : "getButtonResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/invokeUrlButtonResponse"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "creatorDetails" : {
+                      "$ref" : "./Module.json#/components/schemas/modifierJson"
+                    },
+                    "profiles" : {
+                      "type" : [ "null", "array" ],
+                      "items" : {
+                        "type" : [ "null", "object" ],
+                        "additionalProperties" : false,
+                        "maxProperties" : 2,
+                        "minProperties" : 2,
+                        "properties" : {
+                          "name" : {
+                            "type" : [ "string", "null" ],
+                            "maxLength" : 100,
+                            "minLength" : 0
+                          },
+                          "id" : {
+                            "type" : [ "string", "null", "integer" ],
+                            "format" : "int64",
+                            "pattern" : "([0-9]+)"
+                          }
+                        },
+                        "required" : [ "id", "name" ]
+                      },
+                      "uniqueItems" : false
+                    },
+                    "modifierDetails" : {
+                      "$ref" : "./Module.json#/components/schemas/modifierJson"
+                    },
+                    "department" : {
+                      "type" : [ "null", "object" ],
+                      "additionalProperties" : false,
+                      "maxProperties" : 2,
+                      "minProperties" : 2,
+                      "properties" : {
+                        "name" : {
+                          "type" : [ "string", "null" ],
+                          "maxLength" : 100,
+                          "minLength" : 0
+                        },
+                        "id" : {
+                          "type" : [ "string", "null", "integer" ],
+                          "format" : "int64",
+                          "pattern" : "([0-9]+)"
+                        }
+                      },
+                      "required" : [ "id", "name" ]
+                    },
+                    "layouts" : {
+                      "type" : [ "null", "array" ],
+                      "items" : {
+                        "type" : [ "null", "object" ],
+                        "additionalProperties" : false,
+                        "maxProperties" : 2,
+                        "minProperties" : 2,
+                        "properties" : {
+                          "name" : {
+                            "type" : [ "string", "null" ],
+                            "maxLength" : 100,
+                            "minLength" : 0
+                          },
+                          "id" : {
+                            "type" : [ "string", "null", "integer" ],
+                            "format" : "int64",
+                            "pattern" : "([0-9]+)"
+                          }
+                        },
+                        "required" : [ "id", "name" ]
+                      },
+                      "uniqueItems" : false
+                    }
+                  },
+                  "required" : [ "creatorDetails", "department", "layouts", "modifierDetails", "profiles" ]
+                } ]
+              }, {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/customFunctionButtonResponse"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "creatorDetails" : {
+                      "$ref" : "./Module.json#/components/schemas/modifierJson"
+                    },
+                    "profiles" : {
+                      "type" : [ "null", "array" ],
+                      "items" : {
+                        "type" : [ "null", "object" ],
+                        "additionalProperties" : false,
+                        "maxProperties" : 2,
+                        "minProperties" : 2,
+                        "properties" : {
+                          "name" : {
+                            "type" : [ "string", "null" ],
+                            "maxLength" : 100,
+                            "minLength" : 0
+                          },
+                          "id" : {
+                            "type" : [ "string", "null", "integer" ],
+                            "format" : "int64",
+                            "pattern" : "([0-9]+)"
+                          }
+                        },
+                        "required" : [ "id", "name" ]
+                      },
+                      "uniqueItems" : false
+                    },
+                    "modifierDetails" : {
+                      "$ref" : "./Module.json#/components/schemas/modifierJson"
+                    },
+                    "department" : {
+                      "type" : [ "null", "object" ],
+                      "additionalProperties" : false,
+                      "maxProperties" : 2,
+                      "minProperties" : 2,
+                      "properties" : {
+                        "name" : {
+                          "type" : [ "string", "null" ],
+                          "maxLength" : 100,
+                          "minLength" : 0
+                        },
+                        "id" : {
+                          "type" : [ "string", "null", "integer" ],
+                          "format" : "int64",
+                          "pattern" : "([0-9]+)"
+                        }
+                      },
+                      "required" : [ "id", "name" ]
+                    },
+                    "layouts" : {
+                      "type" : [ "null", "array" ],
+                      "items" : {
+                        "type" : [ "null", "object" ],
+                        "additionalProperties" : false,
+                        "maxProperties" : 2,
+                        "minProperties" : 2,
+                        "properties" : {
+                          "name" : {
+                            "type" : [ "string", "null" ],
+                            "maxLength" : 100,
+                            "minLength" : 0
+                          },
+                          "id" : {
+                            "type" : [ "string", "null", "integer" ],
+                            "format" : "int64",
+                            "pattern" : "([0-9]+)"
+                          }
+                        },
+                        "required" : [ "id", "name" ]
+                      },
+                      "uniqueItems" : false
+                    }
+                  },
+                  "required" : [ "creatorDetails", "department", "layouts", "modifierDetails", "profiles" ]
+                } ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "modifiedTime" : 1712927538000,
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "description" : null,
+                  "profileIds" : [ "1000000029914" ],
+                  "isEnable" : true,
+                  "createdBy" : "1000000000519",
+                  "name" : "CB1",
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "id" : "1000000085180",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "createdTime" : 1712927538000,
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "id" : "1000000085179",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "getMyAccessibleButtonResponse" : {
+        "description" : "getMyAccessibleButtonResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "data" : {
+                  "$ref" : "#/components/schemas/arrayOfButtonResponse"
+                }
+              },
+              "required" : [ "data" ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "data" : [ {
+                    "modifiedTime" : 1712927538000,
+                    "departmentId" : "1000000025940",
+                    "module" : "tickets",
+                    "description" : null,
+                    "profileIds" : [ "1000000029914" ],
+                    "isEnable" : true,
+                    "createdBy" : "1000000000519",
+                    "name" : "CB1",
+                    "action" : {
+                      "encodeType" : "UTF_8",
+                      "id" : "1000000085180",
+                      "href" : "https://acceptancetestdesk.requestcatcher.com",
+                      "type" : "INVOKE_URL",
+                      "openType" : "NEW_TAB"
+                    },
+                    "createdTime" : 1712927538000,
+                    "location" : "desk.ticket.detail.moreaction",
+                    "modifiedBy" : "1000000000519",
+                    "id" : "1000000085179",
+                    "layoutIds" : [ "1000000027886" ],
+                    "visibilityType" : "SPECIFIC_LAYOUT"
+                  } ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "executeButtonResponse" : {
+        "description" : "executeButtonResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "type" : [ "null", "object" ],
+                "additionalProperties" : false,
+                "properties" : {
+                  "type" : {
+                    "type" : [ "string", "null" ],
+                    "enum" : [ "INVOKE_URL" ],
+                    "maxLength" : 100,
+                    "minLength" : 0
+                  },
+                  "url" : {
+                    "type" : [ "null", "object" ],
+                    "additionalProperties" : false,
+                    "maxProperties" : 2,
+                    "minProperties" : 2,
+                    "properties" : {
+                      "href" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 100,
+                        "minLength" : 0,
+                        "pattern" : "(^(ht|f)tp(s?)\\://[0-9a-zA-Z][-.\\w]*(:[0-9])*(/?)([a-zA-Z0-9\\-\\.\\?\\,|\\:\\'\\/\\+=&%\\$#_\\[\\]@!\\(\\)\\*;~]*)?$)|[*]"
+                      },
+                      "openType" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 100,
+                        "minLength" : 0
+                      }
+                    },
+                    "required" : [ "href", "openType" ]
+                  }
+                },
+                "required" : [ "type", "url" ]
+              }, {
+                "type" : [ "null", "object" ],
+                "additionalProperties" : false,
+                "properties" : {
+                  "result" : {
+                    "type" : [ "null", "array" ],
+                    "items" : {
+                      "type" : [ "string", "null" ],
+                      "maxLength" : 100,
+                      "minLength" : 0
+                    },
+                    "uniqueItems" : false
+                  },
+                  "type" : {
+                    "type" : [ "string", "null" ],
+                    "enum" : [ "CUSTOM_FUNCTION" ],
+                    "maxLength" : 100,
+                    "minLength" : 0
+                  },
+                  "status" : {
+                    "type" : [ "string", "null" ],
+                    "maxLength" : 100,
+                    "minLength" : 0
+                  }
+                },
+                "required" : [ "result", "status", "type" ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "type" : "INVOKE_URL",
+                  "url" : {
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "openType" : "NEW_TAB"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "getButtonsResponse" : {
+        "description" : "getButtonsResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "allOf" : [ {
+                "type" : "object",
+                "properties" : {
+                  "creatorDetails" : {
+                    "type" : [ "null", "object" ],
+                    "additionalProperties" : false,
+                    "maxProperties" : 5,
+                    "minProperties" : 5,
+                    "properties" : {
+                      "photoURL" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 200,
+                        "minLength" : 0,
+                        "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+                      },
+                      "firstName" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 50,
+                        "minLength" : 0
+                      },
+                      "lastName" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 50,
+                        "minLength" : 0
+                      },
+                      "id" : {
+                        "type" : [ "string", "null", "integer" ],
+                        "format" : "int64",
+                        "pattern" : "([0-9]+)"
+                      },
+                      "email" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 100,
+                        "minLength" : 0,
+                        "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
+                      }
+                    },
+                    "required" : [ "email", "firstName", "id", "lastName", "photoURL" ]
+                  },
+                  "profiles" : {
+                    "type" : [ "null", "array" ],
+                    "items" : {
+                      "type" : [ "null", "object" ],
+                      "additionalProperties" : false,
+                      "maxProperties" : 2,
+                      "minProperties" : 2,
+                      "properties" : {
+                        "name" : {
+                          "type" : [ "string", "null" ],
+                          "maxLength" : 30,
+                          "minLength" : 0
+                        },
+                        "id" : {
+                          "type" : [ "string", "null", "integer" ],
+                          "format" : "int64",
+                          "pattern" : "([0-9]+)"
+                        }
+                      },
+                      "required" : [ "id", "name" ]
+                    },
+                    "uniqueItems" : false
+                  },
+                  "modifierDetails" : {
+                    "type" : [ "null", "object" ],
+                    "additionalProperties" : false,
+                    "maxProperties" : 5,
+                    "minProperties" : 5,
+                    "properties" : {
+                      "photoURL" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 200,
+                        "minLength" : 0,
+                        "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
+                      },
+                      "firstName" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 50,
+                        "minLength" : 0
+                      },
+                      "lastName" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 50,
+                        "minLength" : 0
+                      },
+                      "id" : {
+                        "type" : [ "string", "null", "integer" ],
+                        "format" : "int64",
+                        "pattern" : "([0-9]+)"
+                      },
+                      "email" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 100,
+                        "minLength" : 0,
+                        "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
+                      }
+                    },
+                    "required" : [ "email", "firstName", "id", "lastName", "photoURL" ]
+                  },
+                  "department" : {
+                    "type" : [ "null", "object" ],
+                    "additionalProperties" : false,
+                    "maxProperties" : 2,
+                    "minProperties" : 2,
+                    "properties" : {
+                      "name" : {
+                        "type" : [ "string", "null" ],
+                        "maxLength" : 30,
+                        "minLength" : 0
+                      },
+                      "id" : {
+                        "type" : [ "string", "null", "integer" ],
+                        "format" : "int64",
+                        "pattern" : "([0-9]+)"
+                      }
+                    },
+                    "required" : [ "id", "name" ]
+                  },
+                  "layouts" : {
+                    "type" : [ "null", "array" ],
+                    "items" : {
+                      "type" : [ "null", "object" ],
+                      "additionalProperties" : false,
+                      "maxProperties" : 2,
+                      "minProperties" : 2,
+                      "properties" : {
+                        "name" : {
+                          "type" : [ "string", "null" ],
+                          "maxLength" : 30,
+                          "minLength" : 0
+                        },
+                        "id" : {
+                          "type" : [ "string", "null", "integer" ],
+                          "format" : "int64",
+                          "pattern" : "([0-9]+)"
+                        }
+                      },
+                      "required" : [ "id", "name" ]
+                    },
+                    "uniqueItems" : false
+                  }
+                }
+              }, {
+                "type" : [ "null", "object" ],
+                "additionalProperties" : false,
+                "properties" : {
+                  "data" : {
+                    "$ref" : "#/components/schemas/arrayOfResponse"
+                  }
+                },
+                "required" : [ "data" ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "data" : [ {
+                    "modifiedTime" : 1712927538000,
+                    "departmentId" : "1000000025940",
+                    "module" : "tickets",
+                    "description" : null,
+                    "profileIds" : [ "1000000029914" ],
+                    "isEnable" : true,
+                    "createdBy" : "1000000000519",
+                    "name" : "CB1",
+                    "action" : {
+                      "encodeType" : "UTF_8",
+                      "id" : "1000000085180",
+                      "href" : "https://acceptancetestdesk.requestcatcher.com",
+                      "type" : "INVOKE_URL",
+                      "openType" : "NEW_TAB"
+                    },
+                    "createdTime" : 1712927538000,
+                    "location" : "desk.ticket.detail.moreaction",
+                    "modifiedBy" : "1000000000519",
+                    "id" : "1000000085179",
+                    "layoutIds" : [ "1000000027886" ],
+                    "visibilityType" : "SPECIFIC_LAYOUT"
+                  } ]
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "updateButtonCustomFunctionResponse" : {
+        "description" : "updateButtonCustomFunctionResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/invokeUrlAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              }, {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/customFunctionAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "modifiedTime" : 1712927538000,
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "description" : null,
+                  "profileIds" : [ "1000000029914" ],
+                  "isEnable" : true,
+                  "createdBy" : "1000000000519",
+                  "name" : "CB1",
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "id" : "1000000085180",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "createdTime" : 1712927538000,
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "id" : "1000000085179",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "updateButtonInvokeUrlResponse" : {
+        "description" : "updateButtonInvokeUrlResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/invokeUrlAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              }, {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/customFunctionAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "modifiedTime" : 1712927538000,
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "description" : null,
+                  "profileIds" : [ "1000000029914" ],
+                  "isEnable" : true,
+                  "createdBy" : "1000000000519",
+                  "name" : "CB1",
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "id" : "1000000085180",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "createdTime" : 1712927538000,
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "id" : "1000000085179",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "createButtonInvokeUrlResponse" : {
+        "description" : "createButtonInvokeUrlResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/invokeUrlAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              }, {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/customFunctionAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "modifiedTime" : 1712927538000,
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "description" : null,
+                  "profileIds" : [ "1000000029914" ],
+                  "isEnable" : true,
+                  "createdBy" : "1000000000519",
+                  "name" : "CB1",
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "id" : "1000000085180",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "createdTime" : 1712927538000,
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "id" : "1000000085179",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      },
+      "createButtonCustomFunctionResponse" : {
+        "description" : "createButtonCustomFunctionResponse template definitions",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "oneOf" : [ {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/invokeUrlAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              }, {
+                "additionalProperties" : false,
+                "allOf" : [ {
+                  "$ref" : "#/components/schemas/commonResponseData"
+                }, {
+                  "type" : [ "null", "object" ],
+                  "properties" : {
+                    "action" : {
+                      "$ref" : "#/components/schemas/customFunctionAction"
+                    }
+                  },
+                  "required" : [ "action" ]
+                } ]
+              } ]
+            },
+            "examples" : {
+              "Valid responses Definitions" : {
+                "value" : {
+                  "modifiedTime" : 1712927538000,
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "description" : null,
+                  "profileIds" : [ "1000000029914" ],
+                  "isEnable" : true,
+                  "createdBy" : "1000000000519",
+                  "name" : "CB1",
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "id" : "1000000085180",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "createdTime" : 1712927538000,
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "id" : "1000000085179",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-response-attributes" : {
+          "disable-safe-headers" : "[]"
+        }
+      }
+    },
+    "parameters" : {
+      "module" : {
+        "name" : "module",
+        "in" : "query",
+        "description" : "API name of the module.",
+        "required" : true,
+        "style" : "form",
+        "explode" : true,
+        "schema" : {
+          "type" : [ "string", "null" ],
+          "description" : "API name of the module.",
+          "enum" : [ "tickets" ],
+          "maxLength" : 100,
+          "minLength" : 0
+        }
+      },
+      "departmentId" : {
+        "name" : "departmentId",
+        "in" : "query",
+        "description" : "The ID of the department.",
+        "required" : false,
+        "style" : "form",
+        "explode" : true,
+        "schema" : {
+          "type" : [ "string", "null", "integer" ],
+          "format" : "int64",
+          "description" : "The ID of the department.",
+          "pattern" : "([0-9]+)"
+        }
+      },
+      "buttonId" : {
+        "name" : "buttonId",
+        "in" : "path",
+        "required" : true,
+        "style" : "simple",
+        "explode" : false,
+        "schema" : {
+          "type" : [ "string", "null", "integer" ],
+          "format" : "int64",
+          "pattern" : "([0-9]+)"
+        }
+      }
+    },
+    "requestBodies" : {
+      "executeButtonRequest" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "type" : [ "null", "object" ],
+              "additionalProperties" : false,
+              "properties" : {
+                "entityId" : {
+                  "type" : [ "string", "null", "integer" ],
+                  "format" : "int64",
+                  "description" : "IDs of entities that are associated with the custom button",
+                  "pattern" : "([0-9]+)"
+                }
+              }
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "entityId" : "1000000084646"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      },
+      "customFunctionRequest" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "additionalProperties" : false,
+              "allOf" : [ {
+                "$ref" : "#/components/schemas/commonFields"
+              }, {
+                "type" : [ "null", "object" ],
+                "properties" : {
+                  "action" : {
+                    "$ref" : "#/components/schemas/customFunctionActionRequest"
+                  }
+                }
+              }, {
+                "type" : "object",
+                "required" : [ "action", "departmentId", "location", "module", "name", "profileIds", "visibilityType" ]
+              } ]
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "name" : "CB1",
+                  "profileIds" : [ "1000000029914" ],
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      },
+      "invokeUrlRequest" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "additionalProperties" : false,
+              "allOf" : [ {
+                "$ref" : "#/components/schemas/commonFields"
+              }, {
+                "type" : [ "null", "object" ],
+                "properties" : {
+                  "action" : {
+                    "$ref" : "#/components/schemas/invokeUrlActionRequest"
+                  }
+                }
+              }, {
+                "type" : "object",
+                "required" : [ "action", "departmentId", "location", "module", "name", "profileIds", "visibilityType" ]
+              } ]
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "name" : "CB1",
+                  "profileIds" : [ "1000000029914" ],
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      },
+      "createButtonInvokeUrl_invokeUrlRequest" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "additionalProperties" : false,
+              "allOf" : [ {
+                "$ref" : "#/components/schemas/commonFields"
+              }, {
+                "type" : [ "null", "object" ],
+                "properties" : {
+                  "action" : {
+                    "$ref" : "#/components/schemas/invokeUrlActionRequest"
+                  }
+                }
+              }, {
+                "type" : "object",
+                "required" : [ "action", "departmentId", "location", "module", "name", "profileIds", "visibilityType" ]
+              } ]
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "name" : "CB1",
+                  "profileIds" : [ "1000000029914" ],
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      },
+      "createButtonCustomFunction_customFunctionRequest" : {
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "additionalProperties" : false,
+              "allOf" : [ {
+                "$ref" : "#/components/schemas/commonFields"
+              }, {
+                "type" : [ "null", "object" ],
+                "properties" : {
+                  "action" : {
+                    "$ref" : "#/components/schemas/customFunctionActionRequest"
+                  }
+                }
+              }, {
+                "type" : "object",
+                "required" : [ "action", "departmentId", "location", "module", "name", "profileIds", "visibilityType" ]
+              } ]
+            },
+            "examples" : {
+              "Valid requestBody Definitions" : {
+                "value" : {
+                  "departmentId" : "1000000025940",
+                  "module" : "tickets",
+                  "name" : "CB1",
+                  "profileIds" : [ "1000000029914" ],
+                  "action" : {
+                    "encodeType" : "UTF_8",
+                    "href" : "https://acceptancetestdesk.requestcatcher.com",
+                    "type" : "INVOKE_URL",
+                    "openType" : "NEW_TAB"
+                  },
+                  "location" : "desk.ticket.detail.moreaction",
+                  "modifiedBy" : "1000000000519",
+                  "layoutIds" : [ "1000000027886" ],
+                  "visibilityType" : "SPECIFIC_LAYOUT"
+                }
+              }
+            }
+          }
+        },
+        "x-custom-request-body-attributes" : {
+          "non-empty" : false,
+          "allow-invalid" : false
+        }
+      }
+    },
+    "securitySchemes" : {
+      "cookie-auth" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
+      },
+      "org-oauth" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
+      },
+      "iam-oauth2-schema" : {
+        "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
+      }
+    }
+  },
+  "x-entity" : "CustomButton"
+}