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>482b1a26-4002-43d5-b46c-1a6fdb18f861</ID> <BasicRoleID>7c53db79-2daf-4cf7-b4e5-042de470da68</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> </Indicator>
{ "ID": "482b1a26-4002-43d5-b46c-1a6fdb18f861", "BasicRoleID": "7c53db79-2daf-4cf7-b4e5-042de470da68", "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>fe640b3b-3fed-4383-b84a-50109fc012d3</ID> <BasicRoleID>9ee89189-27a8-4707-a6b1-2db79dc94ce5</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>3ca8b2ad-1410-4e26-a775-da0a310fcffe</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2024-04-12T08:17:25.1160388+00:00</Updated> <UpdatedBy>c9e806a6-b59e-45b6-9041-e2e8218cf3f5</UpdatedBy> <Created>2024-04-12T08:17:25.1160388+00:00</Created> <CreatedBy>6de02883-2ff5-48e6-96bb-cf97687e89e8</CreatedBy> </Indicator>
{ "ID": "fe640b3b-3fed-4383-b84a-50109fc012d3", "BasicRoleID": "9ee89189-27a8-4707-a6b1-2db79dc94ce5", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "3ca8b2ad-1410-4e26-a775-da0a310fcffe", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2024-04-12T08:17:25.1160388+00:00", "UpdatedBy": "c9e806a6-b59e-45b6-9041-e2e8218cf3f5", "Created": "2024-04-12T08:17:25.1160388+00:00", "CreatedBy": "6de02883-2ff5-48e6-96bb-cf97687e89e8" }