POST security

Request Information

URI Parameters

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

None.

Body Parameters (Permission)

This object takes all the parameters needed to create a new permission.

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

Request Formats

application/xml, text/xml

Sample

<Permission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>d9621b31-9273-4a33-8258-abfb86cee388</ID>
  <RowID>5cb23741-eec5-4c69-afb8-e4be92047c52</RowID>
  <PrincipalID>30172007-716a-4db6-baec-3e8b7aa6fba4</PrincipalID>
  <ChildType>1</ChildType>
  <CreateState>1</CreateState>
  <ReadState>1</ReadState>
  <UpdateState>1</UpdateState>
  <DeleteState>1</DeleteState>
  <DelegateState>1</DelegateState>
</Permission>

application/json, text/json

Sample

{
  "ID": "d9621b31-9273-4a33-8258-abfb86cee388",
  "RowID": "5cb23741-eec5-4c69-afb8-e4be92047c52",
  "PrincipalID": "30172007-716a-4db6-baec-3e8b7aa6fba4",
  "ChildType": 1,
  "CreateState": 1,
  "ReadState": 1,
  "UpdateState": 1,
  "DeleteState": 1,
  "DelegateState": 1
}

Response Information

Resource Description (Permission)

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

Response Formats

application/xml, text/xml

Sample

<Permission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>aa474fdc-66e3-4146-ae6c-b036cd3b0b2d</ID>
  <RowID>33a9bdbb-8aa9-4c9e-9428-b27c27be8724</RowID>
  <PrincipalID>355e2f81-b1ae-4dcf-88c4-6206c3c9f789</PrincipalID>
  <ChildType>1</ChildType>
  <CreateState>1</CreateState>
  <ReadState>1</ReadState>
  <UpdateState>1</UpdateState>
  <DeleteState>1</DeleteState>
  <DelegateState>1</DelegateState>
  <SiteID>00486720-432b-40b0-9719-eb4437110fbb</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": "aa474fdc-66e3-4146-ae6c-b036cd3b0b2d",
  "RowID": "33a9bdbb-8aa9-4c9e-9428-b27c27be8724",
  "PrincipalID": "355e2f81-b1ae-4dcf-88c4-6206c3c9f789",
  "ChildType": 1,
  "CreateState": 1,
  "ReadState": 1,
  "UpdateState": 1,
  "DeleteState": 1,
  "DelegateState": 1,
  "SiteID": "00486720-432b-40b0-9719-eb4437110fbb",
  "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"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the permission.	`globally unique identifier` Required on Update ID of the permission.
RowID `globally unique identifier` Required on Create ID of the object to be secured.	`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.	`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.	`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.	`integer` Required Create security setting for the given object.
ReadState `integer` Required Read security settings for the given object.	`integer` Required Read security settings for the given object.
UpdateState `integer` Required Update security settings for the given object.	`integer` Required Update security settings for the given object.
DeleteState `integer` Required Delete security settings for the given object.	`integer` Required Delete security settings for the given object.
DelegateState `integer` Required Delegate security settings for the given object.	`integer` Required Delegate security settings for the given object.
SiteID `globally unique identifier` ReadOnly ID of the given site.	`globally unique identifier` ReadOnly ID of the given site.
RowType `integer` ReadOnly Row type of the given object.	`integer` ReadOnly Row type of the given object.
PrincipalName `string` ReadOnly Name of the individual/security group for which to change/read security.	`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.	`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.	`string` ReadOnly Name of the object for which to change/read security.
CreateText `string` ReadOnly Text value for CreateState; Not Set, Allow, Deny	`string` ReadOnly Text value for CreateState; Not Set, Allow, Deny
ReadText `string` ReadOnly Text value for ReadState; Not Set, Allow, Deny	`string` ReadOnly Text value for ReadState; Not Set, Allow, Deny
UpdateText `string` ReadOnly Text value for UpdateState; Not Set, Allow, Deny	`string` ReadOnly Text value for UpdateState; Not Set, Allow, Deny
DeleteText `string` ReadOnly Text value for DeleteState; Not Set, Allow, Deny	`string` ReadOnly Text value for DeleteState; Not Set, Allow, Deny
DelegateText `string` ReadOnly Text value for DelegateState; Not Set, Allow, Deny	`string` ReadOnly Text value for DelegateState; Not Set, Allow, Deny