Trendsic Platform Service

<back to all web services

ProjectTimelineRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/project/{ProjectID}/timeline
"use strict";
export class TimelineCrew {
    /** @param {{ProjectJobCrewMemberID?:number,ContactID?:number,ContactName?:string,BudgetedHours?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectJobCrewMemberID;
    /** @type {number} */
    ContactID;
    /** @type {string} */
    ContactName;
    /** @type {?number} */
    BudgetedHours;
}
export class TimelineEquipment {
    /** @param {{ProjectJobEquipmentID?:number,EquipmentID?:number,EquipmentName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectJobEquipmentID;
    /** @type {number} */
    EquipmentID;
    /** @type {string} */
    EquipmentName;
}
export class TimelineJob {
    /** @param {{JobID?:number,JobName?:string,ExpectedStartDate?:string,ExpectedCompletionDate?:string,ActualStartDate?:string,ActualEndDate?:string,PercentComplete?:number,StatusID?:number,JobCategory?:string,IsAgreementVisit?:boolean,OccurrenceDate?:string,Crew?:TimelineCrew[],Equipment?:TimelineEquipment[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    JobID;
    /** @type {string} */
    JobName;
    /** @type {?string} */
    ExpectedStartDate;
    /** @type {?string} */
    ExpectedCompletionDate;
    /** @type {?string} */
    ActualStartDate;
    /** @type {?string} */
    ActualEndDate;
    /** @type {number} */
    PercentComplete;
    /** @type {?number} */
    StatusID;
    /** @type {string} */
    JobCategory;
    /** @type {boolean} */
    IsAgreementVisit;
    /** @type {?string} */
    OccurrenceDate;
    /** @type {TimelineCrew[]} */
    Crew = [];
    /** @type {TimelineEquipment[]} */
    Equipment = [];
}
export class JobDependency {
    /** @param {{JobDependencyID?:number,TenantId?:string,ProjectID?:number,PredecessorJobID?:number,SuccessorJobID?:number,DependencyType?:string,LagDays?:number,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    JobDependencyID;
    /** @type {string} */
    TenantId;
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    PredecessorJobID;
    /** @type {number} */
    SuccessorJobID;
    /** @type {string} */
    DependencyType;
    /** @type {number} */
    LagDays;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ProjectTimeline {
    /** @param {{ProjectID?:number,Jobs?:TimelineJob[],Dependencies?:JobDependency[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {TimelineJob[]} */
    Jobs = [];
    /** @type {JobDependency[]} */
    Dependencies = [];
}
export class ProjectTimelineResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Timeline?:ProjectTimeline}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ProjectTimeline} */
    Timeline;
}
export class ProjectTimelineRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript ProjectTimelineRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/project/{ProjectID}/timeline HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Timeline":{"ProjectID":0,"Jobs":[{"JobID":0,"JobName":"String","ExpectedStartDate":"0001-01-01T00:00:00.0000000","ExpectedCompletionDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","PercentComplete":0,"StatusID":0,"JobCategory":"String","IsAgreementVisit":false,"OccurrenceDate":"0001-01-01T00:00:00.0000000","Crew":[{"ProjectJobCrewMemberID":0,"ContactID":0,"ContactName":"String","BudgetedHours":0}],"Equipment":[{"ProjectJobEquipmentID":0,"EquipmentID":0,"EquipmentName":"String"}]}],"Dependencies":[{"JobDependencyID":0,"TenantId":"00000000000000000000000000000000","ProjectID":0,"PredecessorJobID":0,"SuccessorJobID":0,"DependencyType":"String","LagDays":0,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}]}}