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}
"use strict";
export class SavedReportDefinition {
    /** @param {{ReportDefinitionID?:number,ReportDefinitionUID?:string,Name?:string,Folder?:string,Kind?:string,ChartType?:string,DefinitionJson?:string,IsShared?:boolean,IsSystem?:boolean,OwnerUserId?:string,IsMine?:boolean,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ReportDefinitionID;
    /** @type {string} */
    ReportDefinitionUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Folder;
    /** @type {string} */
    Kind;
    /** @type {string} */
    ChartType;
    /** @type {string} */
    DefinitionJson;
    /** @type {boolean} */
    IsShared;
    /** @type {boolean} */
    IsSystem;
    /** @type {string} */
    OwnerUserId;
    /** @type {boolean} */
    IsMine;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ReportDefinitionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Definition?:SavedReportDefinition}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SavedReportDefinition} */
    Definition;
}
export class ReportDefinitionUpdateRequest {
    /** @param {{Uid?:string,Name?:string,Folder?:string,Kind?:string,ChartType?:string,DefinitionJson?:string,IsShared?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Uid;
    /** @type {string} */
    Name;
    /** @type {string} */
    Folder;
    /** @type {string} */
    Kind;
    /** @type {string} */
    ChartType;
    /** @type {string} */
    DefinitionJson;
    /** @type {boolean} */
    IsShared;
}

JavaScript 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>