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

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : StepType

Request object type StepType has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowAttachments string Y
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
Description string Y
Id integer Y Non-updatable
Inactive boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseAssociate string Y
UseCompletedOnDateTime string Y
UseDueDateTime string Y
UseNote string Y
UseWarningDays string Y
UseWorker string Y 
{
  "Id": 1,
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:16:54.7491746-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T08:16:54.7491746-07:00",
  "UpdatedBy": "sample string 4",
  "UseAssociate": "sample string 5",
  "AllowAttachments": "sample string 6",
  "UseCompletedOnDateTime": "sample string 7",
  "UseDueDateTime": "sample string 8",
  "UseNote": "sample string 9",
  "UseWarningDays": "sample string 10",
  "UseWorker": "sample string 11"
}
<StepType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AllowAttachments>sample string 6</AllowAttachments>
  <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:16:54.7491746-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:16:54.7491746-07:00</UpdatedDateTime>
  <UseAssociate>sample string 5</UseAssociate>
  <UseCompletedOnDateTime>sample string 7</UseCompletedOnDateTime>
  <UseDueDateTime>sample string 8</UseDueDateTime>
  <UseNote>sample string 9</UseNote>
  <UseWarningDays>sample string 10</UseWarningDays>
  <UseWorker>sample string 11</UseWorker>
</StepType>

Response object type : StepType

Response object type StepType has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowAttachments string Y
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
Description string Y
Id integer Y Non-updatable
Inactive boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseAssociate string Y
UseCompletedOnDateTime string Y
UseDueDateTime string Y
UseNote string Y
UseWarningDays string Y
UseWorker string Y 
{
  "Id": 1,
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:16:54.7648003-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T08:16:54.7648003-07:00",
  "UpdatedBy": "sample string 4",
  "UseAssociate": "sample string 5",
  "AllowAttachments": "sample string 6",
  "UseCompletedOnDateTime": "sample string 7",
  "UseDueDateTime": "sample string 8",
  "UseNote": "sample string 9",
  "UseWarningDays": "sample string 10",
  "UseWorker": "sample string 11"
}
<StepType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AllowAttachments>sample string 6</AllowAttachments>
  <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:16:54.7648003-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:16:54.7648003-07:00</UpdatedDateTime>
  <UseAssociate>sample string 5</UseAssociate>
  <UseCompletedOnDateTime>sample string 7</UseCompletedOnDateTime>
  <UseDueDateTime>sample string 8</UseDueDateTime>
  <UseNote>sample string 9</UseNote>
  <UseWarningDays>sample string 10</UseWarningDays>
  <UseWorker>sample string 11</UseWorker>
</StepType>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required