Keywords Test
ReferenceData/Keywords/Summary
Get a summary representation of all keywords.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/Keywords/Summary

URI Parameters

This resource has no URI (Query) parameters.

Request Body

None.
No request body.

Response object type : Collection of KeywordSummary

Response object type Collection of KeywordSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
Category KeywordCategorySummary
CustomId integer N
DataType string
Description string
DetailColumn string
DetailTable string
EditMask string
ExtendedDescription string
HelpText string N
Id integer
KeywordUse string N
MultipleValue boolean
ParentTable string
PrimaryGroupDefault string
ReferenceTable string 
[
  {
    "Description": "sample string 1",
    "Id": 2,
    "EditMask": "sample string 3",
    "DataType": "sample string 4",
    "MultipleValue": true,
    "ReferenceTable": "sample string 5",
    "DetailTable": "sample string 6",
    "PrimaryGroupDefault": "sample string 7",
    "Category": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "HelpText": "sample string 8",
    "ExtendedDescription": "sample string 9",
    "DetailColumn": "sample string 10",
    "ParentTable": "sample string 11",
    "CustomId": 1,
    "KeywordUse": "sample string 12"
  },
  {
    "Description": "sample string 1",
    "Id": 2,
    "EditMask": "sample string 3",
    "DataType": "sample string 4",
    "MultipleValue": true,
    "ReferenceTable": "sample string 5",
    "DetailTable": "sample string 6",
    "PrimaryGroupDefault": "sample string 7",
    "Category": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "HelpText": "sample string 8",
    "ExtendedDescription": "sample string 9",
    "DetailColumn": "sample string 10",
    "ParentTable": "sample string 11",
    "CustomId": 1,
    "KeywordUse": "sample string 12"
  }
]
<KeywordSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Keyword>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Category>
    <CustomId>1</CustomId>
    <DataType>sample string 4</DataType>
    <Description>sample string 1</Description>
    <DetailColumn>sample string 10</DetailColumn>
    <DetailTable>sample string 6</DetailTable>
    <EditMask>sample string 3</EditMask>
    <ExtendedDescription>sample string 9</ExtendedDescription>
    <HelpText>sample string 8</HelpText>
    <Id>2</Id>
    <KeywordUse>sample string 12</KeywordUse>
    <MultipleValue>true</MultipleValue>
    <ParentTable>sample string 11</ParentTable>
    <PrimaryGroupDefault>sample string 7</PrimaryGroupDefault>
    <ReferenceTable>sample string 5</ReferenceTable>
  </Keyword>
  <Keyword>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Category>
    <CustomId>1</CustomId>
    <DataType>sample string 4</DataType>
    <Description>sample string 1</Description>
    <DetailColumn>sample string 10</DetailColumn>
    <DetailTable>sample string 6</DetailTable>
    <EditMask>sample string 3</EditMask>
    <ExtendedDescription>sample string 9</ExtendedDescription>
    <HelpText>sample string 8</HelpText>
    <Id>2</Id>
    <KeywordUse>sample string 12</KeywordUse>
    <MultipleValue>true</MultipleValue>
    <ParentTable>sample string 11</ParentTable>
    <PrimaryGroupDefault>sample string 7</PrimaryGroupDefault>
    <ReferenceTable>sample string 5</ReferenceTable>
  </Keyword>
</KeywordSummaries>
Change Version Description Contract Old New
Property Added 15.1.0 CustomId has been added to KeywordSummary KeywordSummary KeywordSummary.CustomId
Property Added 15.1.0 KeywordUse has been added to KeywordSummary KeywordSummary KeywordSummary.KeywordUse
Property Added 15.0.0 DetailColumn has been added to KeywordSummary KeywordSummary KeywordSummary.DetailColumn
Property Added 15.0.0 ExtendedDescription has been added to KeywordSummary KeywordSummary KeywordSummary.ExtendedDescription
Property Added 15.0.0 ParentTable has been added to KeywordSummary KeywordSummary KeywordSummary.ParentTable