Steps Test
Finance/Steps/{stepId}
Update an existing step.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Steps/{stepId}

URI Parameters

Parameter Name Data Type Required Notes
stepId integer Y

Request Body

Request object type : Step

Request object type Step has the following properties.
Property Name Data Type Length Required Readonly Notes
Associate ConstituentDisplaySummary N
FK: T_CUSTOMER.customer_no   Resource: Constituents
CompletedOnDateTime date N
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 N
DueDateTime date N
EditIndicator boolean
Id integer Y Non-updatable
NewValue string 30 N
Notes string N
OldValue string 30 N
Plan PlanSummary Y
FK: T_PLAN.plan_no   Resource: Plans
Priority integer N
StepDateTime date Y
Type StepTypeSummary Y
FK: TR_STEP_TYPE.id   Resource: StepTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
WarningDays integer N
Worker ConstituentShortDisplayNameSummary N
FK: T_CUSTOMER.customer_no   Resource: Constituents 
{
  "Associate": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "Id": 1,
  "CompletedOnDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "CreatedDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "DueDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "UpdatedDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "UpdatedBy": "sample string 3",
  "NewValue": "sample string 4",
  "Description": "sample string 5",
  "Notes": "sample string 6",
  "OldValue": "sample string 7",
  "Plan": {
    "Campaign": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true,
      "MembershipOrganization": {
        "Description": "sample string 1",
        "Id": 1,
        "EditIndicator": true
      }
    },
    "ContributionDesignation": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "Constituent": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Fund": {
      "Description": "sample string 1",
      "Id": 1,
      "BusinessUnitId": 1,
      "Inactive": true,
      "TicketingIndicator": true,
      "EditIndicator": true,
      "ConstituencyId": 3
    },
    "Id": 1
  },
  "Type": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "Priority": 1,
  "StepDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "WarningDays": 1,
  "Worker": {
    "Id": 1,
    "SortName": "sample string 1",
    "ShortDisplayName": "sample string 2"
  },
  "EditIndicator": true
}
<Step xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Associate>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Associate>
  <CompletedOnDateTime>2025-10-28T10:02:39.8687876-07:00</CompletedOnDateTime>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-10-28T10:02:39.8687876-07:00</CreatedDateTime>
  <Description>sample string 5</Description>
  <DueDateTime>2025-10-28T10:02:39.8687876-07:00</DueDateTime>
  <EditIndicator>true</EditIndicator>
  <Id>1</Id>
  <NewValue>sample string 4</NewValue>
  <Notes>sample string 6</Notes>
  <OldValue>sample string 7</OldValue>
  <Plan>
    <Campaign>
      <Description>sample string 1</Description>
      <FYear>1</FYear>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <MembershipOrganization>
        <Description>sample string 1</Description>
        <EditIndicator>true</EditIndicator>
        <Id>1</Id>
      </MembershipOrganization>
    </Campaign>
    <Constituent>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Constituent>
    <ContributionDesignation>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ContributionDesignation>
    <Fund>
      <BusinessUnitId>1</BusinessUnitId>
      <ConstituencyId>3</ConstituencyId>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <TicketingIndicator>true</TicketingIndicator>
    </Fund>
    <Id>1</Id>
  </Plan>
  <Priority>1</Priority>
  <StepDateTime>2025-10-28T10:02:39.8687876-07:00</StepDateTime>
  <Type>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </Type>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-10-28T10:02:39.8687876-07:00</UpdatedDateTime>
  <WarningDays>1</WarningDays>
  <Worker>
    <Id>1</Id>
    <ShortDisplayName>sample string 2</ShortDisplayName>
    <SortName>sample string 1</SortName>
  </Worker>
</Step>

Response object type : Step

Response object type Step has the following properties.
Property Name Data Type Length Required Readonly Notes
Associate ConstituentDisplaySummary N
FK: T_CUSTOMER.customer_no   Resource: Constituents
CompletedOnDateTime date N
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 N
DueDateTime date N
EditIndicator boolean
Id integer Y Non-updatable
NewValue string 30 N
Notes string N
OldValue string 30 N
Plan PlanSummary Y
FK: T_PLAN.plan_no   Resource: Plans
Priority integer N
StepDateTime date Y
Type StepTypeSummary Y
FK: TR_STEP_TYPE.id   Resource: StepTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
WarningDays integer N
Worker ConstituentShortDisplayNameSummary N
FK: T_CUSTOMER.customer_no   Resource: Constituents 
{
  "Associate": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "Id": 1,
  "CompletedOnDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "CreatedDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "DueDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "UpdatedDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "UpdatedBy": "sample string 3",
  "NewValue": "sample string 4",
  "Description": "sample string 5",
  "Notes": "sample string 6",
  "OldValue": "sample string 7",
  "Plan": {
    "Campaign": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true,
      "MembershipOrganization": {
        "Description": "sample string 1",
        "Id": 1,
        "EditIndicator": true
      }
    },
    "ContributionDesignation": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    },
    "Constituent": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Fund": {
      "Description": "sample string 1",
      "Id": 1,
      "BusinessUnitId": 1,
      "Inactive": true,
      "TicketingIndicator": true,
      "EditIndicator": true,
      "ConstituencyId": 3
    },
    "Id": 1
  },
  "Type": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "Priority": 1,
  "StepDateTime": "2025-10-28T10:02:39.8687876-07:00",
  "WarningDays": 1,
  "Worker": {
    "Id": 1,
    "SortName": "sample string 1",
    "ShortDisplayName": "sample string 2"
  },
  "EditIndicator": true
}
<Step xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Associate>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Associate>
  <CompletedOnDateTime>2025-10-28T10:02:39.8687876-07:00</CompletedOnDateTime>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-10-28T10:02:39.8687876-07:00</CreatedDateTime>
  <Description>sample string 5</Description>
  <DueDateTime>2025-10-28T10:02:39.8687876-07:00</DueDateTime>
  <EditIndicator>true</EditIndicator>
  <Id>1</Id>
  <NewValue>sample string 4</NewValue>
  <Notes>sample string 6</Notes>
  <OldValue>sample string 7</OldValue>
  <Plan>
    <Campaign>
      <Description>sample string 1</Description>
      <FYear>1</FYear>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <MembershipOrganization>
        <Description>sample string 1</Description>
        <EditIndicator>true</EditIndicator>
        <Id>1</Id>
      </MembershipOrganization>
    </Campaign>
    <Constituent>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Constituent>
    <ContributionDesignation>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ContributionDesignation>
    <Fund>
      <BusinessUnitId>1</BusinessUnitId>
      <ConstituencyId>3</ConstituencyId>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <TicketingIndicator>true</TicketingIndicator>
    </Fund>
    <Id>1</Id>
  </Plan>
  <Priority>1</Priority>
  <StepDateTime>2025-10-28T10:02:39.8687876-07:00</StepDateTime>
  <Type>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </Type>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-10-28T10:02:39.8687876-07:00</UpdatedDateTime>
  <WarningDays>1</WarningDays>
  <Worker>
    <Id>1</Id>
    <ShortDisplayName>sample string 2</ShortDisplayName>
    <SortName>sample string 1</SortName>
  </Worker>
</Step>
Change Version Description Contract Old New
Parameter Changed 15.0.0 stepId has been marked as required. Required