Trendsic Platform Service

<back to all web services

PmProjectsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/projects

export class PmProjectRow
{
    public ProjectID: number;
    public ProjectUID: string;
    public Name: string;
    public Client: string;
    public ProjectType: string;
    public Status: string;
    public Branch: string;
    public StartDate: string;
    public EndDate: string;
    public Budget: number;
    public Spent: number;
    public EstimatedCost: number;
    public HealthPct: number;
    public JobCount: number;
    public OpenJobs: number;
    public GapCount: number;
    public OverBudget: boolean;
    public ProgressPct: number;

    public constructor(init?: Partial<PmProjectRow>) { (Object as any).assign(this, init); }
}

export class PmPortfolioTotals
{
    public Projects: number;
    public Budget: number;
    public Spent: number;
    public OverBudget: number;
    public WithGaps: number;

    public constructor(init?: Partial<PmPortfolioTotals>) { (Object as any).assign(this, init); }
}

export class PmProjectsResponse
{
    public Projects: PmProjectRow[] = [];
    public Totals: PmPortfolioTotals;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PmProjectsResponse>) { (Object as any).assign(this, init); }
}

export class PmProjectsRequest
{
    public Search: string;

    public constructor(init?: Partial<PmProjectsRequest>) { (Object as any).assign(this, init); }
}

TypeScript PmProjectsRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Projects: 
	[
		{
			ProjectID: 0,
			ProjectUID: String,
			Name: String,
			Client: String,
			ProjectType: String,
			Status: String,
			Branch: String,
			StartDate: String,
			EndDate: String,
			Budget: 0,
			Spent: 0,
			EstimatedCost: 0,
			HealthPct: 0,
			JobCount: 0,
			OpenJobs: 0,
			GapCount: 0,
			OverBudget: False,
			ProgressPct: 0
		}
	],
	Totals: 
	{
		Projects: 0,
		Budget: 0,
		Spent: 0,
		OverBudget: 0,
		WithGaps: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}