Trendsic Platform Service

<back to all web services

ReportDefinitionVersionCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/definitions/{Uid}/versions
"use strict";
export class ReportDefinitionVersion {
    /** @param {{Id?:number,ReportDefinitionID?:number,VersionNumber?:number,DefinitionJson?:string,Status?:string,Note?:string,CreatedBy?:string,CreatedAt?:string,IsMine?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    ReportDefinitionID;
    /** @type {number} */
    VersionNumber;
    /** @type {string} */
    DefinitionJson;
    /** @type {string} */
    Status;
    /** @type {string} */
    Note;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {boolean} */
    IsMine;
}
export class ReportDefinitionVersionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Version?:ReportDefinitionVersion}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ReportDefinitionVersion} */
    Version;
}
export class ReportDefinitionVersionCreateRequest {
    /** @param {{Uid?:string,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Uid;
    /** @type {string} */
    Note;
}

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

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

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

<ReportDefinitionVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Version>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DefinitionJson>String</DefinitionJson>
    <Id>0</Id>
    <IsMine>false</IsMine>
    <Note>String</Note>
    <ReportDefinitionID>0</ReportDefinitionID>
    <Status>String</Status>
    <VersionNumber>0</VersionNumber>
  </Version>
</ReportDefinitionVersionResponse>