Keywords Test
ReferenceData/Keywords/{id}
Update an existing keyword.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/Keywords/{id}

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : Keyword

Request object type Keyword has the following properties.
Property Name Data Type Length Required Readonly Notes
Category KeywordCategorySummary N
FK: TR_KEYWORD_CATEGORY.id   Resource: KeywordCategories
ConstituentType integer N
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CustomDefaultValue string 30 N
CustomId integer N
CustomLimit integer N
CustomRequired boolean N
DataType string 20 N
Description string 30 N
DetailColumn string 100 N
DetailTable string 30 N
EditIndicator boolean
EditMask string 30 N
ExtendedDescription string 255 N
FrequentUpdateDate date N
HelpText string 1024 N
Id integer Y Non-updatable
KeyColumn string 30 N
KeywordUse string N
MultipleValue boolean N
ParentKeyColumn string 30 N
ParentTable string 30 N
PrimaryGroupDefault string Y
ReferenceDescriptionColumn string 30 N
ReferenceIdColumn string 30 N
ReferenceSort string 100 N
ReferenceTable string 30 N
ReferenceWhere string 100 N
SortOrder integer N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseForSearch boolean N
ValuesCodedIndicator boolean N 
{
  "Category": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:26:40.6712334-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "ConstituentType": 1,
  "CustomDefaultValue": "sample string 4",
  "CustomId": 1,
  "CustomLimit": 1,
  "CustomRequired": true,
  "DataType": "sample string 5",
  "DetailColumn": "sample string 6",
  "DetailTable": "sample string 7",
  "EditMask": "sample string 8",
  "FrequentUpdateDate": "2025-04-24T08:26:40.6712334-07:00",
  "UseForSearch": true,
  "ExtendedDescription": "sample string 9",
  "Id": 10,
  "UpdatedDateTime": "2025-04-24T08:26:40.6712334-07:00",
  "UpdatedBy": "sample string 11",
  "MultipleValue": true,
  "ReferenceDescriptionColumn": "sample string 12",
  "ReferenceIdColumn": "sample string 13",
  "ReferenceSort": "sample string 14",
  "ReferenceTable": "sample string 15",
  "ReferenceWhere": "sample string 16",
  "SortOrder": 1,
  "KeywordUse": "sample string 17",
  "ValuesCodedIndicator": true,
  "PrimaryGroupDefault": "sample string 18",
  "ParentTable": "sample string 19",
  "ParentKeyColumn": "sample string 20",
  "KeyColumn": "sample string 21",
  "EditIndicator": true,
  "HelpText": "sample string 22"
}
<Keyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Category>
  <ConstituentType>1</ConstituentType>
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T08:26:40.6712334-07:00</CreatedDateTime>
  <CustomDefaultValue>sample string 4</CustomDefaultValue>
  <CustomId>1</CustomId>
  <CustomLimit>1</CustomLimit>
  <CustomRequired>true</CustomRequired>
  <DataType>sample string 5</DataType>
  <Description>sample string 3</Description>
  <DetailColumn>sample string 6</DetailColumn>
  <DetailTable>sample string 7</DetailTable>
  <EditIndicator>true</EditIndicator>
  <EditMask>sample string 8</EditMask>
  <ExtendedDescription>sample string 9</ExtendedDescription>
  <FrequentUpdateDate>2025-04-24T08:26:40.6712334-07:00</FrequentUpdateDate>
  <HelpText>sample string 22</HelpText>
  <Id>10</Id>
  <KeyColumn>sample string 21</KeyColumn>
  <KeywordUse>sample string 17</KeywordUse>
  <MultipleValue>true</MultipleValue>
  <ParentKeyColumn>sample string 20</ParentKeyColumn>
  <ParentTable>sample string 19</ParentTable>
  <PrimaryGroupDefault>sample string 18</PrimaryGroupDefault>
  <ReferenceDescriptionColumn>sample string 12</ReferenceDescriptionColumn>
  <ReferenceIdColumn>sample string 13</ReferenceIdColumn>
  <ReferenceSort>sample string 14</ReferenceSort>
  <ReferenceTable>sample string 15</ReferenceTable>
  <ReferenceWhere>sample string 16</ReferenceWhere>
  <SortOrder>1</SortOrder>
  <UpdatedBy>sample string 11</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:26:40.6712334-07:00</UpdatedDateTime>
  <UseForSearch>true</UseForSearch>
  <ValuesCodedIndicator>true</ValuesCodedIndicator>
</Keyword>

Response object type : Keyword

Response object type Keyword has the following properties.
Property Name Data Type Length Required Readonly Notes
Category KeywordCategorySummary N
FK: TR_KEYWORD_CATEGORY.id   Resource: KeywordCategories
ConstituentType integer N
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CustomDefaultValue string 30 N
CustomId integer N
CustomLimit integer N
CustomRequired boolean N
DataType string 20 N
Description string 30 N
DetailColumn string 100 N
DetailTable string 30 N
EditIndicator boolean
EditMask string 30 N
ExtendedDescription string 255 N
FrequentUpdateDate date N
HelpText string 1024 N
Id integer Y Non-updatable
KeyColumn string 30 N
KeywordUse string N
MultipleValue boolean N
ParentKeyColumn string 30 N
ParentTable string 30 N
PrimaryGroupDefault string Y
ReferenceDescriptionColumn string 30 N
ReferenceIdColumn string 30 N
ReferenceSort string 100 N
ReferenceTable string 30 N
ReferenceWhere string 100 N
SortOrder integer N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseForSearch boolean N
ValuesCodedIndicator boolean N 
{
  "Category": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:26:40.6712334-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "ConstituentType": 1,
  "CustomDefaultValue": "sample string 4",
  "CustomId": 1,
  "CustomLimit": 1,
  "CustomRequired": true,
  "DataType": "sample string 5",
  "DetailColumn": "sample string 6",
  "DetailTable": "sample string 7",
  "EditMask": "sample string 8",
  "FrequentUpdateDate": "2025-04-24T08:26:40.6712334-07:00",
  "UseForSearch": true,
  "ExtendedDescription": "sample string 9",
  "Id": 10,
  "UpdatedDateTime": "2025-04-24T08:26:40.6712334-07:00",
  "UpdatedBy": "sample string 11",
  "MultipleValue": true,
  "ReferenceDescriptionColumn": "sample string 12",
  "ReferenceIdColumn": "sample string 13",
  "ReferenceSort": "sample string 14",
  "ReferenceTable": "sample string 15",
  "ReferenceWhere": "sample string 16",
  "SortOrder": 1,
  "KeywordUse": "sample string 17",
  "ValuesCodedIndicator": true,
  "PrimaryGroupDefault": "sample string 18",
  "ParentTable": "sample string 19",
  "ParentKeyColumn": "sample string 20",
  "KeyColumn": "sample string 21",
  "EditIndicator": true,
  "HelpText": "sample string 22"
}
<Keyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Category>
  <ConstituentType>1</ConstituentType>
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T08:26:40.6712334-07:00</CreatedDateTime>
  <CustomDefaultValue>sample string 4</CustomDefaultValue>
  <CustomId>1</CustomId>
  <CustomLimit>1</CustomLimit>
  <CustomRequired>true</CustomRequired>
  <DataType>sample string 5</DataType>
  <Description>sample string 3</Description>
  <DetailColumn>sample string 6</DetailColumn>
  <DetailTable>sample string 7</DetailTable>
  <EditIndicator>true</EditIndicator>
  <EditMask>sample string 8</EditMask>
  <ExtendedDescription>sample string 9</ExtendedDescription>
  <FrequentUpdateDate>2025-04-24T08:26:40.6712334-07:00</FrequentUpdateDate>
  <HelpText>sample string 22</HelpText>
  <Id>10</Id>
  <KeyColumn>sample string 21</KeyColumn>
  <KeywordUse>sample string 17</KeywordUse>
  <MultipleValue>true</MultipleValue>
  <ParentKeyColumn>sample string 20</ParentKeyColumn>
  <ParentTable>sample string 19</ParentTable>
  <PrimaryGroupDefault>sample string 18</PrimaryGroupDefault>
  <ReferenceDescriptionColumn>sample string 12</ReferenceDescriptionColumn>
  <ReferenceIdColumn>sample string 13</ReferenceIdColumn>
  <ReferenceSort>sample string 14</ReferenceSort>
  <ReferenceTable>sample string 15</ReferenceTable>
  <ReferenceWhere>sample string 16</ReferenceWhere>
  <SortOrder>1</SortOrder>
  <UpdatedBy>sample string 11</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:26:40.6712334-07:00</UpdatedDateTime>
  <UseForSearch>true</UseForSearch>
  <ValuesCodedIndicator>true</ValuesCodedIndicator>
</Keyword>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required