{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter LayoutRules API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "LayoutRules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Layout Rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/layouts/:layoutId/layoutRules/:layoutRuleId",
            "params": [
              {
                "name": "layoutRuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "layoutId",
                "value": "",
                "type": "path",
                "description": "Get the rules of the layout"
              }
            ]
          },
          "docs": "This API fetches a single rule from your help desk layout."
        },
        {
          "info": {
            "name": "Update Layout Rule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/layouts/:layoutId/layoutRules/:layoutRuleId",
            "params": [
              {
                "name": "layoutRuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "layoutId",
                "value": "",
                "type": "path",
                "description": "Get the rules of the layout"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates the details of an existing layout rule in a particular layout."
        },
        {
          "info": {
            "name": "Delete Layout Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/layouts/:layoutId/layoutRules/:layoutRuleId",
            "params": [
              {
                "name": "layoutRuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "layoutId",
                "value": "",
                "type": "path",
                "description": "Get the rules of the layout"
              }
            ]
          },
          "docs": "This API deletes a layout rule created for a field from a layout."
        },
        {
          "info": {
            "name": "Create Layout Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/layouts/:layoutId/layoutRules",
            "params": [
              {
                "name": "layoutId",
                "value": "",
                "type": "path",
                "description": "Get the rules of the layout"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a rule for a field in a layout."
        },
        {
          "info": {
            "name": "Get Layout Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/layoutRules",
            "params": [
              {
                "name": "searchString",
                "value": "",
                "type": "query",
                "description": "Get the rules that have this search term"
              },
              {
                "name": "executeInHelpCentre",
                "value": "",
                "type": "query",
                "description": "Get the rules that can be executed in help centre"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "Get the rules of the department"
              },
              {
                "name": "module",
                "value": "",
                "type": "query",
                "description": "Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of rules to be fetched. Default is 50"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the rules must be fetched"
              },
              {
                "name": "layoutId",
                "value": "",
                "type": "path",
                "description": "Get the rules of the layout"
              },
              {
                "name": "activeRules",
                "value": "",
                "type": "query",
                "description": "Get the rules that are active in the layout"
              }
            ]
          },
          "docs": "This API lists all the rules configured for a department/layout."
        }
      ]
    }
  ],
  "bundled": true
}