Back

GET metrics/{id}/security/{childtype}

Read permissions for and object based an id and childType.

Request Information

URI Parameters

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

Guid ID for individuals, metrics, organizations, projects, site, tasks.
childtype integer

Null = Top level security, ChildTypes are metric(16), project(15). All other numbers will be treated as null.

Body Parameters

None.

Response Information

Resource Description (Permission)

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

ID of the permission.
RowID globally unique identifier Required on Create

ID of the object to be secured.
PrincipalID globally unique identifier Required on Create

User ID or Security Group ID for the permission.
ChildType integer Required on Create

Type of the child permissions. Possible childtypes are: Null = Top level security, department(19), dialog(9, 25, 38), metric(7, 16, 58), organization(4), project(15). All other numbers will be treated as null.
CreateState integer Required

Create security setting for the given object.
ReadState integer Required

Read security settings for the given object.
UpdateState integer Required

Update security settings for the given object.
DeleteState integer Required

Delete security settings for the given object.
DelegateState integer Required

Delegate security settings for the given object.
SiteID globally unique identifier ReadOnly

ID of the given site.
RowType integer ReadOnly

Row type of the given object.
PrincipalName string ReadOnly

Name of the individual/security group for which to change/read security.
PrincipalType integer ReadOnly

Type of the individual/security group for which to change/read security.
RowName string ReadOnly

Name of the object for which to change/read security.
CreateText string ReadOnly

Text value for CreateState; Not Set, Allow, Deny
ReadText string ReadOnly

Text value for ReadState; Not Set, Allow, Deny
UpdateText string ReadOnly

Text value for UpdateState; Not Set, Allow, Deny
DeleteText string ReadOnly

Text value for DeleteState; Not Set, Allow, Deny
DelegateText string ReadOnly

Text value for DelegateState; Not Set, Allow, Deny

Response Formats

application/xml, text/xml

Sample
<Permission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>2628cc8c-131b-4310-9333-c6a9ac534e7b</ID>
  <RowID>88ac7a4f-0c80-442c-bbd6-1deac1243ab3</RowID>
  <PrincipalID>a7fe2a0f-55aa-47de-8b7c-2e2bf03ef301</PrincipalID>
  <ChildType>1</ChildType>
  <CreateState>1</CreateState>
  <ReadState>1</ReadState>
  <UpdateState>1</UpdateState>
  <DeleteState>1</DeleteState>
  <DelegateState>1</DelegateState>
  <SiteID>84bc4e75-a004-4801-ba8c-e0a0430aa04a</SiteID>
  <RowType>1</RowType>
  <PrincipalName>sample string 1</PrincipalName>
  <PrincipalType>1</PrincipalType>
  <RowName>sample string 2</RowName>
  <CreateText>sample string 3</CreateText>
  <ReadText>sample string 4</ReadText>
  <UpdateText>sample string 5</UpdateText>
  <DeleteText>sample string 6</DeleteText>
  <DelegateText>sample string 7</DelegateText>
</Permission>

application/json, text/json

Sample
{
  "ID": "2628cc8c-131b-4310-9333-c6a9ac534e7b",
  "RowID": "88ac7a4f-0c80-442c-bbd6-1deac1243ab3",
  "PrincipalID": "a7fe2a0f-55aa-47de-8b7c-2e2bf03ef301",
  "ChildType": 1,
  "CreateState": 1,
  "ReadState": 1,
  "UpdateState": 1,
  "DeleteState": 1,
  "DelegateState": 1,
  "SiteID": "84bc4e75-a004-4801-ba8c-e0a0430aa04a",
  "RowType": 1,
  "PrincipalName": "sample string 1",
  "PrincipalType": 1,
  "RowName": "sample string 2",
  "CreateText": "sample string 3",
  "ReadText": "sample string 4",
  "UpdateText": "sample string 5",
  "DeleteText": "sample string 6",
  "DelegateText": "sample string 7"
}