Create Report Filter

Details

API Details
NameCreate Report Filter
Description

Saves the currently set filter combination for quick usage when you use this API the next time around for the reports identified in the Request Body section of this API.

MethodPOST
URI

v1/reportFilters

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.
ESB Header

action: create.reportFilters

Example

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

Request Body

{
    "name": "DocSample1",
    "userId": "2",
    "reportType": "VM_INVENTORY_REPORT",
    "filters": "{\"cloudName\":\"all,[object Object], [object Object], 
        [object Object], [object Object], [object Object], [object Object]\"}"
}

Response

{
    "id": "36",
    "resource": "https://<HOST>:<PORT>/v1/reportFilters/36",
    "name": "DocSample1",
    "userId": "2",
    "reportType": "VM_INVENTORY_REPORT",
    "filters": "{\"cloudName\":\"all,[object Object],[object Object],
        [object Object], [object Object], [object Object], [object Object]\"}"
}

Request Attributes

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

  • Type: String

Required

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

Required

reportType

Required

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

Required

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