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>b1dbb051-472e-4ea9-8120-a498496a6a6b</ID>
  <BasicRoleID>743cc882-4392-429f-a13f-c070372c48a4</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "b1dbb051-472e-4ea9-8120-a498496a6a6b",
  "BasicRoleID": "743cc882-4392-429f-a13f-c070372c48a4",
  "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>1dd0649e-d1b3-45fc-a301-6e347d3cd4e3</ID>
  <BasicRoleID>fcb718a9-a0fc-43c7-a7c7-8fb717df26ad</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>1ffe0f2d-4250-4e0c-951e-38abb778f23a</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2024-10-23T12:33:36.9580053+00:00</Updated>
  <UpdatedBy>f0a9c0ef-1318-4bf8-83c2-5a6a4d79c7be</UpdatedBy>
  <Created>2024-10-23T12:33:36.9580053+00:00</Created>
  <CreatedBy>2b2d4fc8-9d8b-4039-971c-b87f08872f57</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "1dd0649e-d1b3-45fc-a301-6e347d3cd4e3",
  "BasicRoleID": "fcb718a9-a0fc-43c7-a7c7-8fb717df26ad",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "1ffe0f2d-4250-4e0c-951e-38abb778f23a",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2024-10-23T12:33:36.9580053+00:00",
  "UpdatedBy": "f0a9c0ef-1318-4bf8-83c2-5a6a4d79c7be",
  "Created": "2024-10-23T12:33:36.9580053+00:00",
  "CreatedBy": "2b2d4fc8-9d8b-4039-971c-b87f08872f57"
}

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.