Trendsic Platform Service

<back to all web services

ReportDefinitionUpdateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/report/definitions/{Uid}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportDefinitionUpdateRequest
    {
        public UUID Uid = null;
        public String Name = null;
        public String Folder = null;
        public String Kind = null;
        public String ChartType = null;
        public String DefinitionJson = null;
        public Boolean IsShared = null;
        
        public UUID getUid() { return Uid; }
        public ReportDefinitionUpdateRequest setUid(UUID value) { this.Uid = value; return this; }
        public String getName() { return Name; }
        public ReportDefinitionUpdateRequest setName(String value) { this.Name = value; return this; }
        public String getFolder() { return Folder; }
        public ReportDefinitionUpdateRequest setFolder(String value) { this.Folder = value; return this; }
        public String getKind() { return Kind; }
        public ReportDefinitionUpdateRequest setKind(String value) { this.Kind = value; return this; }
        public String getChartType() { return ChartType; }
        public ReportDefinitionUpdateRequest setChartType(String value) { this.ChartType = value; return this; }
        public String getDefinitionJson() { return DefinitionJson; }
        public ReportDefinitionUpdateRequest setDefinitionJson(String value) { this.DefinitionJson = value; return this; }
        public Boolean getIsShared() { return IsShared; }
        public ReportDefinitionUpdateRequest setIsShared(Boolean value) { this.IsShared = value; return this; }
    }

    public static class ReportDefinitionResponse
    {
        public ResponseStatus ResponseStatus = null;
        public SavedReportDefinition Definition = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReportDefinitionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public SavedReportDefinition getDefinition() { return Definition; }
        public ReportDefinitionResponse setDefinition(SavedReportDefinition value) { this.Definition = value; return this; }
    }

    public static class SavedReportDefinition
    {
        public Integer ReportDefinitionID = null;
        public UUID ReportDefinitionUID = null;
        public String Name = null;
        public String Folder = null;
        public String Kind = null;
        public String ChartType = null;
        public String DefinitionJson = null;
        public Boolean IsShared = null;
        public Boolean IsSystem = null;
        public String OwnerUserId = null;
        public Boolean IsMine = null;
        public Date CreatedAt = null;
        public Date UpdatedAt = null;
        
        public Integer getReportDefinitionID() { return ReportDefinitionID; }
        public SavedReportDefinition setReportDefinitionID(Integer value) { this.ReportDefinitionID = value; return this; }
        public UUID getReportDefinitionUID() { return ReportDefinitionUID; }
        public SavedReportDefinition setReportDefinitionUID(UUID value) { this.ReportDefinitionUID = value; return this; }
        public String getName() { return Name; }
        public SavedReportDefinition setName(String value) { this.Name = value; return this; }
        public String getFolder() { return Folder; }
        public SavedReportDefinition setFolder(String value) { this.Folder = value; return this; }
        public String getKind() { return Kind; }
        public SavedReportDefinition setKind(String value) { this.Kind = value; return this; }
        public String getChartType() { return ChartType; }
        public SavedReportDefinition setChartType(String value) { this.ChartType = value; return this; }
        public String getDefinitionJson() { return DefinitionJson; }
        public SavedReportDefinition setDefinitionJson(String value) { this.DefinitionJson = value; return this; }
        public Boolean getIsShared() { return IsShared; }
        public SavedReportDefinition setIsShared(Boolean value) { this.IsShared = value; return this; }
        public Boolean getIsSystem() { return IsSystem; }
        public SavedReportDefinition setIsSystem(Boolean value) { this.IsSystem = value; return this; }
        public String getOwnerUserId() { return OwnerUserId; }
        public SavedReportDefinition setOwnerUserId(String value) { this.OwnerUserId = value; return this; }
        public Boolean getIsMine() { return IsMine; }
        public SavedReportDefinition setIsMine(Boolean value) { this.IsMine = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public SavedReportDefinition setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getUpdatedAt() { return UpdatedAt; }
        public SavedReportDefinition setUpdatedAt(Date value) { this.UpdatedAt = value; return this; }
    }

}

Java ReportDefinitionUpdateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/report/definitions/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReportDefinitionUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChartType>String</ChartType>
  <DefinitionJson>String</DefinitionJson>
  <Folder>String</Folder>
  <IsShared>false</IsShared>
  <Kind>String</Kind>
  <Name>String</Name>
  <Uid>00000000-0000-0000-0000-000000000000</Uid>
</ReportDefinitionUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportDefinitionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Definition>
    <ChartType>String</ChartType>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <DefinitionJson>String</DefinitionJson>
    <Folder>String</Folder>
    <IsMine>false</IsMine>
    <IsShared>false</IsShared>
    <IsSystem>false</IsSystem>
    <Kind>String</Kind>
    <Name>String</Name>
    <OwnerUserId>String</OwnerUserId>
    <ReportDefinitionID>0</ReportDefinitionID>
    <ReportDefinitionUID>00000000-0000-0000-0000-000000000000</ReportDefinitionUID>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </Definition>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ReportDefinitionResponse>