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>3eacc936-1006-4c72-a1b4-0e783513a9e7</ID> <BasicRoleID>38dc6955-9fab-4fd4-8734-9cfe3bf995bb</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>cafb0482-5ffd-492d-8f79-a0cf3a917722</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2026-03-09T02:56:51.8587729+00:00</Updated> <UpdatedBy>081ec06e-442a-434b-ba09-c155f08ca4cb</UpdatedBy> <Created>2026-03-09T02:56:51.8587729+00:00</Created> <CreatedBy>e5e348f6-45a2-41eb-aff4-3d5c5d89d7fd</CreatedBy> </Indicator>
{
"ID": "3eacc936-1006-4c72-a1b4-0e783513a9e7",
"BasicRoleID": "38dc6955-9fab-4fd4-8734-9cfe3bf995bb",
"Rank": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"SiteID": "cafb0482-5ffd-492d-8f79-a0cf3a917722",
"BasicRoleName": "sample string 4",
"BasicRolePercentTime": 64,
"BasicRoleRank": 1,
"Deleted": true,
"DeletedByRef": true,
"Updated": "2026-03-09T02:56:51.8587729+00:00",
"UpdatedBy": "081ec06e-442a-434b-ba09-c155f08ca4cb",
"Created": "2026-03-09T02:56:51.8587729+00:00",
"CreatedBy": "e5e348f6-45a2-41eb-aff4-3d5c5d89d7fd"
}