View Report Filters

Details

API Details
NameView Report Filters
Description
MethodGET
URI
  • v1/reportFilters
  • v1/reportFilters/filterId
  • v1/reportFilters?reportType=reportType
CloudCenter ReleaseIntroduced in CloudCenter 4.6
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • You can only access filters that you saved. You cannot access a filter that was saved by another user.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • If you include an filterId to identify a particular filter, the response includes information for only that filter.
ESB Header
  • action: get.reportFilters
  • action: get.reportFilters.filterId
  • action: get.reportFilters
    actionparam: reportType=reportType

Example 1 – All Report Filters

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/reportFilters"

Response

{
    "reportsFilters": [{
        "id": "30",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/30?reportType=VM_INVENTORY_REPORT",
        "name": "ded",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"US West (Oregon)\"}"
    }, {
        "id": "36",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/36?reportType=VM_INVENTORY_REPORT",
        "name": "DocSample1",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"all,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]\"}"
    }, {
        "id": "28",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/28?reportType=VM_INVENTORY_REPORT",
        "name": "fed",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"CloudCenter regionOne\"}"
    }, {
        "id": "29",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/29?reportType=VM_INVENTORY_REPORT",
        "name": "fred",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"US West (Oregon)\"}"
    }, {
        "id": "23",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/23?reportType=VM_INVENTORY_REPORT",
        "name": "manage_filter",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"US East (Virginia)\"}"
    }, {
        "id": "25",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/25?reportType=VM_INVENTORY_REPORT",
        "name": "mnged_fr1",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"appName\":\"AppServerIP\"}"
    }, {
        "id": "35",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/35?reportType=VM_INVENTORY_REPORT",
        "name": "NewSavedFilter",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"US West (Oregon)\",\"status\":\"NodeCleaned,NodeError,NodeReady\"}"
    }, {
        "id": "27",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/27?reportType=VM_INVENTORY_REPORT",
        "name": "sed",
        "userId": "2",
        "reportType": "VM_INVENTORY_REPORT",
        "filters": "{\"cloudName\":\"US East (Virginia)\"}"
    }]
}

Example 2 – Report Filter by Filter ID

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/reportFilters/23"

Response

{
    "id": "23",
    "resource": "https://<HOST>:<PORT>/v1/reportFilters/23",
    "name": "manage_filter",
    "userId": "2",
    "reportType": "VM_INVENTORY_REPORT",
    "filters": "{\"cloudName\":\"US East (Virginia)\"}"
}

Example 3 – Report Filters by Report Type

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/reportFilters?reportType=USAGE_SUMMARY_REPORT"

Response

    "reportsFilters": [{
        "id": "32",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/32?reportType=USAGE_SUMMARY_REPORT",
        "name": "all_app_profiles",
        "userId": "2",
        "reportType": "USAGE_SUMMARY_REPORT",
        "filters": "{\"\":\"all\",\"appId\":\"6161,3963,4528\"}"
    }, {
        "id": "26",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/26?reportType=USAGE_SUMMARY_REPORT",
        "name": "pet_clinic",
        "userId": "2",
        "reportType": "USAGE_SUMMARY_REPORT",
        "filters": "{\"appName\":\"3 tier 4 VM Pet Clinic\"}"
    }, {
        "id": "24",
        "resource": "https://<HOST>:<PORT>/v1/reportFilters/24?reportType=USAGE_SUMMARY_REPORT",
        "name": "xxx_usr",
        "userId": "2",
        "reportType": "USAGE_SUMMARY_REPORT",
        "filters": "{\"appName\":\"Digium_Asterisk\"}"
    }]
}

Request Attributes

filterId
  • Description: Unique, system-generated identifier for a custom filter
  • Type: String

reportType

Optional query parameter used to retrieve a list of filters for a particular type of report

Response Attributes

 

reportFilters
  • Description: Identifies the report filter details.
  • Type: Array of report filters

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    userId
    • Description: Unique, system-generated identifier for a user
    • Type: String

    reportType

    filters

     Click here to expand...

    filters
    • Description: Identifies the applicable filters for the selected report.

    • Type: Sequence of mapped attributes

      ReportApplicable Filters
      USAGE_SUMMARY_REPORT
      filters
      • Description: Identifies the filters for the usage summary report for your tenant (default) or sub-tenant. Each filter contains the following details:
        • displayName: The descriptive name configured for a CloudCenter resource.
        • field: The attribute corresponding to this CloudCenter resource.
        • value: The value for this CloudCenter resource.
      • Type: Sequence of filters based on the field-value

        FieldValue
        userNames
        The JSON string for the configured value for username
        userGroupsThe JSON string for the configured value for userGroup
        appNames The JSON string for the configured value for appName
        deploymentEnvironmentsThe JSON string for the configured value for depEnvName
        cloudNamesThe JSON string for the configured value for cloudName
        tagsThe JSON string for the configured value for tags
        ccIdsThe JSON string for the configured value for ccId
        projectNamesThe JSON string for the configured value for projectName
      VM_INVENTORY_REPORT
      filters
      • Description: Identifies the filters for the manage VM Inventory Report for your tenant hierarchy. Each filter contains the following details:
        • displayName: The descriptive name configured for a CloudCenter resource.
        • field: The attribute corresponding to this CloudCenter resource.
        • value: The value for this CloudCenter resource.

        Type: Sequence of filters based on the field-value

        FieldValue
        tenantIdThe JSON string for the configured value for tenantId
        totalCloudCostThe JSON string for the configured value for totalCloudCost
         totalNodeHours The JSON string for the configured value for  totalNodeHours
        totalNumberOfRunningVMs 
        The JSON string for the configured value for totalNumberOfRunningVMs
        totalNumberOfVMs
        The JSON string for the configured value for totalNumberOfVMs

      SPEND_SUMMARY_REPORT
      filters
      • Description: Identifies the filters for the manage Spend Summary Report for your tenant hierarchy. Each filter contains the following details:
        • displayName: The descriptive name configured for a CloudCenter resource.
        • field: The attribute corresponding to this CloudCenter resource.
        • value: The value for this CloudCenter resource.
      • Type: Sequence of filters based on the field-value

        FieldValue
        numberOfTenantsThe JSON string for the configured value for numberOfTenants
        numberOfClouds  The JSON string for the configured value for numberOfClouds
        totalCloudCost The JSON string for the configured value for  totalCloudCost 
        totalNodeHours The JSON string for the configured value for totalNodeHours
        totalNumberOfRunningVMs The JSON string for the configured value for totalNumberOfRunningVMs