This API returns the list of role type entitlements

POST 
/entitlements/roles

This API returns the list of role type entitlements

Request

Query Parameters

offset integer
pagesize integer

application/json

Body

fieldsstring
Example: entitlementID,entitlement_value,entitlementTypeName,description,customproperty2,customproperty3
sortstring
Example: entitlementID
orderstring
Example: desc

Responses

200

Successful operation

application/json

Schema

Schema

countinteger
Example: 4

roles

object[]

Array [

entitlementIDinteger

entitlement_valuestring

descriptionstring

displaynamestring

entitlement_glossarystring

statusstring

entclassstring

CUSTOMPROPERTY1string

CUSTOMPROPERTY2date-time

CUSTOMPROPERTY3date-time

CUSTOMPROPERTY4string

CUSTOMPROPERTY5string

CUSTOMPROPERTY6string

CUSTOMPROPERTY7string

CUSTOMPROPERTY8string

CUSTOMPROPERTY9string

CUSTOMPROPERTY10string

CUSTOMPROPERTY11string

CUSTOMPROPERTY12string

CUSTOMPROPERTY13string

CUSTOMPROPERTY14string

CUSTOMPROPERTY15string

CUSTOMPROPERTY16string

CUSTOMPROPERTY17string

CUSTOMPROPERTY18string

CUSTOMPROPERTY19string

CUSTOMPROPERTY20string

CUSTOMPROPERTY21string

CUSTOMPROPERTY22string

CUSTOMPROPERTY23string

CUSTOMPROPERTY24string

CUSTOMPROPERTY25string

CUSTOMPROPERTY26string

CUSTOMPROPERTY27string

CUSTOMPROPERTY28string

CUSTOMPROPERTY29string

CUSTOMPROPERTY30integer

CUSTOMPROPERTY31string

CUSTOMPROPERTY32string

CUSTOMPROPERTY33string

CUSTOMPROPERTY34string

CUSTOMPROPERTY35string

CUSTOMPROPERTY36string

CUSTOMPROPERTY37string

CUSTOMPROPERTY38string

CUSTOMPROPERTY39string

CUSTOMPROPERTY40string

childEntitlements

object

roles

object[]

Array [

entitlementIDinteger

]

ownersstring[]

]

Example (from schema)

{
  "count": 4,
  "roles": [
    {
      "entitlementID": 15553692240529,
      "entitlement_value": "Light agent",
      "description": "Can view and add private comments to tickets",
      "displayname": "Light agent",
      "entitlement_glossary": "Light agent",
      "status": "0",
      "entclass": "Role",
      "customproperty1": "NULL",
      "customproperty2": "2023-05-24t06:34:23.000z",
      "customproperty3": "2023-05-24t06:34:23.000z",
      "customproperty4": "NULL",
      "customproperty5": "NULL",
      "customproperty6": "NULL",
      "customproperty7": "NULL",
      "customproperty8": "NULL",
      "customproperty9": "NULL",
      "customproperty10": "NULL",
      "customproperty11": "NULL",
      "customproperty12": "NULL",
      "customproperty13": "NULL",
      "customproperty14": "NULL",
      "customproperty15": "NULL",
      "customproperty16": "NULL",
      "customproperty17": "NULL",
      "customproperty18": "NULL",
      "customproperty19": "NULL",
      "customproperty20": "NULL",
      "customproperty21": "NULL",
      "customproperty22": "NULL",
      "customproperty23": "NULL",
      "customproperty24": "NULL",
      "customproperty25": "NULL",
      "customproperty26": "NULL",
      "customproperty27": "NULL",
      "customproperty28": "NULL",
      "customproperty29": "NULL",
      "customproperty30": "NULL",
      "customproperty31": "NULL",
      "customproperty32": "NULL",
      "customproperty33": "NULL",
      "customproperty34": "NULL",
      "customproperty35": "NULL",
      "customproperty36": "NULL",
      "customproperty37": "NULL",
      "customproperty38": "NULL",
      "customproperty39": "NULL",
      "customproperty40": "NULL",
      "childEntitlements": {
        "roles": [
          {
            "entitlementID": 15553670302865
          },
          {
            "entitlementID": 15553670340241
          }
        ]
      },
      "owners": [
        "15553759289491"
      ]
    },
    {
      "entitlementID": 15553670302865,
      "entitlement_value": "Contributor",
      "description": "Can provide limited support",
      "displayname": "Contributor",
      "entitlement_glossary": "Contributor",
      "status": "1",
      "entclass": "Role",
      "customproperty1": "NULL",
      "customproperty2": "2023-05-24t06:34:23.000z",
      "customproperty3": "2023-05-24t06:34:23.000z",
      "customproperty4": "NULL",
      "customproperty5": "NULL",
      "customproperty6": "NULL",
      "customproperty7": "NULL",
      "customproperty8": "NULL",
      "customproperty9": "NULL",
      "customproperty10": "NULL",
      "customproperty11": "NULL",
      "customproperty12": "NULL",
      "customproperty13": "NULL",
      "customproperty14": "NULL",
      "customproperty15": "NULL",
      "customproperty16": "NULL",
      "customproperty17": "NULL",
      "customproperty18": "NULL",
      "customproperty19": "NULL",
      "customproperty20": "NULL",
      "customproperty21": "NULL",
      "customproperty22": "NULL",
      "customproperty23": "NULL",
      "customproperty24": "NULL",
      "customproperty25": "NULL",
      "customproperty26": "NULL",
      "customproperty27": "NULL",
      "customproperty28": "NULL",
      "customproperty29": "NULL",
      "customproperty30": "NULL",
      "customproperty31": "NULL",
      "customproperty32": "NULL",
      "customproperty33": "NULL",
      "customproperty34": "NULL",
      "customproperty35": "NULL",
      "customproperty36": "NULL",
      "customproperty37": "NULL",
      "customproperty38": "NULL",
      "customproperty39": "NULL",
      "customproperty40": "NULL",
      "owners": [
        "15553759289491"
      ]
    },
    {
      "entitlementID": 15553670340241,
      "entitlement_value": "Billing admin",
      "description": "Can manage all settings, including billing.",
      "displayname": "Billing admin",
      "entitlement_glossary": "Billing admin",
      "status": "0",
      "entclass": "Role",
      "customproperty1": "NULL",
      "customproperty2": "2023-05-24t06:34:23.000z",
      "customproperty3": "2023-05-24t06:34:23.000z",
      "customproperty4": "NULL",
      "customproperty5": "NULL",
      "customproperty6": "NULL",
      "customproperty7": "NULL",
      "customproperty8": "NULL",
      "customproperty9": "NULL",
      "customproperty10": "NULL",
      "customproperty11": "NULL",
      "customproperty12": "NULL",
      "customproperty13": "NULL",
      "customproperty14": "NULL",
      "customproperty15": "NULL",
      "customproperty16": "NULL",
      "customproperty17": "NULL",
      "customproperty18": "NULL",
      "customproperty19": "NULL",
      "customproperty20": "NULL",
      "customproperty21": "NULL",
      "customproperty22": "NULL",
      "customproperty23": "NULL",
      "customproperty24": "NULL",
      "customproperty25": "NULL",
      "customproperty26": "NULL",
      "customproperty27": "NULL",
      "customproperty28": "NULL",
      "customproperty29": "NULL",
      "customproperty30": "NULL",
      "customproperty31": "NULL",
      "customproperty32": "NULL",
      "customproperty33": "NULL",
      "customproperty34": "NULL",
      "customproperty35": "NULL",
      "customproperty36": "NULL",
      "customproperty37": "NULL",
      "customproperty38": "NULL",
      "customproperty39": "NULL",
      "customproperty40": "NULL",
      "owners": [
        "15553759289492"
      ]
    },
    {
      "entitlementID": 15553707898001,
      "entitlement_value": "Admin",
      "description": "Can manage all settings, except billing",
      "displayname": "Admin",
      "entitlement_glossary": "Admin",
      "status": "1",
      "entclass": "Role",
      "customproperty1": "NULL",
      "customproperty2": "2023-05-24t06:34:23.000z",
      "customproperty3": "2023-05-24t06:34:23.000z",
      "customproperty4": "NULL",
      "customproperty5": "NULL",
      "customproperty6": "NULL",
      "customproperty7": "NULL",
      "customproperty8": "NULL",
      "customproperty9": "NULL",
      "customproperty10": "NULL",
      "customproperty11": "NULL",
      "customproperty12": "NULL",
      "customproperty13": "NULL",
      "customproperty14": "NULL",
      "customproperty15": "NULL",
      "customproperty16": "NULL",
      "customproperty17": "NULL",
      "customproperty18": "NULL",
      "customproperty19": "NULL",
      "customproperty20": "NULL",
      "customproperty21": "NULL",
      "customproperty22": "NULL",
      "customproperty23": "NULL",
      "customproperty24": "NULL",
      "customproperty25": "NULL",
      "customproperty26": "NULL",
      "customproperty27": "NULL",
      "customproperty28": "NULL",
      "customproperty29": "NULL",
      "customproperty30": "NULL",
      "customproperty31": "NULL",
      "customproperty32": "NULL",
      "customproperty33": "NULL",
      "customproperty34": "NULL",
      "customproperty35": "NULL",
      "customproperty36": "NULL",
      "customproperty37": "NULL",
      "customproperty38": "NULL",
      "customproperty39": "NULL",
      "customproperty40": "NULL",
      "childEntitlements": {
        "roles": [
          {
            "entitlementID": 15553692240529
          },
          {
            "entitlementID": 15553670302865
          }
        ]
      },
      "owners": [
        "15553759289491"
      ]
    }
  ]
}

400

Failure in fetching entitlements list