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>c45f867b-a935-46ba-8776-b42206dfae64</ID> <BasicRoleID>a175978b-da2c-47a9-aa66-981c4568a537</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>3c92cc49-be52-4511-85d1-61be6ec553e2</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-10-01T11:30:00.0563096+00:00</Updated> <UpdatedBy>af82b71b-a77b-4f9a-89fd-e3d49d97c997</UpdatedBy> <Created>2025-10-01T11:30:00.0563096+00:00</Created> <CreatedBy>8f92c6af-aeea-4fc2-b497-ee0d33879f53</CreatedBy> </Indicator>
{ "ID": "c45f867b-a935-46ba-8776-b42206dfae64", "BasicRoleID": "a175978b-da2c-47a9-aa66-981c4568a537", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "3c92cc49-be52-4511-85d1-61be6ec553e2", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-10-01T11:30:00.0563096+00:00", "UpdatedBy": "af82b71b-a77b-4f9a-89fd-e3d49d97c997", "Created": "2025-10-01T11:30:00.0563096+00:00", "CreatedBy": "8f92c6af-aeea-4fc2-b497-ee0d33879f53" }