//config GET

Overview

Retrieves the config settings for a given module.

Summary

This endpoint is normally used for the forecasting module.

Request Arguments

This endpoint does not accept any request arguments.

Response Arguments

Name	Type	Description
<config field>	<config field type>	The list of config fields will be returned.

Response

{
   "is_setup":1,
   "is_upgrade":0,
   "has_commits":1,
   "timeperiod_type":"chronological",
   "timeperiod_interval":"Annual",
   "timeperiod_leaf_interval":"Quarter",
   "timeperiod_start_date":"2013-01-01",
   "timeperiod_shown_forward":2,
   "timeperiod_shown_backward":2,
   "forecast_ranges":"show_binary",
   "buckets_dom":"commit_stage_binary_dom",
   "show_binary_ranges":{
      "include":{
         "min":70,
         "max":100
      },
      "exclude":{
         "min":0,
         "max":69
      }
   },
   "show_buckets_ranges":{
      "include":{
         "min":85,
         "max":100
      },
      "upside":{
         "min":70,
         "max":84
      },
      "exclude":{
         "min":0,
         "max":69
      }
   },
   "show_custom_buckets_ranges":{
      "include":{
         "min":85,
         "max":100
      },
      "upside":{
         "min":70,
         "max":84
      },
      "exclude":{
         "min":0,
         "max":69
      }
   },
   "sales_stage_won":[
      "Closed Won"
   ],
   "sales_stage_lost":[
      "Closed Lost"
   ],
   "show_worksheet_likely":1,
   "show_worksheet_best":1,
   "show_worksheet_worst":0,
   "show_projected_likely":1,
   "show_projected_best":1,
   "show_projected_worst":0,
   "show_forecasts_commit_warnings":1
}

Change Log

Version	Change
v10	Added `/<module>/config` GET endpoint.