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>417374eb-2042-494d-b6ea-14b4a1580c7e</ID> <BasicRoleID>6b89d2fe-b900-488e-95ef-72c8193f1e45</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> </Indicator>
{ "ID": "417374eb-2042-494d-b6ea-14b4a1580c7e", "BasicRoleID": "6b89d2fe-b900-488e-95ef-72c8193f1e45", "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>f91711fc-18e7-4324-8a9d-e0b278816e6b</ID> <BasicRoleID>dad5ea41-8c44-425d-b6d1-337e7c7f15c9</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>7d28f1fc-f08a-47af-9dbe-693b878955fd</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-06-15T05:49:09.0623339+00:00</Updated> <UpdatedBy>4c2a9c20-9b85-48fe-b215-775fe648637b</UpdatedBy> <Created>2025-06-15T05:49:09.0623339+00:00</Created> <CreatedBy>fac96381-29fb-46ef-919c-81f1d882625c</CreatedBy> </Indicator>
{ "ID": "f91711fc-18e7-4324-8a9d-e0b278816e6b", "BasicRoleID": "dad5ea41-8c44-425d-b6d1-337e7c7f15c9", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "7d28f1fc-f08a-47af-9dbe-693b878955fd", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-06-15T05:49:09.0623339+00:00", "UpdatedBy": "4c2a9c20-9b85-48fe-b215-775fe648637b", "Created": "2025-06-15T05:49:09.0623339+00:00", "CreatedBy": "fac96381-29fb-46ef-919c-81f1d882625c" }