Update a performance indicator.
id
globally unique identifier
Required
Guid ID of the performance indicator to be updated. |
This object takes all the parameters needed to update a performance indicator.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID
globally unique identifier
Required on Update
ID of the given performance indicator. |
BasicRoleID
globally unique identifier
ID of the given basic role. |
Rank
integer
Rank of the given performance indicator. |
Name
string
Required
Name of the given performance indicator. (Max length 200 characters) |
Description
string
Description of the given performance indicator. |
SiteID
globally unique identifier
ReadOnly
ID of the site for the given performance indicator. |
BasicRoleName
string
ReadOnly
Name of the basic role for the given performance indicator. |
BasicRolePercentTime
byte
ReadOnly
Percent of time that should be devoted to the given basic role. |
BasicRoleRank
integer
ReadOnly
Rank of the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given performance indicator. |
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given performance indicator. |
Updated
date
ReadOnly
Date when the given performance indicator was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that updated the given performance indicator. |
Created
date
ReadOnly
Date when the given performance indicator was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given performance indicator. |
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>4cff0c5b-7e78-4f08-a09b-c4693da885fd</ID> <BasicRoleID>1153e51a-3c64-4de9-bfcd-914644cee715</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> </Indicator>
{ "ID": "4cff0c5b-7e78-4f08-a09b-c4693da885fd", "BasicRoleID": "1153e51a-3c64-4de9-bfcd-914644cee715", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2" }
ID
globally unique identifier
Required on Update
ID of the given performance indicator. |
BasicRoleID
globally unique identifier
ID of the given basic role. |
Rank
integer
Rank of the given performance indicator. |
Name
string
Required
Name of the given performance indicator. (Max length 200 characters) |
Description
string
Description of the given performance indicator. |
SiteID
globally unique identifier
ReadOnly
ID of the site for the given performance indicator. |
BasicRoleName
string
ReadOnly
Name of the basic role for the given performance indicator. |
BasicRolePercentTime
byte
ReadOnly
Percent of time that should be devoted to the given basic role. |
BasicRoleRank
integer
ReadOnly
Rank of the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given performance indicator. |
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given performance indicator. |
Updated
date
ReadOnly
Date when the given performance indicator was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the individual that updated the given performance indicator. |
Created
date
ReadOnly
Date when the given performance indicator was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the individual that created the given performance indicator. |
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>a1191b50-76bd-4cb9-9736-3ee9003b482d</ID> <BasicRoleID>5cdc9061-f5a4-42de-9a65-a221bdbb5771</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>2bbb02b9-2e78-48cc-b89d-e027ef2f23d3</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-10-01T11:30:01.4965575+00:00</Updated> <UpdatedBy>1fe8d37c-1f19-4b7e-a3d1-2c31c8890baa</UpdatedBy> <Created>2025-10-01T11:30:01.4965575+00:00</Created> <CreatedBy>4758c588-5fe2-4042-8156-09aa890cfe78</CreatedBy> </Indicator>
{ "ID": "a1191b50-76bd-4cb9-9736-3ee9003b482d", "BasicRoleID": "5cdc9061-f5a4-42de-9a65-a221bdbb5771", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "2bbb02b9-2e78-48cc-b89d-e027ef2f23d3", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-10-01T11:30:01.4965575+00:00", "UpdatedBy": "1fe8d37c-1f19-4b7e-a3d1-2c31c8890baa", "Created": "2025-10-01T11:30:01.4965575+00:00", "CreatedBy": "4758c588-5fe2-4042-8156-09aa890cfe78" }