Resource URL: /platform/<<version=4>>/performance/settings

    Overview: This resource encapsulates the global settings for performance
              resource accounting.

     Methods: GET, PUT

********************************************************************************

Method GET: List all performance settings.

       URL: GET /platform/<<version=4>>/performance/settings

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "View and modify the configuration driving performance statistic collection.", 
          "properties": {
            "max_workload_count": {
              "type": "integer", 
              "description": "The maximum number of workloads that can be configured per workload category."
            }, 
            "max_workload_category_count": {
              "type": "integer", 
              "description": "The maximum number of workload categories that can be configured."
            }, 
            "max_top_n_collection_count": {
              "type": "integer", 
              "description": "The maximum valid value for the top_n_collection setting (the number of top consuming workloads to collect statistics on)."
            }, 
            "top_n_collection_count": {
              "minimum": 0, 
              "type": "integer", 
              "description": "The number of top consuming workloads to collect statistics on.  Only this number of workloads will be tracked before they are placed into an 'other' bucket.  This does not include the 'pinned' workloads specified at /4/performance/workload-category/<WORKLOAD-CATEGORY>/workloads, which will always be collected in any case.", 
              "maximum": 10000
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Configure performance settings.

       URL: PUT /platform/<<version=4>>/performance/settings

There are no query arguments for this method.

Required PUT request body fields:
top_n_collection_count

PUT request body schema:
{
  "type": "object", 
  "description": "View and modify the configuration driving performance statistic collection.", 
  "properties": {
    "top_n_collection_count": {
      "required": true, 
      "minimum": 0, 
      "type": "integer", 
      "description": "The number of top consuming workloads to collect statistics on.  Only this number of workloads will be tracked before they are placed into an 'other' bucket.  This does not include the 'pinned' workloads specified at /4/performance/workload-category/<WORKLOAD-CATEGORY>/workloads, which will always be collected in any case.", 
      "maximum": 10000
    }
  }
}

There is no JSON response body for this method.
