{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Field API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Field",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/organizationFields/:fieldId",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API get a field"
        },
        {
          "info": {
            "name": "Update Field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/organizationFields/:fieldId",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API edits a field"
        },
        {
          "info": {
            "name": "Get Field Permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/organizationFields/:fieldId/permissions",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API get a field permissions for all the profiles"
        },
        {
          "info": {
            "name": "Update Field Permissions",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/organizationFields/:fieldId/permissions",
            "params": [
              {
                "name": "fieldId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API update field permissions"
        },
        {
          "info": {
            "name": "Get Custom Field Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/customFieldCount",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "query",
                "description": "the module name with in which search to be done. Value may be tickets, contacts , accounts  ,tasks , timeEntry,products, contracts"
              }
            ]
          },
          "docs": "This API returns the custom field count allowed and available in a module."
        },
        {
          "info": {
            "name": "Get Fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/organizationFields",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "query",
                "description": "the module name with in which search to be done. Value may be tickets, contacts , accounts  ,tasks , timeEntry,products, contracts"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID of the department in which the layouts are configured"
              }
            ]
          },
          "docs": "This API fetches fields in a module"
        },
        {
          "info": {
            "name": "Create Field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/organizationFields",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "query",
                "description": "the module name with in which search to be done. Value may be tickets, contacts , accounts  ,tasks , timeEntry,products, contracts"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a field"
        }
      ]
    }
  ],
  "bundled": true
}