Trendsic Platform Service

<back to all web services

PmProjectDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/project/{Uid}
PmProjectDetailRequest Parameters:
NameParameterData TypeRequiredDescription
UidpathstringNo
PmProjectDetail Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
ProjectUIDformstringNo
NameformstringNo
ClientformstringNo
ProjectTypeformstringNo
StatusformstringNo
BranchformstringNo
StartDateformstringNo
EndDateformstringNo
DescriptionformstringNo
FinanceformPmFinanceNo
ReadinessformPmReadinessNo
JobsformList<PmJob>No
EquipmentformList<PmEquipmentRow>No
MaterialsformList<PmMaterialRow>No
CalendarformList<PmCalendarBar>No
ProjectStatusesformList<PmCatalogItem>No
ResponseStatusformResponseStatusNo
PmFinance Parameters:
NameParameterData TypeRequiredDescription
BudgetformdoubleNo
SpentformdoubleNo
EstimatedCostformdoubleNo
CrewCostformdoubleNo
EquipCostformdoubleNo
MatCostformdoubleNo
VarianceformdoubleNo
HealthPctformintNo
SpentPctformintNo
ProgressPctformintNo
PmReadiness Parameters:
NameParameterData TypeRequiredDescription
JobsNoCrewformintNo
OpenRolesformintNo
EquipmentConflictsformintNo
MaterialGapsformintNo
TotalGapsformintNo
ReadyPctformintNo
PmJob Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
NameformstringNo
DescriptionformstringNo
StatusformstringNo
StartDateformstringNo
EndDateformstringNo
CrewCountformintNo
BudgetedHoursformdoubleNo
EquipmentCountformintNo
MaterialCountformintNo
CrewCostformdoubleNo
EquipCostformdoubleNo
MatCostformdoubleNo
CostformdoubleNo
NoCrewformboolNo
EquipConflictformboolNo
MaterialGapformboolNo
ReadyPctformintNo
CrewformList<PmJobCrew>No
EquipmentformList<PmJobResource>No
MaterialsformList<PmJobResource>No
PmJobCrew Parameters:
NameParameterData TypeRequiredDescription
ContactIDformintNo
NameformstringNo
RateformdoubleNo
BudgetedHoursformdoubleNo
IsOpenformboolNo
PmJobResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
AmountformdoubleNo
QtyformintNo
PmEquipmentRow Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
NameformstringNo
EquipmentTypeformstringNo
SerialNumberformstringNo
UsedByJobsformstringNo
AvailableformboolNo
ConflictsformList<PmConflict>No
MaintenanceIntervalDaysformint?No
LastServiceDateformstringNo
NextServiceDateformstringNo
MaintenanceStateformstringNo
PmConflict Parameters:
NameParameterData TypeRequiredDescription
ProjectNameformstringNo
JobNameformstringNo
StartDateformstringNo
EndDateformstringNo
PmMaterialRow Parameters:
NameParameterData TypeRequiredDescription
MaterialIDformintNo
NameformstringNo
MaterialTypeformstringNo
OnHandformintNo
NeededByJobsformintNo
QtyNeededformintNo
ToOrderformintNo
UnitCostformdoubleNo
LineCostformdoubleNo
ProjectMaterialIDformintNo
StatusIDformintNo
StatusformstringNo
SupplierformstringNo
OrderDateformstringNo
DeliveryDateformstringNo
ShortfallformboolNo
PmCalendarBar Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
NameformstringNo
StartDateformstringNo
EndDateformstringNo
StatusformstringNo
PmCatalogItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
AmountformdoubleNo

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/pm/project/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ProjectID":0,"ProjectUID":"String","Name":"String","Client":"String","ProjectType":"String","Status":"String","Branch":"String","StartDate":"String","EndDate":"String","Description":"String","Finance":{"Budget":0,"Spent":0,"EstimatedCost":0,"CrewCost":0,"EquipCost":0,"MatCost":0,"Variance":0,"HealthPct":0,"SpentPct":0,"ProgressPct":0},"Readiness":{"JobsNoCrew":0,"OpenRoles":0,"EquipmentConflicts":0,"MaterialGaps":0,"TotalGaps":0,"ReadyPct":0},"Jobs":[{"JobID":0,"Name":"String","Description":"String","Status":"String","StartDate":"String","EndDate":"String","CrewCount":0,"BudgetedHours":0,"EquipmentCount":0,"MaterialCount":0,"CrewCost":0,"EquipCost":0,"MatCost":0,"Cost":0,"NoCrew":false,"EquipConflict":false,"MaterialGap":false,"ReadyPct":0,"Crew":[{"ContactID":0,"Name":"String","Rate":0,"BudgetedHours":0,"IsOpen":false}],"Equipment":[{"Id":0,"Name":"String","Amount":0,"Qty":0}],"Materials":[{"Id":0,"Name":"String","Amount":0,"Qty":0}]}],"Equipment":[{"EquipmentID":0,"Name":"String","EquipmentType":"String","SerialNumber":"String","UsedByJobs":"String","Available":false,"Conflicts":[{"ProjectName":"String","JobName":"String","StartDate":"String","EndDate":"String"}],"MaintenanceIntervalDays":0,"LastServiceDate":"String","NextServiceDate":"String","MaintenanceState":"String"}],"Materials":[{"MaterialID":0,"Name":"String","MaterialType":"String","OnHand":0,"NeededByJobs":0,"QtyNeeded":0,"ToOrder":0,"UnitCost":0,"LineCost":0,"ProjectMaterialID":0,"StatusID":0,"Status":"String","Supplier":"String","OrderDate":"String","DeliveryDate":"String","Shortfall":false}],"Calendar":[{"JobID":0,"Name":"String","StartDate":"String","EndDate":"String","Status":"String"}],"ProjectStatuses":[{"Id":0,"Name":"String","Amount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}