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>9d2151c8-b2f6-4ea9-9a87-9b6d01b29969</ID>
  <BasicRoleID>b4eb9430-4e57-41ca-a79f-72ad5bf0b4fa</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "9d2151c8-b2f6-4ea9-9a87-9b6d01b29969",
  "BasicRoleID": "b4eb9430-4e57-41ca-a79f-72ad5bf0b4fa",
  "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>ac5f555f-36ee-4e8c-82bf-de8d435faa6a</ID>
  <BasicRoleID>0d188b3d-986e-4164-a711-3a39f9b9a8ae</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>1fce3a51-43e6-4a10-8933-34fc6003796a</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2024-10-24T08:06:28.416928+00:00</Updated>
  <UpdatedBy>f5f8384b-3d79-40b5-a11b-5f32cb8ec7cd</UpdatedBy>
  <Created>2024-10-24T08:06:28.416928+00:00</Created>
  <CreatedBy>5c86f48f-de3e-4ce3-a91e-43f95c645da1</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "ac5f555f-36ee-4e8c-82bf-de8d435faa6a",
  "BasicRoleID": "0d188b3d-986e-4164-a711-3a39f9b9a8ae",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "1fce3a51-43e6-4a10-8933-34fc6003796a",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2024-10-24T08:06:28.416928+00:00",
  "UpdatedBy": "f5f8384b-3d79-40b5-a11b-5f32cb8ec7cd",
  "Created": "2024-10-24T08:06:28.416928+00:00",
  "CreatedBy": "5c86f48f-de3e-4ce3-a91e-43f95c645da1"
}

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.