Read a single basic role.
id
globally unique identifier
Required
Guid ID of the basic role to be read. |
individualid string |
None.
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>23115f07-3d97-4010-a02e-d565f806415d</ID> <IndividualID>7570268e-3453-46cb-ba71-5922801c6cd7</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2025-08-28T03:49:07.4154644+00:00</Created> <CreatedBy>ccb22020-5f41-4d22-93ae-15ec37c7261c</CreatedBy> <Updated>2025-08-28T03:49:07.4154644+00:00</Updated> <UpdatedBy>ff8562c8-25b2-4942-975d-8e87132466c0</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "23115f07-3d97-4010-a02e-d565f806415d", "IndividualID": "7570268e-3453-46cb-ba71-5922801c6cd7", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2025-08-28T03:49:07.4154644+00:00", "CreatedBy": "ccb22020-5f41-4d22-93ae-15ec37c7261c", "Updated": "2025-08-28T03:49:07.4154644+00:00", "UpdatedBy": "ff8562c8-25b2-4942-975d-8e87132466c0", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }