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>c6f2b9de-945c-45df-bf6b-d3559a401148</ID> <BasicRoleID>5331cc59-6579-4595-8bf2-6bca4816dd90</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>e1a4ec92-c288-4b63-a418-a785dc3c6046</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-02-15T14:34:37.1512948+00:00</Updated> <UpdatedBy>5b64d753-490c-4773-8ffd-9c04af0bb7c0</UpdatedBy> <Created>2025-02-15T14:34:37.1512948+00:00</Created> <CreatedBy>e289fffb-18ca-423c-8e54-a5e67a1cf66d</CreatedBy> </Indicator>
{ "ID": "c6f2b9de-945c-45df-bf6b-d3559a401148", "BasicRoleID": "5331cc59-6579-4595-8bf2-6bca4816dd90", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "e1a4ec92-c288-4b63-a418-a785dc3c6046", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-02-15T14:34:37.1512948+00:00", "UpdatedBy": "5b64d753-490c-4773-8ffd-9c04af0bb7c0", "Created": "2025-02-15T14:34:37.1512948+00:00", "CreatedBy": "e289fffb-18ca-423c-8e54-a5e67a1cf66d" }