Create an individual's basic role.
None.
This object takes all the parameters needed to create a new basic role.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID
globally unique identifier
Required on Update
ID of the given basic role. |
IndividualID
globally unique identifier
ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.) |
Name
string
Required
Name of the given basic role. (Max length 255 characters) |
Rank
integer
Rank of the given basic role. |
Description
string
Description of the given basic role. |
PercentTime
byte
Percent of time that should be devoted to the given basic role. |
Created
date
ReadOnly
Date the given basic role was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given basic role. |
Updated
date
ReadOnly
Date the given basic role was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that last updated the given basic role. |
PerformanceIndicators
string
ReadOnly
Performance indicators that are linked to the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given basic role. |
DeletedByRef
boolean
ReadOnly
Deleted by Reference status of the given basic role. |
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>f27821e8-99a6-4d47-a2c0-6fd8017f8e38</ID> <IndividualID>f2c313ec-f5df-4720-81ad-e616c7cb3497</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "f27821e8-99a6-4d47-a2c0-6fd8017f8e38", "IndividualID": "f2c313ec-f5df-4720-81ad-e616c7cb3497", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64 }
ID
globally unique identifier
Required on Update
ID of the given basic role. |
IndividualID
globally unique identifier
ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.) |
Name
string
Required
Name of the given basic role. (Max length 255 characters) |
Rank
integer
Rank of the given basic role. |
Description
string
Description of the given basic role. |
PercentTime
byte
Percent of time that should be devoted to the given basic role. |
Created
date
ReadOnly
Date the given basic role was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given basic role. |
Updated
date
ReadOnly
Date the given basic role was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that last updated the given basic role. |
PerformanceIndicators
string
ReadOnly
Performance indicators that are linked to the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given basic role. |
DeletedByRef
boolean
ReadOnly
Deleted by Reference status of the given basic role. |
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>219d4a93-0e75-48c9-8481-319a715ae033</ID> <IndividualID>cd386865-bd46-4ffd-8834-5b2eaae94702</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-10-01T11:29:54.289087+00:00</Created> <CreatedBy>cc580059-2db5-4751-a267-bf4b55ca8ce0</CreatedBy> <Updated>2025-10-01T11:29:54.289087+00:00</Updated> <UpdatedBy>3b17773f-6207-4a1f-bbe0-1ea3d08dc0a0</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "219d4a93-0e75-48c9-8481-319a715ae033", "IndividualID": "cd386865-bd46-4ffd-8834-5b2eaae94702", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-10-01T11:29:54.289087+00:00", "CreatedBy": "cc580059-2db5-4751-a267-bf4b55ca8ce0", "Updated": "2025-10-01T11:29:54.289087+00:00", "UpdatedBy": "3b17773f-6207-4a1f-bbe0-1ea3d08dc0a0", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }