Update an individual's basic role.
id
globally unique identifier
Required
Guid ID of the basic role to be updated. |
This object takes all the parameters needed to update a 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>ac94d7af-f80f-474e-b3f3-5b9af14c1280</ID> <IndividualID>f3c3cd80-1b11-4ff6-8c27-ca73f9a81b8f</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> </BasicRole>
{ "ID": "ac94d7af-f80f-474e-b3f3-5b9af14c1280", "IndividualID": "f3c3cd80-1b11-4ff6-8c27-ca73f9a81b8f", "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>2142b612-e78b-4544-a6e2-82d1dff472f5</ID> <IndividualID>fee5975a-4538-4521-8b81-1511b4b642f1</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2024-05-08T05:03:16.2295987+00:00</Created> <CreatedBy>2ee47da1-d3d6-4784-9e1f-8c7b316c9fc3</CreatedBy> <Updated>2024-05-08T05:03:16.2295987+00:00</Updated> <UpdatedBy>2fa7d7ab-4819-4540-910c-b61ec48faf76</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "2142b612-e78b-4544-a6e2-82d1dff472f5", "IndividualID": "fee5975a-4538-4521-8b81-1511b4b642f1", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2024-05-08T05:03:16.2295987+00:00", "CreatedBy": "2ee47da1-d3d6-4784-9e1f-8c7b316c9fc3", "Updated": "2024-05-08T05:03:16.2295987+00:00", "UpdatedBy": "2fa7d7ab-4819-4540-910c-b61ec48faf76", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }