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>019f8340-b24c-4c86-8574-6c669e57b0e4</ID> <BasicRoleID>7c054660-19b5-4735-9615-d869d38747af</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>bfe8ab18-b783-4ff4-b95c-7c0925358df8</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-08-28T04:07:15.8776734+00:00</Updated> <UpdatedBy>e1b3dc8a-6597-470e-88b8-67bdcc4c06f3</UpdatedBy> <Created>2025-08-28T04:07:15.8776734+00:00</Created> <CreatedBy>e4ef4436-ef30-4032-9962-874982c13b34</CreatedBy> </Indicator>
{ "ID": "019f8340-b24c-4c86-8574-6c669e57b0e4", "BasicRoleID": "7c054660-19b5-4735-9615-d869d38747af", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "bfe8ab18-b783-4ff4-b95c-7c0925358df8", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-08-28T04:07:15.8776734+00:00", "UpdatedBy": "e1b3dc8a-6597-470e-88b8-67bdcc4c06f3", "Created": "2025-08-28T04:07:15.8776734+00:00", "CreatedBy": "e4ef4436-ef30-4032-9962-874982c13b34" }