Request Information

URI Parameters

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

Guid ID for the site to be read.

Body Parameters

None.

Response Information

Resource Description (Site)

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

ID of the site.

Name string Required

Name of the site. (Max length 200 characters)

Comment string Required

Comment on the site.

Category string Required

Category of the site. Used to organize the sites. (Max length 50 characters)

FeatureCopyLink boolean

Indicates if the given site has access to the Copy Link Feature.

FeatureRollup boolean

Indicates if the given site has access to the Rollup Feature.

FeatureApi boolean

Indicates if the given site has access to the API.

FeatureProject boolean

Indicates if the given site has access to the Project Feature.

FeatureUpload boolean

Indicates if the given site has access to the Upload.

Logo Collection of byte

Logo of the site.

ReportLogo Collection of byte

Report a logo to administrators.

FeatureOutlook boolean

Indicates if the given site has access to the Outlook Feature.

FeaturePerformance boolean

Indicates if the given site has access to the Performance Management feature.

FeatureFacebookLogin boolean

Indicates if members of the given site are able to login using their Facebook user name and password.

FeatureTwitterLogin boolean

Indicates if members of the given site are able to login using their Twitter user name and password.

SecretKeyPartial string ReadOnly

Partial secret key of the site.

Nickname string ReadOnly

Nickname of the site.

AuthServiceUrl string ReadOnly

URL for your custom authentication.

SsoLoginLabel string ReadOnly

Label for your single sign on button.

RowType integer ReadOnly

Row Type of the site(1).

Deleted boolean ReadOnly

Deleted status of the site.

BelowThresholdColor string ReadOnly

Hex value of the color for items that are below the threshold.

Created date ReadOnly

Date the site was created.

CreatedBy globally unique identifier ReadOnly

ID of the person that created the site.

Updated date ReadOnly

Date the site was last updated.

UpdatedBy globally unique identifier ReadOnly

ID of the person that last updated the site.

Show8020Metrics boolean

Current display setting for department 8020 metrics in the PM Dashboard.

ShowDeptCommitments boolean

Current display setting for department commitments in the PM Dashboard.

ShowDialogs boolean

Current display setting for dialogs in the PM Dashboard.

ShowEvaluationCriteria boolean

Current display setting for evaluation criteria in the PM Dashboard.

ShowFollowUps boolean

Current display setting for follow ups in the PM Dashboard.

ShowGoals boolean

Current display setting for goals in the PM Dashboard.

ShowIndCommitments boolean

Current display setting for individual commitments in the PM Dashboard.

ShowLeaderAssessment boolean

Current display setting for leader assessments in the PM Dashboard.

ShowMetrics boolean

Current display setting for metrics in the PM Dashboard.

ShowOrgCommitments boolean

Current display setting for organization commitments in the PM Dashboard.

ShowProjectLoad boolean

Current display setting for project loads in the PM Dashboard.

ShowTeamAssessment boolean

Current display setting for team assessments in the PM Dashboard.

Threshold1 integer

Current value for the minimum threshold for metrics in the PM dashboard.

Threshold2 integer

Current value for the meets threshold for metrics in the PM dashboard.

Threshold3 integer

Current value for the exceeds threshold for metrics in the PM dashboard.

RemoveLogo boolean

RemoveReportLogo boolean

PrimaryContactUserID globally unique identifier

StripeCustomerID string

StripeSubscriptionID string

StripeSubscriptionPlan string

Employees string

Number of employees in your company.

WebsiteURL string

Response Formats

application/xml, text/xml

Sample
<Site xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>24e581e1-061a-4650-a5a1-4a80b18d5695</ID>
  <Name>sample string 1</Name>
  <Comment>sample string 2</Comment>
  <Category>sample string 3</Category>
  <FeatureCopyLink>true</FeatureCopyLink>
  <FeatureRollup>true</FeatureRollup>
  <FeatureApi>true</FeatureApi>
  <FeatureProject>true</FeatureProject>
  <FeatureUpload>true</FeatureUpload>
  <Logo>QEA=</Logo>
  <ReportLogo>QEA=</ReportLogo>
  <FeatureOutlook>true</FeatureOutlook>
  <FeaturePerformance>true</FeaturePerformance>
  <FeatureFacebookLogin>true</FeatureFacebookLogin>
  <FeatureTwitterLogin>true</FeatureTwitterLogin>
  <SecretKeyPartial>sample string 4</SecretKeyPartial>
  <Nickname>sample string 5</Nickname>
  <AuthServiceUrl>sample string 6</AuthServiceUrl>
  <SsoLoginLabel>sample string 7</SsoLoginLabel>
  <RowType>1</RowType>
  <Deleted>true</Deleted>
  <BelowThresholdColor>sample string 8</BelowThresholdColor>
  <Created>2021-11-03T19:06:10.081414+00:00</Created>
  <CreatedBy>2faed092-fcbf-464c-b2af-035e394be68c</CreatedBy>
  <Updated>2021-11-03T19:06:10.081414+00:00</Updated>
  <UpdatedBy>c1184cd1-71a2-472e-ad8e-a2d892c5cab7</UpdatedBy>
  <Show8020Metrics>true</Show8020Metrics>
  <ShowDeptCommitments>true</ShowDeptCommitments>
  <ShowDialogs>true</ShowDialogs>
  <ShowEvaluationCriteria>true</ShowEvaluationCriteria>
  <ShowFollowUps>true</ShowFollowUps>
  <ShowGoals>true</ShowGoals>
  <ShowIndCommitments>true</ShowIndCommitments>
  <ShowLeaderAssessment>true</ShowLeaderAssessment>
  <ShowMetrics>true</ShowMetrics>
  <ShowOrgCommitments>true</ShowOrgCommitments>
  <ShowProjectLoad>true</ShowProjectLoad>
  <ShowTeamAssessment>true</ShowTeamAssessment>
  <Threshold1>1</Threshold1>
  <Threshold2>1</Threshold2>
  <Threshold3>1</Threshold3>
  <RemoveLogo>true</RemoveLogo>
  <RemoveReportLogo>true</RemoveReportLogo>
  <PrimaryContactUserID>f8fffdbd-af9c-4158-b10d-0d5fd41a34d6</PrimaryContactUserID>
  <StripeCustomerID>sample string 9</StripeCustomerID>
  <StripeSubscriptionID>sample string 10</StripeSubscriptionID>
  <StripeSubscriptionPlan>sample string 11</StripeSubscriptionPlan>
  <Employees>sample string 12</Employees>
  <WebsiteURL>sample string 13</WebsiteURL>
</Site>

application/json, text/json

Sample
{
  "ID": "24e581e1-061a-4650-a5a1-4a80b18d5695",
  "Name": "sample string 1",
  "Comment": "sample string 2",
  "Category": "sample string 3",
  "FeatureCopyLink": true,
  "FeatureRollup": true,
  "FeatureApi": true,
  "FeatureProject": true,
  "FeatureUpload": true,
  "Logo": "QEA=",
  "ReportLogo": "QEA=",
  "FeatureOutlook": true,
  "FeaturePerformance": true,
  "FeatureFacebookLogin": true,
  "FeatureTwitterLogin": true,
  "SecretKeyPartial": "sample string 4",
  "Nickname": "sample string 5",
  "AuthServiceUrl": "sample string 6",
  "SsoLoginLabel": "sample string 7",
  "RowType": 1,
  "Deleted": true,
  "BelowThresholdColor": "sample string 8",
  "Created": "2021-11-03T19:06:10.081414+00:00",
  "CreatedBy": "2faed092-fcbf-464c-b2af-035e394be68c",
  "Updated": "2021-11-03T19:06:10.081414+00:00",
  "UpdatedBy": "c1184cd1-71a2-472e-ad8e-a2d892c5cab7",
  "Show8020Metrics": true,
  "ShowDeptCommitments": true,
  "ShowDialogs": true,
  "ShowEvaluationCriteria": true,
  "ShowFollowUps": true,
  "ShowGoals": true,
  "ShowIndCommitments": true,
  "ShowLeaderAssessment": true,
  "ShowMetrics": true,
  "ShowOrgCommitments": true,
  "ShowProjectLoad": true,
  "ShowTeamAssessment": true,
  "Threshold1": 1,
  "Threshold2": 1,
  "Threshold3": 1,
  "RemoveLogo": true,
  "RemoveReportLogo": true,
  "PrimaryContactUserID": "f8fffdbd-af9c-4158-b10d-0d5fd41a34d6",
  "StripeCustomerID": "sample string 9",
  "StripeSubscriptionID": "sample string 10",
  "StripeSubscriptionPlan": "sample string 11",
  "Employees": "sample string 12",
  "WebsiteURL": "sample string 13"
}