Back

GET indicators/{id}

Read a performance indicator.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the perforamnce indiacator to read.

Body Parameters

None.

Response Information

Resource Description (Indicator)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
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.

Response Formats

application/xml, text/xml

Sample
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>6b8cd4c6-d4a4-4e4d-9ccd-7c4df6c4d390</ID>
  <BasicRoleID>8607f67d-db49-4260-9196-300147867044</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>7cfb3475-db07-47c8-8f22-9a6453bc3dfe</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2024-10-24T07:22:02.0873977+00:00</Updated>
  <UpdatedBy>552ceeba-eabd-4b5e-9b06-09bfe0f4ba64</UpdatedBy>
  <Created>2024-10-24T07:22:02.0873977+00:00</Created>
  <CreatedBy>30579b44-cd29-4fcd-92f6-584be630b994</CreatedBy>
</Indicator>

application/json, text/json

Sample
{
  "ID": "6b8cd4c6-d4a4-4e4d-9ccd-7c4df6c4d390",
  "BasicRoleID": "8607f67d-db49-4260-9196-300147867044",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "7cfb3475-db07-47c8-8f22-9a6453bc3dfe",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2024-10-24T07:22:02.0873977+00:00",
  "UpdatedBy": "552ceeba-eabd-4b5e-9b06-09bfe0f4ba64",
  "Created": "2024-10-24T07:22:02.0873977+00:00",
  "CreatedBy": "30579b44-cd29-4fcd-92f6-584be630b994"
}