Steps Test
Finance/Steps/{stepId}/Documents/{documentId}
Update a document attached to a step.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Steps/{stepId}/Documents/{documentId}

URI Parameters

Parameter Name Data Type Required Notes
stepId integer Y
documentId integer Y

Request Body

Request object type : Document

Request object type Document has the following properties.
Property Name Data Type Length Required Readonly Notes
Category DocumentCategorySummary Y
ConstituentId integer N
Contents Collection of byte N
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 N
FileName string 255 Y
Id integer Y Non-updatable
Notes string 8000 N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "Id": 1,
  "Contents": "QEA=",
  "FileName": "sample string 1",
  "Description": "sample string 2",
  "Notes": "sample string 3",
  "Category": {
    "Id": 1,
    "Description": "sample string 1",
    "ParentTableName": "sample string 2",
    "Inactive": true
  },
  "ConstituentId": 1,
  "CreatedDateTime": "2025-04-24T04:54:35.7807314-07:00",
  "CreateLocation": "sample string 4",
  "CreatedBy": "sample string 5",
  "UpdatedDateTime": "2025-04-24T04:54:35.7807314-07:00",
  "UpdatedBy": "sample string 6"
}
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ParentTableName>sample string 2</ParentTableName>
  </Category>
  <ConstituentId>1</ConstituentId>
  <Contents>QEA=</Contents>
  <CreateLocation>sample string 4</CreateLocation>
  <CreatedBy>sample string 5</CreatedBy>
  <CreatedDateTime>2025-04-24T04:54:35.7807314-07:00</CreatedDateTime>
  <Description>sample string 2</Description>
  <FileName>sample string 1</FileName>
  <Id>1</Id>
  <Notes>sample string 3</Notes>
  <UpdatedBy>sample string 6</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:54:35.7807314-07:00</UpdatedDateTime>
</Document>

Response object type : DocumentSummary

Response object type DocumentSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
Category DocumentCategorySummary
ConstituentId integer
Description string 30 N
FileName string 255 Y
FileSize integer
Id integer Y Non-updatable
NotesSummary string
UpdatedDateTime date N 
{
  "Id": 1,
  "FileName": "sample string 1",
  "UpdatedDateTime": "2025-04-24T04:54:35.7807314-07:00",
  "FileSize": 2,
  "NotesSummary": "sample string 3",
  "Category": {
    "Id": 1,
    "Description": "sample string 1",
    "ParentTableName": "sample string 2",
    "Inactive": true
  },
  "ConstituentId": 1,
  "Description": "sample string 4"
}
<DocumentSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ParentTableName>sample string 2</ParentTableName>
  </Category>
  <ConstituentId>1</ConstituentId>
  <Description>sample string 4</Description>
  <FileName>sample string 1</FileName>
  <FileSize>2</FileSize>
  <Id>1</Id>
  <NotesSummary>sample string 3</NotesSummary>
  <UpdatedDateTime>2025-04-24T04:54:35.7807314-07:00</UpdatedDateTime>
</DocumentSummary>
Change Version Description Contract Old New
Property Added 15.1.3 Category has been added to DocumentSummary DocumentSummary DocumentSummary.Category
Property Added 15.1.3 ConstituentId has been added to DocumentSummary DocumentSummary DocumentSummary.ConstituentId
Property Added 15.1.3 Description has been added to DocumentSummary DocumentSummary DocumentSummary.Description
Property Added 15.1.3 NotesSummary has been added to DocumentSummary DocumentSummary DocumentSummary.NotesSummary
Property Added 15.1.3 Category has been added to Document Document Document.Category
Property Added 15.1.3 ConstituentId has been added to Document Document Document.ConstituentId
Property Added 15.1.3 CreatedBy has been added to Document Document Document.CreatedBy
Property Added 15.1.3 CreatedDateTime has been added to Document Document Document.CreatedDateTime
Property Added 15.1.3 CreateLocation has been added to Document Document Document.CreateLocation
Property Added 15.1.3 Description has been added to Document Document Document.Description
Property Added 15.1.3 Notes has been added to Document Document Document.Notes
Property Added 15.1.3 UpdatedBy has been added to Document Document Document.UpdatedBy
Property Added 15.1.3 UpdatedDateTime has been added to Document Document Document.UpdatedDateTime
Property Added 15.0.0 FileSize has been added to DocumentSummary DocumentSummary DocumentSummary.FileSize