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>fbd2cac3-a295-4e16-98e4-b71411b32a80</ID> <BasicRoleID>656d59df-5e58-4b8d-8e70-cfd2b971d11b</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> </Indicator>
{ "ID": "fbd2cac3-a295-4e16-98e4-b71411b32a80", "BasicRoleID": "656d59df-5e58-4b8d-8e70-cfd2b971d11b", "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>7b1125e1-fc7c-414c-88b8-e5f61738c5ee</ID> <BasicRoleID>57f9b606-d33a-4d99-a5d2-8fde5670b863</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>9fa17d8b-2614-41db-ba5f-1546141b8a46</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-07-15T19:05:32.8327389+00:00</Updated> <UpdatedBy>e2f93533-f5fa-4596-9c51-f06312d04a39</UpdatedBy> <Created>2025-07-15T19:05:32.8327389+00:00</Created> <CreatedBy>264eb35e-8368-4a81-b320-a7b92ca4eec7</CreatedBy> </Indicator>
{ "ID": "7b1125e1-fc7c-414c-88b8-e5f61738c5ee", "BasicRoleID": "57f9b606-d33a-4d99-a5d2-8fde5670b863", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "9fa17d8b-2614-41db-ba5f-1546141b8a46", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-07-15T19:05:32.8327389+00:00", "UpdatedBy": "e2f93533-f5fa-4596-9c51-f06312d04a39", "Created": "2025-07-15T19:05:32.8327389+00:00", "CreatedBy": "264eb35e-8368-4a81-b320-a7b92ca4eec7" }