ReportRequests Test
Reporting/ReportRequests
Creates the report request.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Reporting/ReportRequests

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ReportRequest

Request object type ReportRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
DeletedIndicator boolean N Indicates that underlying scheduled report data has been deleted.
EmailBody string N Text body of email for request. Only used for scheduled requests to be emailed.
EmailRecipients string N Email TO: field for emailed requests. Only used for scheduled requests to be emailed.
EmailSubject string N Subject line for emailed requests. Only used for scheduled requests to be emailed.
EndDateTime date N When processing of request ended. Difference between RequestDateTime and EndDateTime should not be relied on for analyzing processing time.
Id integer N
OutputOption string N String defining additional output options, whether file is saved to standard file location, emailed, and in what format (PDF, Excel, etc).
Parameters Collection of ReportRequestParameter
PublicIndicator boolean N True means that this request is viewable within the schedule's control group. By default scheduled requests are private to the user who owns the schedule.
QueueStatus string N Only used for scheduled report requests. 's' = Scheduled, 'r' = Running, 'e' = Error, 'c' = Complete
ReportId string Y Reference to the Report.Id for this request.
ReportType integer Y Reference to the Report.ReportType for this request.
RequestDateTime date Y Either the time it was run, or the date/time it is scheduled to run.
ResultCode string N Generated from Processing Service for scheduled requests. 'c' = Complete, 'e' = Error, 't' = User cancelled.
ResultText string N Most often provides clarification on an error or why the request failed.
ScheduleId integer N If value is provided, this points to the ReportSchedule from which it was generated. A Report Schedule's header row (template request) does not point back to its schedule.
Type string Y 'f' for a foreground (in app) request. 'b' for a background (new window) request. 's' for a scheduled request (run by Processing Service). 'h' is Report Schedule template/header request.
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned
UserGroupId string Y UserGroup who created the request.
UserId string 8 Y UserId who created the request. 
{
  "Id": 1,
  "DeletedIndicator": true,
  "EmailBody": "sample string 3",
  "EmailRecipients": "sample string 4",
  "EmailSubject": "sample string 5",
  "EndDateTime": "2025-04-24T04:30:20.5303447-07:00",
  "OutputOption": "sample string 6",
  "PublicIndicator": true,
  "ReportId": "sample string 8",
  "ReportType": 9,
  "RequestDateTime": "2025-04-24T04:30:20.5303447-07:00",
  "ResultCode": "sample string 11",
  "ResultText": "sample string 12",
  "Type": "sample string 13",
  "QueueStatus": "sample string 14",
  "ScheduleId": 1,
  "UserGroupId": "sample string 15",
  "UserId": "sample string 16",
  "CreatedDateTime": "2025-04-24T04:30:20.5303447-07:00",
  "CreateLocation": "sample string 17",
  "CreatedBy": "sample string 18",
  "UpdatedDateTime": "2025-04-24T04:30:20.5303447-07:00",
  "UpdatedBy": "sample string 19",
  "Parameters": [
    {
      "RequestId": 1,
      "ReportId": "sample string 1",
      "ParameterId": 2,
      "Value": "sample string 3"
    },
    {
      "RequestId": 1,
      "ReportId": "sample string 1",
      "ParameterId": 2,
      "Value": "sample string 3"
    }
  ]
}
<ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CreateLocation>sample string 17</CreateLocation>
  <CreatedBy>sample string 18</CreatedBy>
  <CreatedDateTime>2025-04-24T04:30:20.5303447-07:00</CreatedDateTime>
  <DeletedIndicator>true</DeletedIndicator>
  <EmailBody>sample string 3</EmailBody>
  <EmailRecipients>sample string 4</EmailRecipients>
  <EmailSubject>sample string 5</EmailSubject>
  <EndDateTime>2025-04-24T04:30:20.5303447-07:00</EndDateTime>
  <Id>1</Id>
  <OutputOption>sample string 6</OutputOption>
  <Parameters>
    <ReportRequestParameter>
      <ParameterId>2</ParameterId>
      <ReportId>sample string 1</ReportId>
      <RequestId>1</RequestId>
      <Value>sample string 3</Value>
    </ReportRequestParameter>
    <ReportRequestParameter>
      <ParameterId>2</ParameterId>
      <ReportId>sample string 1</ReportId>
      <RequestId>1</RequestId>
      <Value>sample string 3</Value>
    </ReportRequestParameter>
  </Parameters>
  <PublicIndicator>true</PublicIndicator>
  <QueueStatus>sample string 14</QueueStatus>
  <ReportId>sample string 8</ReportId>
  <ReportType>9</ReportType>
  <RequestDateTime>2025-04-24T04:30:20.5303447-07:00</RequestDateTime>
  <ResultCode>sample string 11</ResultCode>
  <ResultText>sample string 12</ResultText>
  <ScheduleId>1</ScheduleId>
  <Type>sample string 13</Type>
  <UpdatedBy>sample string 19</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:30:20.5303447-07:00</UpdatedDateTime>
  <UserGroupId>sample string 15</UserGroupId>
  <UserId>sample string 16</UserId>
</ReportRequest>

Response object type : ReportRequest

Response object type ReportRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
DeletedIndicator boolean N Indicates that underlying scheduled report data has been deleted.
EmailBody string N Text body of email for request. Only used for scheduled requests to be emailed.
EmailRecipients string N Email TO: field for emailed requests. Only used for scheduled requests to be emailed.
EmailSubject string N Subject line for emailed requests. Only used for scheduled requests to be emailed.
EndDateTime date N When processing of request ended. Difference between RequestDateTime and EndDateTime should not be relied on for analyzing processing time.
Id integer N
OutputOption string N String defining additional output options, whether file is saved to standard file location, emailed, and in what format (PDF, Excel, etc).
Parameters Collection of ReportRequestParameter
PublicIndicator boolean N True means that this request is viewable within the schedule's control group. By default scheduled requests are private to the user who owns the schedule.
QueueStatus string N Only used for scheduled report requests. 's' = Scheduled, 'r' = Running, 'e' = Error, 'c' = Complete
ReportId string Y Reference to the Report.Id for this request.
ReportType integer Y Reference to the Report.ReportType for this request.
RequestDateTime date Y Either the time it was run, or the date/time it is scheduled to run.
ResultCode string N Generated from Processing Service for scheduled requests. 'c' = Complete, 'e' = Error, 't' = User cancelled.
ResultText string N Most often provides clarification on an error or why the request failed.
ScheduleId integer N If value is provided, this points to the ReportSchedule from which it was generated. A Report Schedule's header row (template request) does not point back to its schedule.
Type string Y 'f' for a foreground (in app) request. 'b' for a background (new window) request. 's' for a scheduled request (run by Processing Service). 'h' is Report Schedule template/header request.
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned
UserGroupId string Y UserGroup who created the request.
UserId string 8 Y UserId who created the request. 
{
  "Id": 1,
  "DeletedIndicator": true,
  "EmailBody": "sample string 3",
  "EmailRecipients": "sample string 4",
  "EmailSubject": "sample string 5",
  "EndDateTime": "2025-04-24T04:30:20.5459757-07:00",
  "OutputOption": "sample string 6",
  "PublicIndicator": true,
  "ReportId": "sample string 8",
  "ReportType": 9,
  "RequestDateTime": "2025-04-24T04:30:20.5459757-07:00",
  "ResultCode": "sample string 11",
  "ResultText": "sample string 12",
  "Type": "sample string 13",
  "QueueStatus": "sample string 14",
  "ScheduleId": 1,
  "UserGroupId": "sample string 15",
  "UserId": "sample string 16",
  "CreatedDateTime": "2025-04-24T04:30:20.5459757-07:00",
  "CreateLocation": "sample string 17",
  "CreatedBy": "sample string 18",
  "UpdatedDateTime": "2025-04-24T04:30:20.5459757-07:00",
  "UpdatedBy": "sample string 19",
  "Parameters": [
    {
      "RequestId": 1,
      "ReportId": "sample string 1",
      "ParameterId": 2,
      "Value": "sample string 3"
    },
    {
      "RequestId": 1,
      "ReportId": "sample string 1",
      "ParameterId": 2,
      "Value": "sample string 3"
    }
  ]
}
<ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CreateLocation>sample string 17</CreateLocation>
  <CreatedBy>sample string 18</CreatedBy>
  <CreatedDateTime>2025-04-24T04:30:20.5459757-07:00</CreatedDateTime>
  <DeletedIndicator>true</DeletedIndicator>
  <EmailBody>sample string 3</EmailBody>
  <EmailRecipients>sample string 4</EmailRecipients>
  <EmailSubject>sample string 5</EmailSubject>
  <EndDateTime>2025-04-24T04:30:20.5459757-07:00</EndDateTime>
  <Id>1</Id>
  <OutputOption>sample string 6</OutputOption>
  <Parameters>
    <ReportRequestParameter>
      <ParameterId>2</ParameterId>
      <ReportId>sample string 1</ReportId>
      <RequestId>1</RequestId>
      <Value>sample string 3</Value>
    </ReportRequestParameter>
    <ReportRequestParameter>
      <ParameterId>2</ParameterId>
      <ReportId>sample string 1</ReportId>
      <RequestId>1</RequestId>
      <Value>sample string 3</Value>
    </ReportRequestParameter>
  </Parameters>
  <PublicIndicator>true</PublicIndicator>
  <QueueStatus>sample string 14</QueueStatus>
  <ReportId>sample string 8</ReportId>
  <ReportType>9</ReportType>
  <RequestDateTime>2025-04-24T04:30:20.5459757-07:00</RequestDateTime>
  <ResultCode>sample string 11</ResultCode>
  <ResultText>sample string 12</ResultText>
  <ScheduleId>1</ScheduleId>
  <Type>sample string 13</Type>
  <UpdatedBy>sample string 19</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:30:20.5459757-07:00</UpdatedDateTime>
  <UserGroupId>sample string 15</UserGroupId>
  <UserId>sample string 16</UserId>
</ReportRequest>
Change Version Description Contract Old New
Property Added 15.1.0 ReportType has been added to ReportRequest ReportRequest ReportRequest.ReportType
Property Added 15.1.0 ReportType has been added to ReportRequest ReportRequest ReportRequest.ReportType