Reads performance Indicators for basic roles or individuals.
|
basicroleid
globally unique identifier
Guid ID of the basic role for which to read performance indicators. |
|
individualid
globally unique identifier
Guid ID of the individual whose performance indicators are to be read. |
|
deleted
byte
Add ?deleted=0, 1, or 2 for not deleted, deleted, or all. |
None.
|
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>ccf6b4e8-3d44-48b1-83ed-073ad94c744d</ID> <BasicRoleID>6da87b8e-d8ee-4afe-bfd0-37e1fdf66584</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>8a98550a-a995-40e3-bc7b-5c9f4fb3dff7</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2026-04-04T19:32:12.9063115+00:00</Updated> <UpdatedBy>36de3b5d-dcb8-4d8e-8fa0-b994d26aa0a3</UpdatedBy> <Created>2026-04-04T19:32:12.9063115+00:00</Created> <CreatedBy>b396f31a-0cc3-415f-a4ec-6c738471ebc3</CreatedBy> </Indicator>
{
"ID": "ccf6b4e8-3d44-48b1-83ed-073ad94c744d",
"BasicRoleID": "6da87b8e-d8ee-4afe-bfd0-37e1fdf66584",
"Rank": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"SiteID": "8a98550a-a995-40e3-bc7b-5c9f4fb3dff7",
"BasicRoleName": "sample string 4",
"BasicRolePercentTime": 64,
"BasicRoleRank": 1,
"Deleted": true,
"DeletedByRef": true,
"Updated": "2026-04-04T19:32:12.9063115+00:00",
"UpdatedBy": "36de3b5d-dcb8-4d8e-8fa0-b994d26aa0a3",
"Created": "2026-04-04T19:32:12.9063115+00:00",
"CreatedBy": "b396f31a-0cc3-415f-a4ec-6c738471ebc3"
}