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>d626956d-020c-49e6-b74a-2a7a4d91738b</ID> <BasicRoleID>7fd91037-a2e4-4795-a07e-97a08522d72a</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>b2f4c6c4-29f6-4ee7-b8a2-bb1bfe46219a</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-03-08T05:22:52.3379659+00:00</Updated> <UpdatedBy>2e189cf1-25e9-4b76-b430-8c599bcdc929</UpdatedBy> <Created>2025-03-08T05:22:52.3379659+00:00</Created> <CreatedBy>91917c05-66d4-499a-a50f-a4ae8970db42</CreatedBy> </Indicator>
{ "ID": "d626956d-020c-49e6-b74a-2a7a4d91738b", "BasicRoleID": "7fd91037-a2e4-4795-a07e-97a08522d72a", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "b2f4c6c4-29f6-4ee7-b8a2-bb1bfe46219a", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-03-08T05:22:52.3379659+00:00", "UpdatedBy": "2e189cf1-25e9-4b76-b430-8c599bcdc929", "Created": "2025-03-08T05:22:52.3379659+00:00", "CreatedBy": "91917c05-66d4-499a-a50f-a4ae8970db42" }