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>b43626a6-3ae3-4755-9d70-31c2481cfd62</ID> <IndividualID>b8b14d45-14ad-49b9-9c49-063ac44bb607</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "b43626a6-3ae3-4755-9d70-31c2481cfd62", "IndividualID": "b8b14d45-14ad-49b9-9c49-063ac44bb607", "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>0851d101-ad24-49ca-a4b8-fdbd69d05742</ID> <IndividualID>d040405c-4d57-4324-a05c-507c1c1b7978</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-06-20T05:53:14.9120815+00:00</Created> <CreatedBy>50b6cbfb-0e0c-4c1a-bec7-4d49e9156c58</CreatedBy> <Updated>2025-06-20T05:53:14.9120815+00:00</Updated> <UpdatedBy>c37fd413-4c39-43a1-a2bc-8651094f9e8e</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "0851d101-ad24-49ca-a4b8-fdbd69d05742", "IndividualID": "d040405c-4d57-4324-a05c-507c1c1b7978", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-06-20T05:53:14.9120815+00:00", "CreatedBy": "50b6cbfb-0e0c-4c1a-bec7-4d49e9156c58", "Updated": "2025-06-20T05:53:14.9120815+00:00", "UpdatedBy": "c37fd413-4c39-43a1-a2bc-8651094f9e8e", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }