PUT performanceindicators/{id}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
id `globally unique identifier` Required Guid ID of the performance indicator to be updated.	`globally unique identifier` Required Guid ID of the performance indicator to be updated.

Body Parameters (Indicator)

This object takes all the parameters needed to update a performance indicator.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Request Formats

application/xml, text/xml

Sample

<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>d08ef098-aad2-4389-ae73-d563c4043582</ID>
  <BasicRoleID>6445baf3-6cd8-40c7-9fbc-c31f5a2d194c</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "d08ef098-aad2-4389-ae73-d563c4043582",
  "BasicRoleID": "6445baf3-6cd8-40c7-9fbc-c31f5a2d194c",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2"
}

Response Information

Resource Description (Indicator)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Response Formats

application/xml, text/xml

Sample

<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>5e5d981c-3275-4e43-b66b-b3b799a44656</ID>
  <BasicRoleID>341a605f-0f01-4e8e-8cd9-b25b5edf9a24</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>0b485d4a-bcf8-4c35-b6cf-832ddb2b15a8</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2025-08-01T05:51:31.5063922+00:00</Updated>
  <UpdatedBy>a94dfc8e-fd75-4163-8180-d3c967a7f92a</UpdatedBy>
  <Created>2025-08-01T05:51:31.5063922+00:00</Created>
  <CreatedBy>5cd91b90-89c8-42c6-80d4-e010fa577948</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "5e5d981c-3275-4e43-b66b-b3b799a44656",
  "BasicRoleID": "341a605f-0f01-4e8e-8cd9-b25b5edf9a24",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "0b485d4a-bcf8-4c35-b6cf-832ddb2b15a8",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2025-08-01T05:51:31.5063922+00:00",
  "UpdatedBy": "a94dfc8e-fd75-4163-8180-d3c967a7f92a",
  "Created": "2025-08-01T05:51:31.5063922+00:00",
  "CreatedBy": "5cd91b90-89c8-42c6-80d4-e010fa577948"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the given performance indicator.	`globally unique identifier` Required on Update ID of the given performance indicator.
BasicRoleID `globally unique identifier` ID of the given basic role.	`globally unique identifier` ID of the given basic role.
Rank `integer` Rank of the given performance indicator.	`integer` Rank of the given performance indicator.
Name `string` Required Name of the given performance indicator. (Max length 200 characters)	`string` Required Name of the given performance indicator. (Max length 200 characters)
Description `string` Description of the given performance indicator.	`string` Description of the given performance indicator.
SiteID `globally unique identifier` ReadOnly ID of the site for the given performance indicator.	`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.	`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.	`byte` ReadOnly Percent of time that should be devoted to the given basic role.
BasicRoleRank `integer` ReadOnly Rank of the given basic role.	`integer` ReadOnly Rank of the given basic role.
Deleted `boolean` ReadOnly Deleted status of the given performance indicator.	`boolean` ReadOnly Deleted status of the given performance indicator.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the given performance indicator.	`boolean` ReadOnly Deleted by reference status of the given performance indicator.
Updated `date` ReadOnly Date when the given performance indicator was last 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.	`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.	`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.	`globally unique identifier` ReadOnly ID of the individual that created the given performance indicator.