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>1191b0d7-7bd8-4619-ba29-26932f601e8b</ID>
  <BasicRoleID>a657d1b2-fe0e-4d73-8f2b-e533e7be55f1</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
</Indicator>

application/json, text/json

Sample

{
  "ID": "1191b0d7-7bd8-4619-ba29-26932f601e8b",
  "BasicRoleID": "a657d1b2-fe0e-4d73-8f2b-e533e7be55f1",
  "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>c46c02e3-f91b-46bc-8c35-72e1cb1d4760</ID>
  <BasicRoleID>fbbd50dd-7a52-4f3d-9ab0-8f9db0050cc8</BasicRoleID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <SiteID>ee627b32-a20d-4334-a7e7-3fa82d953e5e</SiteID>
  <BasicRoleName>sample string 4</BasicRoleName>
  <BasicRolePercentTime>64</BasicRolePercentTime>
  <BasicRoleRank>1</BasicRoleRank>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Updated>2024-10-24T16:13:16.6107283+00:00</Updated>
  <UpdatedBy>e77685c1-b7cf-4659-922a-b15f9ff46cd1</UpdatedBy>
  <Created>2024-10-24T16:13:16.6107283+00:00</Created>
  <CreatedBy>0c3517db-fbc1-4259-8031-bbd6beab7157</CreatedBy>
</Indicator>

application/json, text/json

Sample

{
  "ID": "c46c02e3-f91b-46bc-8c35-72e1cb1d4760",
  "BasicRoleID": "fbbd50dd-7a52-4f3d-9ab0-8f9db0050cc8",
  "Rank": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "ee627b32-a20d-4334-a7e7-3fa82d953e5e",
  "BasicRoleName": "sample string 4",
  "BasicRolePercentTime": 64,
  "BasicRoleRank": 1,
  "Deleted": true,
  "DeletedByRef": true,
  "Updated": "2024-10-24T16:13:16.6107283+00:00",
  "UpdatedBy": "e77685c1-b7cf-4659-922a-b15f9ff46cd1",
  "Created": "2024-10-24T16:13:16.6107283+00:00",
  "CreatedBy": "0c3517db-fbc1-4259-8031-bbd6beab7157"
}

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.