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>7ea54e79-218b-4f83-b88b-939d04891785</ID> <BasicRoleID>ecee7a1c-346e-4850-a5f3-50409198da3f</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>a0d1b3b8-0579-4d24-b934-34e55888c967</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-10-23T04:34:26.7139959+00:00</Updated> <UpdatedBy>00554b55-cdc4-4bdf-a4bc-992939df518c</UpdatedBy> <Created>2025-10-23T04:34:26.7139959+00:00</Created> <CreatedBy>401f24dc-3025-403d-a622-2bfbf59c42e0</CreatedBy> </Indicator>
{
"ID": "7ea54e79-218b-4f83-b88b-939d04891785",
"BasicRoleID": "ecee7a1c-346e-4850-a5f3-50409198da3f",
"Rank": 1,
"Name": "sample string 1",
"Description": "sample string 2",
"SiteID": "a0d1b3b8-0579-4d24-b934-34e55888c967",
"BasicRoleName": "sample string 4",
"BasicRolePercentTime": 64,
"BasicRoleRank": 1,
"Deleted": true,
"DeletedByRef": true,
"Updated": "2025-10-23T04:34:26.7139959+00:00",
"UpdatedBy": "00554b55-cdc4-4bdf-a4bc-992939df518c",
"Created": "2025-10-23T04:34:26.7139959+00:00",
"CreatedBy": "401f24dc-3025-403d-a622-2bfbf59c42e0"
}