PUT indicators/{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>a1f58661-cbb2-4ce7-93f3-bcf34f82dc92</ID>
  <BasicRoleID>a5bc89b9-7d70-482b-8b65-7463f11b112e</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "a1f58661-cbb2-4ce7-93f3-bcf34f82dc92",
  "BasicRoleID": "a5bc89b9-7d70-482b-8b65-7463f11b112e",
  "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>bb5925c5-9962-4eee-8356-f14099da1abc</ID>
  <BasicRoleID>494757be-d7a7-4185-b4ef-ce4a27700797</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>9121c804-8b18-4a5f-9324-b5e676a51660</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2025-08-29T07:16:43.41353+00:00</Updated>
  <UpdatedBy>96567099-e869-4c01-8053-eb090f05cbbf</UpdatedBy>
  <Created>2025-08-29T07:16:43.41353+00:00</Created>
  <CreatedBy>9f525a75-af49-4349-87e4-ab7caeedfe8b</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "bb5925c5-9962-4eee-8356-f14099da1abc",
  "BasicRoleID": "494757be-d7a7-4185-b4ef-ce4a27700797",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "9121c804-8b18-4a5f-9324-b5e676a51660",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2025-08-29T07:16:43.41353+00:00",
  "UpdatedBy": "96567099-e869-4c01-8053-eb090f05cbbf",
  "Created": "2025-08-29T07:16:43.41353+00:00",
  "CreatedBy": "9f525a75-af49-4349-87e4-ab7caeedfe8b"
}

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.