Read a performance indicator.
id
globally unique identifier
Required
Guid ID of the perforamnce indiacator to read. |
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>597780ca-1149-479d-b641-60f3525ca973</ID> <BasicRoleID>82003904-d9aa-4963-a4ed-48d52d947534</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>d5499798-5314-494b-8852-dd2bfcbac8a6</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-06-20T08:20:23.104535+00:00</Updated> <UpdatedBy>5af48a26-9826-42c0-b30d-c77b1f56b820</UpdatedBy> <Created>2025-06-20T08:20:23.104535+00:00</Created> <CreatedBy>c94fc3ab-87bd-428d-b2d8-7df804990c1b</CreatedBy> </Indicator>
{ "ID": "597780ca-1149-479d-b641-60f3525ca973", "BasicRoleID": "82003904-d9aa-4963-a4ed-48d52d947534", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "d5499798-5314-494b-8852-dd2bfcbac8a6", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-06-20T08:20:23.104535+00:00", "UpdatedBy": "5af48a26-9826-42c0-b30d-c77b1f56b820", "Created": "2025-06-20T08:20:23.104535+00:00", "CreatedBy": "c94fc3ab-87bd-428d-b2d8-7df804990c1b" }