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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Uid":"00000000000000000000000000000000","Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Definition":{"ReportDefinitionID":0,"ReportDefinitionUID":"00000000000000000000000000000000","Name":"String","Folder":"String","Kind":"String","ChartType":"String","DefinitionJson":"String","IsShared":false,"IsSystem":false,"OwnerUserId":"String","IsMine":false,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}}