POST indicators

Request Information

URI Parameters

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

None.

Body Parameters (Indicator)

This object takes all the parameters needed to create a new 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>e57af309-e3d9-4a77-933b-6900f2eb5304</ID>
  <BasicRoleID>c658001b-3eb7-4228-831f-acd33baffb60</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "e57af309-e3d9-4a77-933b-6900f2eb5304",
  "BasicRoleID": "c658001b-3eb7-4228-831f-acd33baffb60",
  "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>2c19f2a5-049d-49cd-9ec8-ad9a5e387bf9</ID>
  <BasicRoleID>b11e9d28-5e34-49e6-aad3-9232d6d51544</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>4f6237e5-bbd1-46ac-88ac-33b08c746f4b</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2025-05-20T20:51:51.7796875+00:00</Updated>
  <UpdatedBy>21a2098e-d6d8-4808-b7c2-899c91028c04</UpdatedBy>
  <Created>2025-05-20T20:51:51.7796875+00:00</Created>
  <CreatedBy>c232ea6b-2431-47b4-970a-5cbfc93a40c6</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "2c19f2a5-049d-49cd-9ec8-ad9a5e387bf9",
  "BasicRoleID": "b11e9d28-5e34-49e6-aad3-9232d6d51544",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "4f6237e5-bbd1-46ac-88ac-33b08c746f4b",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2025-05-20T20:51:51.7796875+00:00",
  "UpdatedBy": "21a2098e-d6d8-4808-b7c2-899c91028c04",
  "Created": "2025-05-20T20:51:51.7796875+00:00",
  "CreatedBy": "c232ea6b-2431-47b4-970a-5cbfc93a40c6"
}

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.