Resource Details

ReferenceData/Keywords?filter={filter}&maintenanceMode={maintenanceMode}

Get all keywords. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

Http Verb	GET
Resource URL	https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/Keywords?filter={filter}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name	Data Type	Required	Notes
filter	string	N	Filter by user access (default: readwrite).
maintenanceMode	boolean	N	Ignore control grouping (default: false).

Request Body

None.

No request body.

Response object type : Collection of Keyword

Response object type Collection of Keyword has the following properties.

Property Name	Data Type	Required
Category	KeywordCategorySummary	N
Category	FK: TR_KEYWORD_CATEGORY.id Resource: KeywordCategories
ConstituentType	integer	N
ControlGroup	ControlGroupSummary	N
ControlGroup	FK: TR_CONTROL_GROUP.id Resource: ControlGroups
CreatedBy	string	N
CreatedDateTime	date	N
CreateLocation	string	N
CustomDefaultValue	string	N
CustomId	integer	N
CustomLimit	integer	N
CustomRequired	boolean	N
DataType	string	N
Description	string	N
DetailColumn	string	N
DetailTable	string	N
EditIndicator	boolean
EditMask	string	N
ExtendedDescription	string	N
FrequentUpdateDate	date	N
HelpText	string	N
Id	integer	N
KeyColumn	string	N
KeywordUse	string	N
MultipleValue	boolean	N
ParentKeyColumn	string	N
ParentTable	string	N
PrimaryGroupDefault	string	N
ReferenceDescriptionColumn	string	N
ReferenceIdColumn	string	N
ReferenceSort	string	N
ReferenceTable	string	N
ReferenceWhere	string	N
SortOrder	integer	N
UpdatedBy	string	N
UpdatedDateTime	date	N
UseForSearch	boolean	N
ValuesCodedIndicator	boolean	N

application/json, text/json
application/xml, text/xml

[
  {
    "Category": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "CreatedDateTime": "2025-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-07:00",
    "UseForSearch": true,
    "ExtendedDescription": "sample string 9",
    "Id": 10,
    "UpdatedDateTime": "2025-07-29T16:33:40.8509294-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"
  },
  {
    "Category": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "CreatedDateTime": "2025-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-07:00",
    "UseForSearch": true,
    "ExtendedDescription": "sample string 9",
    "Id": 10,
    "UpdatedDateTime": "2025-07-29T16:33:40.8509294-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"
  }
]

<Keywords xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Keyword>
    <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-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-07:00</UpdatedDateTime>
    <UseForSearch>true</UseForSearch>
    <ValuesCodedIndicator>true</ValuesCodedIndicator>
  </Keyword>
  <Keyword>
    <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-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-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-07-29T16:33:40.8509294-07:00</UpdatedDateTime>
    <UseForSearch>true</UseForSearch>
    <ValuesCodedIndicator>true</ValuesCodedIndicator>
  </Keyword>
</Keywords>

No entries in change log for this operation.