PUT api/report/{id}

Save report

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Saved report identifier	globally unique identifier	Required

Body Parameters

report to be saved

SavedReport

Name	Description	Type	Additional information
ID		globally unique identifier	None.
Name	User-specified saved report name	string	Required
Report	Internal report identifier (Used to load the template and report data)	string	Required
MailTo	Mail addresses for scheduled report	string	None.
MailFileFormats	Attachment file formats for scheduled report	string	None.
VisibleToAll	If set to true, all Users for a Customer may view this report	boolean	None.
Parameters		Collection of SavedReportParameter	None.
User		string	None.
UserAccountID		globally unique identifier	None.
Owned		boolean	None.
ScheduledTask		ScheduledTask	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "c80ab0b5-1e77-4adc-9fcf-f7a8da3b27b6",
  "name": "sample string 2",
  "report": "sample string 3",
  "mailTo": "sample string 4",
  "mailFileFormats": "sample string 5",
  "visibleToAll": true,
  "parameters": [
    {
      "$id": "2",
      "key": "sample string 1",
      "value": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "user": "sample string 7",
  "userAccountID": "80db9654-b4e1-4c66-ab30-b873e952d347",
  "owned": true,
  "scheduledTask": {
    "$id": "3",
    "id": "e386ce61-ea20-4c20-ac79-161aa8cec9f6",
    "accountID": "e3d99185-f33d-4f35-8504-61dda56ee113",
    "data": {
      "$id": "4",
      "sample string 1": {
        "$id": "5"
      },
      "sample string 3": {
        "$id": "6"
      }
    },
    "dataBytes": "QEA=",
    "dataFormat": 1,
    "dataCompression": 1,
    "scheduleType": 0,
    "cronExpression": "sample string 3",
    "cronExpressionDescription": "sample string 4",
    "starts": "2025-06-14T06:16:03.6243132",
    "task": "sample string 5",
    "description": "sample string 6",
    "lastRun": "2025-06-14T06:16:03.6243132",
    "created": "2025-06-14T06:16:03.6243132",
    "registered": true,
    "default": true,
    "account": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<SavedReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Tenancies">
  <ID>c80ab0b5-1e77-4adc-9fcf-f7a8da3b27b6</ID>
  <MailFileFormats>sample string 5</MailFileFormats>
  <MailTo>sample string 4</MailTo>
  <Name>sample string 2</Name>
  <Owned>true</Owned>
  <Parameters>
    <SavedReportParameter>
      <_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
    </SavedReportParameter>
    <SavedReportParameter>
      <_x003C_Key_x003E_k__BackingField>sample string 1</_x003C_Key_x003E_k__BackingField>
      <_x003C_Value_x003E_k__BackingField>sample string 2</_x003C_Value_x003E_k__BackingField>
    </SavedReportParameter>
  </Parameters>
  <Report>sample string 3</Report>
  <ScheduledTask xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.ScheduledTasks">
    <d2p1:Account>sample string 10</d2p1:Account>
    <d2p1:AccountID>e3d99185-f33d-4f35-8504-61dda56ee113</d2p1:AccountID>
    <d2p1:Created>2025-06-14T06:16:03.6243132+00:00</d2p1:Created>
    <d2p1:CronExpression>sample string 3</d2p1:CronExpression>
    <d2p1:CronExpressionDescription>sample string 4</d2p1:CronExpressionDescription>
    <d2p1:Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </d2p1:Data>
    <d2p1:DataBytes>QEA=</d2p1:DataBytes>
    <d2p1:DataCompression>1</d2p1:DataCompression>
    <d2p1:DataFormat>1</d2p1:DataFormat>
    <d2p1:Default>true</d2p1:Default>
    <d2p1:Description>sample string 6</d2p1:Description>
    <d2p1:ID>e386ce61-ea20-4c20-ac79-161aa8cec9f6</d2p1:ID>
    <d2p1:LastRun>2025-06-14T06:16:03.6243132+00:00</d2p1:LastRun>
    <d2p1:Registered>true</d2p1:Registered>
    <d2p1:ScheduleType>Cron</d2p1:ScheduleType>
    <d2p1:Starts>2025-06-14T06:16:03.6243132+00:00</d2p1:Starts>
    <d2p1:Task>sample string 5</d2p1:Task>
    <d2p1:TimeZone xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
  </ScheduledTask>
  <User>sample string 7</User>
  <UserAccountID>80db9654-b4e1-4c66-ab30-b873e952d347</UserAccountID>
  <VisibleToAll>true</VisibleToAll>
</SavedReport>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Saved report identifier

None.