Create a performance indicator.
None.
This object takes all the parameters needed to create a new 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>a9aac14c-0005-46f3-8800-40bf760acf9a</ID> <BasicRoleID>27d700ce-e1d4-41a3-a69d-54610ea0e3d0</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> </Indicator>
{ "ID": "a9aac14c-0005-46f3-8800-40bf760acf9a", "BasicRoleID": "27d700ce-e1d4-41a3-a69d-54610ea0e3d0", "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>b629a592-5012-410e-856c-66c36f81dc05</ID> <BasicRoleID>c2692d1f-54b6-4114-ab1a-efb8ac30a059</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>94eb5a71-6632-45b9-9298-8e3b391dc8dd</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-08-26T16:03:17.5224392+00:00</Updated> <UpdatedBy>8a8c43c0-55c9-4498-896a-6c699de21dac</UpdatedBy> <Created>2025-08-26T16:03:17.5224392+00:00</Created> <CreatedBy>c24830bc-d489-4538-8f26-8af6236a9a28</CreatedBy> </Indicator>
{ "ID": "b629a592-5012-410e-856c-66c36f81dc05", "BasicRoleID": "c2692d1f-54b6-4114-ab1a-efb8ac30a059", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "94eb5a71-6632-45b9-9298-8e3b391dc8dd", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-08-26T16:03:17.5224392+00:00", "UpdatedBy": "8a8c43c0-55c9-4498-896a-6c699de21dac", "Created": "2025-08-26T16:03:17.5224392+00:00", "CreatedBy": "c24830bc-d489-4538-8f26-8af6236a9a28" }