Get Child Entitlements

GET 
/getChildEntitlements

This API can be used to get the list of all child entitlements. The Authorization must have Bearer followed by Token. Mandatory params: endpointname/endpointkey - if both are passed endpointkey is considered Optional params: entitlementtypekey/entitlementtypename - Possible values should have parent entitlementtypekey/entitlementtypename. If both are passed entitlementtypekey is considered, parententitlementvalue/parententitlementvaluekey - if both are passed parententitlementvaluekey is considered, entquery - query to support parent entitlement_values parameters. Sample - "pev.status = 1", childentquery - query to support child entitlement_values parameters. Sample - "cev.customproperty3 = '25'", entitlements2query - query to support entitlements2 parameters. Sample - "e2.jobId is not null", responsefields - possible values should have child entitlementvalue domain properties. Sample - ["description","customproperty1","customproperty3","displayname"], max, offset

Request

application/json

Body

childentquery string
endpointkey string
endpointname string
entitlements2query string
entitlementtypekey string
entitlementtypename string
entquery string
max string
offset string
parententitlementvalue string
parententitlementvaluekey string
responsefields string[]

Responses

200

Get Child Entitlements

Response Headers

• Access-Control-Allow-Credentials

  string

• Access-Control-Allow-Origin

  string

• Cache-Control

  string

• Date

  string

• Expires

  string

• Referrer-Policy

  string

• Server

  string

• Set-Cookie

  string

• Strict-Transport-Security

  string

• X-Content-Type-Options

  string

• X-Frame-Options

  string

application/json

Schema

Schema

childEntitlementsList

object[]

Array [

customproperty1 string

customproperty3 string

endpoint string

endpointKey number

entitlementType string

entitlementTypeKey number

entitlementTypeName string

entitlement_value string

entitlement_valuekey string

parententitlementvalue string

parententitlementvaluekey number

parententstatus string

requestForm string

]

displaycount number
errorcode string
msg string
totalcount number

Example (from schema)

{
  "childEntitlementsList": [
    {
      "customproperty1": "23.240.16.195/32",
      "customproperty3": "25",
      "endpoint": "AWS",
      "endpointKey": 1,
      "entitlementType": "SGIBRules",
      "entitlementTypeKey": 63,
      "entitlementTypeName": "SGIBRules",
      "entitlement_value": "InboundRules::sg-0303987b#0",
      "entitlement_valuekey": "189502",
      "parententitlementvalue": "sg-0303987b",
      "parententitlementvaluekey": 189260,
      "parententstatus": "1",
      "requestForm": "Request Form None"
    }
  ],
  "displaycount": 1,
  "errorcode": "0",
  "msg": "success",
  "totalcount": 1
}

Get Child Entitlements

{
  "childEntitlementsList": [
    {
      "customproperty1": "23.240.16.195/32",
      "customproperty3": "25",
      "endpoint": "AWS",
      "endpointKey": 1,
      "entitlementType": "SGIBRules",
      "entitlementTypeKey": 63,
      "entitlementTypeName": "SGIBRules",
      "entitlement_value": "InboundRules::sg-0303987b#0",
      "entitlement_valuekey": "189502",
      "parententitlementvalue": "sg-0303987b",
      "parententitlementvaluekey": 189260,
      "parententstatus": "1",
      "requestForm": "Request Form None"
    }
  ],
  "displaycount": 1,
  "errorcode": "0",
  "msg": "success",
  "totalcount": 1
}

Loading...