Skip to main content

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​

Path Parameters

    path stringrequired

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​

Get Child Entitlements

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Pragma

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

  • X-XSS-Protection

    string

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
Loading...