Search Escalation Policies

Gets the escalation polices defined for the tenant.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Current pagination number

  • pageSizeinteger

    No of records in each page

  • isDescendingOrderboolean

    Pagination data ordering: true for descending false for ascending

  • sortNamestring

    Field name on which paginated data is ordered

    Enum:
    idtsstartaltimec_namep_namesourcertypername
  • queryStringstringrequired

    Generic query string to be prepared using below query parameters See "api-overview"

  • namestring

    Alert Escalation policy name. Only identical policies in query string name are displayed.

  • allListstring

    This string is applicable to a partner user to fetch client policies as well. By default, OpsRamp provides partner alert escalation policies if allList is not provided in the query string.Provide allList:true to fetch partner and client alert escalation policies. Provide allList:false to fetch only partner alert escalation policies.

    Enum:
    truefalse

    Default: true

  • startCreationDatestring

    Search for policies created within a certain time frame. Provide a start date. An example: 2017-05-05T13:25:15 0000

  • endCreationDatestring

    Provide an end date. An example: 2017-05-08T10:30:40 0000

  • startUpdationDatestring

    Search for policies updated within a certain time frame. Provide a start date. An example: 2017-06-10T09:20:10 0000

  • endUpdationDatestring

    Provide an end date. An example: 2017-06-15T08:10:30 0000

Responses

  • resultsarray

    Paginated results of the querySet

  • totalResultsinteger

    Total paginated records

  • pageNointeger

    Page no of paginated results

  • pageSizeinteger

    No of records in page

  • totalPagesinteger

    Total no of pages in paginated results

  • nextPageboolean

    Is next paginated result present true or false

  • descendingOrderboolean

    true if paginated data order is descending

  • previousPageNointeger

    Previous paginated result page no

Loading Examples...