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>2e79d3f8-ea8a-48ea-838c-c4d062fbd779</ID> <BasicRoleID>8a8c8a63-2134-4f4b-8a38-936405801944</BasicRoleID> <Rank>1</Rank> <Name>sample string 1</Name> <Description>sample string 2</Description> <SiteID>805665c8-381a-43ed-8eb5-08e36c8880bd</SiteID> <BasicRoleName>sample string 4</BasicRoleName> <BasicRolePercentTime>64</BasicRolePercentTime> <BasicRoleRank>1</BasicRoleRank> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Updated>2025-02-04T08:21:59.324759+00:00</Updated> <UpdatedBy>269ec022-e693-4f89-9a67-e3e0d3b3d505</UpdatedBy> <Created>2025-02-04T08:21:59.324759+00:00</Created> <CreatedBy>92dfafa9-50c4-4100-b57d-69ec89fe68bd</CreatedBy> </Indicator>
{ "ID": "2e79d3f8-ea8a-48ea-838c-c4d062fbd779", "BasicRoleID": "8a8c8a63-2134-4f4b-8a38-936405801944", "Rank": 1, "Name": "sample string 1", "Description": "sample string 2", "SiteID": "805665c8-381a-43ed-8eb5-08e36c8880bd", "BasicRoleName": "sample string 4", "BasicRolePercentTime": 64, "BasicRoleRank": 1, "Deleted": true, "DeletedByRef": true, "Updated": "2025-02-04T08:21:59.324759+00:00", "UpdatedBy": "269ec022-e693-4f89-9a67-e3e0d3b3d505", "Created": "2025-02-04T08:21:59.324759+00:00", "CreatedBy": "92dfafa9-50c4-4100-b57d-69ec89fe68bd" }