| Requires any of the roles: | Agent, Administrator |
| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ProjectTimelineResponse 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>
<Timeline>
<Dependencies>
<JobDependency>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<DependencyType>String</DependencyType>
<JobDependencyID>0</JobDependencyID>
<LagDays>0</LagDays>
<PredecessorJobID>0</PredecessorJobID>
<ProjectID>0</ProjectID>
<SuccessorJobID>0</SuccessorJobID>
<TenantId>00000000-0000-0000-0000-000000000000</TenantId>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</JobDependency>
</Dependencies>
<Jobs>
<TimelineJob>
<ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
<ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
<Crew>
<TimelineCrew>
<BudgetedHours>0</BudgetedHours>
<ContactID>0</ContactID>
<ContactName>String</ContactName>
<ProjectJobCrewMemberID>0</ProjectJobCrewMemberID>
</TimelineCrew>
</Crew>
<Equipment>
<TimelineEquipment>
<EquipmentID>0</EquipmentID>
<EquipmentName>String</EquipmentName>
<ProjectJobEquipmentID>0</ProjectJobEquipmentID>
</TimelineEquipment>
</Equipment>
<ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
<ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
<IsAgreementVisit>false</IsAgreementVisit>
<JobCategory>String</JobCategory>
<JobID>0</JobID>
<JobName>String</JobName>
<OccurrenceDate>0001-01-01T00:00:00</OccurrenceDate>
<PercentComplete>0</PercentComplete>
<StatusID>0</StatusID>
</TimelineJob>
</Jobs>
<ProjectID>0</ProjectID>
</Timeline>
</ProjectTimelineResponse>