Back

GET sites/{id}/pmsettings

Read all of the site settings for the PM Dashboard. PMAdmin

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier

Body Parameters

None.

Response Information

Resource Description (SiteSetting)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given site.
Threshold1 integer Required

Minimum threshold for metrics.
Threshold2 integer Required

Meets threshold for metrics.
Threshold3 integer Required

Exceeds threshold for metrics.
ShowMetrics boolean Required

Setting to show metric data for the given site.
ShowDialogs boolean Required

Setting to show dialog data for the given site.
ShowFollowUps boolean Required

Setting to show follow up data for the given site.
ShowProjectLoad boolean Required

Setting to show project load data for the given site.
ShowEvaluationCriteria boolean Required

Setting to show evaluation criteria data for the given site.
ShowLeaderAssessment boolean Required

Setting to show leader assessment data for the given site.
ShowTeamAssessment boolean Required

Setting to show team assessment data for the given site.
ShowGoals boolean Required

Setting to show goals data for the given site.
ShowOrgCommitments boolean Required

Setting to show organization commitments data for the given site.
ShowDeptCommitments boolean Required

Setting to show department commitments data for the given site.
ShowIndCommitments boolean Required

Setting to show individual commitments data for the given site.
Show8020Metrics boolean Required

Setting to show 8020 metric data for the given site.

Response Formats

application/xml, text/xml

Sample
<SiteSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>a4766eac-cf19-464c-8a9d-557d1bcdb72b</ID>
  <Threshold1>1</Threshold1>
  <Threshold2>1</Threshold2>
  <Threshold3>1</Threshold3>
  <ShowMetrics>true</ShowMetrics>
  <ShowDialogs>true</ShowDialogs>
  <ShowFollowUps>true</ShowFollowUps>
  <ShowProjectLoad>true</ShowProjectLoad>
  <ShowEvaluationCriteria>true</ShowEvaluationCriteria>
  <ShowLeaderAssessment>true</ShowLeaderAssessment>
  <ShowTeamAssessment>true</ShowTeamAssessment>
  <ShowGoals>true</ShowGoals>
  <ShowOrgCommitments>true</ShowOrgCommitments>
  <ShowDeptCommitments>true</ShowDeptCommitments>
  <ShowIndCommitments>true</ShowIndCommitments>
  <Show8020Metrics>true</Show8020Metrics>
</SiteSetting>

application/json, text/json

Sample
{
  "ID": "a4766eac-cf19-464c-8a9d-557d1bcdb72b",
  "Threshold1": 1,
  "Threshold2": 1,
  "Threshold3": 1,
  "ShowMetrics": true,
  "ShowDialogs": true,
  "ShowFollowUps": true,
  "ShowProjectLoad": true,
  "ShowEvaluationCriteria": true,
  "ShowLeaderAssessment": true,
  "ShowTeamAssessment": true,
  "ShowGoals": true,
  "ShowOrgCommitments": true,
  "ShowDeptCommitments": true,
  "ShowIndCommitments": true,
  "Show8020Metrics": true
}