Trendsic Platform Service

<back to all web services

PmProjectsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/projects
"use strict";
export class PmProjectRow {
    /** @param {{ProjectID?:number,ProjectUID?:string,Name?:string,Client?:string,ProjectType?:string,Status?:string,Branch?:string,StartDate?:string,EndDate?:string,Budget?:number,Spent?:number,EstimatedCost?:number,HealthPct?:number,JobCount?:number,OpenJobs?:number,GapCount?:number,OverBudget?:boolean,ProgressPct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Client;
    /** @type {string} */
    ProjectType;
    /** @type {string} */
    Status;
    /** @type {string} */
    Branch;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {number} */
    Budget;
    /** @type {number} */
    Spent;
    /** @type {number} */
    EstimatedCost;
    /** @type {number} */
    HealthPct;
    /** @type {number} */
    JobCount;
    /** @type {number} */
    OpenJobs;
    /** @type {number} */
    GapCount;
    /** @type {boolean} */
    OverBudget;
    /** @type {number} */
    ProgressPct;
}
export class PmPortfolioTotals {
    /** @param {{Projects?:number,Budget?:number,Spent?:number,OverBudget?:number,WithGaps?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Projects;
    /** @type {number} */
    Budget;
    /** @type {number} */
    Spent;
    /** @type {number} */
    OverBudget;
    /** @type {number} */
    WithGaps;
}
export class PmProjectsResponse {
    /** @param {{Projects?:PmProjectRow[],Totals?:PmPortfolioTotals,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {PmProjectRow[]} */
    Projects = [];
    /** @type {PmPortfolioTotals} */
    Totals;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PmProjectsRequest {
    /** @param {{Search?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Search;
}

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

GET /v1/pm/projects HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PmProjectsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Projects>
    <PmProjectRow>
      <Branch>String</Branch>
      <Budget>0</Budget>
      <Client>String</Client>
      <EndDate>String</EndDate>
      <EstimatedCost>0</EstimatedCost>
      <GapCount>0</GapCount>
      <HealthPct>0</HealthPct>
      <JobCount>0</JobCount>
      <Name>String</Name>
      <OpenJobs>0</OpenJobs>
      <OverBudget>false</OverBudget>
      <ProgressPct>0</ProgressPct>
      <ProjectID>0</ProjectID>
      <ProjectType>String</ProjectType>
      <ProjectUID>String</ProjectUID>
      <Spent>0</Spent>
      <StartDate>String</StartDate>
      <Status>String</Status>
    </PmProjectRow>
  </Projects>
  <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>
  <Totals>
    <Budget>0</Budget>
    <OverBudget>0</OverBudget>
    <Projects>0</Projects>
    <Spent>0</Spent>
    <WithGaps>0</WithGaps>
  </Totals>
</PmProjectsResponse>