GET api/Projects?search={search}&lifeCylce={lifeCylce}&withTasks={withTasks}&userDefinedCustomers={userDefinedCustomers}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
search | string |
None. |
|
lifeCylce | integer |
Default value is 6 |
|
withTasks | boolean |
Default value is True |
|
userDefinedCustomers | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of ReportProjectDtoName | Description | Type | Additional information |
---|---|---|---|
Customer | ReportCustomerDto |
None. |
|
ProjectCustomerId | globally unique identifier |
None. |
|
ReportingDate | date |
None. |
|
ProjectId | globally unique identifier |
None. |
|
ParentProjectId | globally unique identifier |
None. |
|
ProjectOwnerId | globally unique identifier |
None. |
|
ProjectOwner | string |
None. |
|
Currency | string |
None. |
|
ProjectPricePerHour | decimal number |
None. |
|
Vat | decimal number |
None. |
|
TextColor | integer |
None. |
|
BackgroundColor | integer |
None. |
|
ProjectName | string |
None. |
|
ProjectDescription | string |
None. |
|
ProjectLifeCycle | ProjectLifeCycle |
None. |
|
IsProjectTimeLimited | boolean |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
TaskList | Collection of ReportTaskDto |
None. |
|
ProjectAvailability | ProjectAvailability |
None. |
|
UserRelations | Collection of ReportProjectUserDto |
None. |
|
ProjectMaxWorkingTime | decimal number |
None. |
|
IsProjectMaxWorkingTimeExceedable | boolean |
None. |
|
RoundPrecisionInMinutes | integer |
None. |
|
Rounding | Rounding |
None. |
|
YellowTrafficLight | decimal number |
None. |
|
RedTrafficLight | decimal number |
None. |
|
ProjectChargingJourneyTime | decimal number |
None. |
|
ManualProjectState | ProjectState |
None. |
|
ProjectStateDescription | string |
None. |
|
DontInheritCommonTasks | boolean |
None. |
|
IsOrderBased | boolean |
None. |
|
Account | string |
None. |
|
CostCenter | string |
None. |
|
OrderType | OrderType |
None. |
|
ContractId | string |
None. |
|
PlaceOfServiceProvision | string |
None. |
|
IsProjectTimeSet | boolean |
None. |
|
SharedPool | decimal number |
None. |
|
PrivatePool | decimal number |
None. |
|
ScheduledWork | decimal number |
None. |
|
HoursWorked | decimal number |
None. |
|
AvailableWork | decimal number |
None. |
|
FurtherAccountingDetails | string |
None. |
|
ProjectCode | string |
None. |
|
IsProjectInCoverage | boolean |
None. |
|
DefaultTask | ReportTaskDto |
None. |
|
IsDescriptionMandatory | boolean |
None. |
|
ShowAccountingDetails | boolean |
None. |
|
CreatedBy | globally unique identifier |
None. |
|
Created | date |
None. |
|
LastUpdateBy | globally unique identifier |
None. |
|
LastUpdate | date |
None. |
|
CreatedByUser | string |
None. |
|
LastUpdateByUser | string |
None. |
|
Id | globally unique identifier |
None. |
|
IsNew | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ null, { "$id": "1", "Customer": null, "ProjectCustomerId": "e9c49ff3-e33d-4786-bd31-fae468eb4a90", "ReportingDate": "2025-09-17T22:45:48.7444122+02:00", "ProjectId": "55760f76-dce7-423c-8f8d-0b6620a499de", "ParentProjectId": "b5725f62-d59a-4f41-94ea-6c4acb246fd6", "ProjectOwnerId": "abee7a55-6003-4698-aa94-9ae0097de297", "Currency": "sample string 5", "ProjectPricePerHour": 6.1, "Vat": 7.1, "TextColor": 8, "BackgroundColor": 9, "ProjectName": "sample string 10", "ProjectDescription": "sample string 11", "ProjectLifeCycle": 0, "IsProjectTimeLimited": true, "StartDate": "2025-09-17T22:45:48.7444122+02:00", "EndDate": "2025-09-17T22:45:48.7444122+02:00", "TaskList": [ null, { "$id": "2", "ProjectId": "d109989e-f259-4538-8489-eb33db89b471", "TaskId": "74c4378d-d1c8-4d33-8eb0-af5122752178", "TaskNameId": "sample string 3", "TaskDescription": "sample string 4", "Usage": 0, "CostFactor": 5.1, "TaskCode": "sample string 6", "CreatedBy": "b76a079d-cb1a-4081-b3bf-87e50c8d30dd", "Created": "2025-09-17T22:45:48.7444122+02:00", "LastUpdateBy": "34824fd0-9356-4987-8dc8-b0c735a5520a", "LastUpdate": "2025-09-17T22:45:48.7444122+02:00", "CreatedByUser": "sample string 15", "LastUpdateByUser": "sample string 16", "Id": "6a1f8076-c26d-42e1-962e-244337b0b58d", "IsNew": true, "WorktimeFactor": 7.1, "WorkTypeNo": "sample string 8", "OtherTypeNo": "sample string 9", "WorkTimeRestriction": 0, "MaxTaskWorkingTimePerDay": 1.1, "TaskLifeCycle": 0, "TaskBackgroundColor": 10 } ], "ProjectAvailability": 0, "UserRelations": [ null, { "$id": "3", "UserProjectId": "dfeafb32-0bb3-400c-a94a-115903bd2670", "ProjectUserId": "532d62e0-a281-41b3-b611-865713cb0c47", "IsAllowedToUseProject": true, "UserPricePerHour": 1.1, "UserMaxWorkingTime": 1.1, "UserCustomerId": "be2aaabf-be2b-4687-a391-a41d9b8edc67", "UserChargingJourneyTime": 1.1, "CreatedBy": "fb38dadc-ad36-4a46-b91b-0a03ce5c77b2", "Created": "2025-09-17T22:45:48.7444122+02:00", "LastUpdateBy": "89f716a8-6de9-4dfe-8ec2-d4b1b72a7ffc", "LastUpdate": "2025-09-17T22:45:48.7444122+02:00", "CreatedByUser": "sample string 7", "LastUpdateByUser": "sample string 8", "Id": "73adb894-140c-4cad-8bda-f6566dde49a0", "IsNew": true } ], "ProjectMaxWorkingTime": 1.1, "IsProjectMaxWorkingTimeExceedable": true, "RoundPrecisionInMinutes": 14, "Rounding": 0, "YellowTrafficLight": 15.1, "RedTrafficLight": 16.1, "ProjectChargingJourneyTime": 1.1, "ManualProjectState": 0, "ProjectStateDescription": "sample string 17", "DontInheritCommonTasks": true, "IsOrderBased": true, "Account": "sample string 20", "CostCenter": "sample string 21", "OrderType": 0, "ContractId": "sample string 22", "PlaceOfServiceProvision": "sample string 23", "IsProjectTimeSet": true, "SharedPool": 25.1, "PrivatePool": 26.1, "ScheduledWork": 27.1, "HoursWorked": 28.1, "AvailableWork": 29.1, "FurtherAccountingDetails": "sample string 30", "ProjectCode": "sample string 31", "IsProjectInCoverage": true, "CreatedBy": "52133ef1-9003-4b85-8fce-9f12d22440a7", "Created": "2025-09-17T22:45:48.7444122+02:00", "LastUpdateBy": "9bff614f-c336-4e36-aa33-ab180a369636", "LastUpdate": "2025-09-17T22:45:48.7444122+02:00", "CreatedByUser": "sample string 39", "LastUpdateByUser": "sample string 40", "Id": "61bea25f-9ad5-4fad-ab4f-e4885a89f8fd", "IsNew": true, "ProjectOwner": "sample string 4", "DefaultTask": { "$ref": "2" }, "IsDescriptionMandatory": true, "ShowAccountingDetails": true } ]
text/html
Sample:
[null,{"$id":"1","Customer":null,"ProjectCustomerId":"e9c49ff3-e33d-4786-bd31-fae468eb4a90","ReportingDate":"2025-09-17T22:45:48.7444122+02:00","ProjectId":"55760f76-dce7-423c-8f8d-0b6620a499de","ParentProjectId":"b5725f62-d59a-4f41-94ea-6c4acb246fd6","ProjectOwnerId":"abee7a55-6003-4698-aa94-9ae0097de297","Currency":"sample string 5","ProjectPricePerHour":6.1,"Vat":7.1,"TextColor":8,"BackgroundColor":9,"ProjectName":"sample string 10","ProjectDescription":"sample string 11","ProjectLifeCycle":0,"IsProjectTimeLimited":true,"StartDate":"2025-09-17T22:45:48.7444122+02:00","EndDate":"2025-09-17T22:45:48.7444122+02:00","TaskList":[null,{"$id":"2","ProjectId":"d109989e-f259-4538-8489-eb33db89b471","TaskId":"74c4378d-d1c8-4d33-8eb0-af5122752178","TaskNameId":"sample string 3","TaskDescription":"sample string 4","Usage":0,"CostFactor":5.1,"TaskCode":"sample string 6","CreatedBy":"b76a079d-cb1a-4081-b3bf-87e50c8d30dd","Created":"2025-09-17T22:45:48.7444122+02:00","LastUpdateBy":"34824fd0-9356-4987-8dc8-b0c735a5520a","LastUpdate":"2025-09-17T22:45:48.7444122+02:00","CreatedByUser":"sample string 15","LastUpdateByUser":"sample string 16","Id":"6a1f8076-c26d-42e1-962e-244337b0b58d","IsNew":true,"WorktimeFactor":7.1,"WorkTypeNo":"sample string 8","OtherTypeNo":"sample string 9","WorkTimeRestriction":0,"MaxTaskWorkingTimePerDay":1.1,"TaskLifeCycle":0,"TaskBackgroundColor":10}],"ProjectAvailability":0,"UserRelations":[null,{"$id":"3","UserProjectId":"dfeafb32-0bb3-400c-a94a-115903bd2670","ProjectUserId":"532d62e0-a281-41b3-b611-865713cb0c47","IsAllowedToUseProject":true,"UserPricePerHour":1.1,"UserMaxWorkingTime":1.1,"UserCustomerId":"be2aaabf-be2b-4687-a391-a41d9b8edc67","UserChargingJourneyTime":1.1,"CreatedBy":"fb38dadc-ad36-4a46-b91b-0a03ce5c77b2","Created":"2025-09-17T22:45:48.7444122+02:00","LastUpdateBy":"89f716a8-6de9-4dfe-8ec2-d4b1b72a7ffc","LastUpdate":"2025-09-17T22:45:48.7444122+02:00","CreatedByUser":"sample string 7","LastUpdateByUser":"sample string 8","Id":"73adb894-140c-4cad-8bda-f6566dde49a0","IsNew":true}],"ProjectMaxWorkingTime":1.1,"IsProjectMaxWorkingTimeExceedable":true,"RoundPrecisionInMinutes":14,"Rounding":0,"YellowTrafficLight":15.1,"RedTrafficLight":16.1,"ProjectChargingJourneyTime":1.1,"ManualProjectState":0,"ProjectStateDescription":"sample string 17","DontInheritCommonTasks":true,"IsOrderBased":true,"Account":"sample string 20","CostCenter":"sample string 21","OrderType":0,"ContractId":"sample string 22","PlaceOfServiceProvision":"sample string 23","IsProjectTimeSet":true,"SharedPool":25.1,"PrivatePool":26.1,"ScheduledWork":27.1,"HoursWorked":28.1,"AvailableWork":29.1,"FurtherAccountingDetails":"sample string 30","ProjectCode":"sample string 31","IsProjectInCoverage":true,"CreatedBy":"52133ef1-9003-4b85-8fce-9f12d22440a7","Created":"2025-09-17T22:45:48.7444122+02:00","LastUpdateBy":"9bff614f-c336-4e36-aa33-ab180a369636","LastUpdate":"2025-09-17T22:45:48.7444122+02:00","CreatedByUser":"sample string 39","LastUpdateByUser":"sample string 40","Id":"61bea25f-9ad5-4fad-ab4f-e4885a89f8fd","IsNew":true,"ProjectOwner":"sample string 4","DefaultTask":{"$ref":"2"},"IsDescriptionMandatory":true,"ShowAccountingDetails":true}]
application/xml, text/xml
Sample:
<ArrayOfReportProjectDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TimePunch.Core.Services.ReportingService.Dto"> <ReportProjectDto i:nil="true" /> <ReportProjectDto z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Id>61bea25f-9ad5-4fad-ab4f-e4885a89f8fd</Id> <IsNew>true</IsNew> <Created>2025-09-17T22:45:48.7444122+02:00</Created> <CreatedBy>52133ef1-9003-4b85-8fce-9f12d22440a7</CreatedBy> <CreatedByUser>sample string 39</CreatedByUser> <LastUpdate>2025-09-17T22:45:48.7444122+02:00</LastUpdate> <LastUpdateBy>9bff614f-c336-4e36-aa33-ab180a369636</LastUpdateBy> <LastUpdateByUser>sample string 40</LastUpdateByUser> <Account>sample string 20</Account> <AvailableWork>29.1</AvailableWork> <BackgroundColor>9</BackgroundColor> <ContractId>sample string 22</ContractId> <CostCenter>sample string 21</CostCenter> <Currency>sample string 5</Currency> <Customer i:nil="true" /> <DontInheritCommonTasks>true</DontInheritCommonTasks> <EndDate>2025-09-17T22:45:48.7444122+02:00</EndDate> <FurtherAccountingDetails>sample string 30</FurtherAccountingDetails> <HoursWorked>28.1</HoursWorked> <IsOrderBased>true</IsOrderBased> <IsProjectInCoverage>true</IsProjectInCoverage> <IsProjectMaxWorkingTimeExceedable>true</IsProjectMaxWorkingTimeExceedable> <IsProjectTimeLimited>true</IsProjectTimeLimited> <IsProjectTimeSet>true</IsProjectTimeSet> <ManualProjectState>Calculated</ManualProjectState> <OrderType>Undefined</OrderType> <ParentProjectId>b5725f62-d59a-4f41-94ea-6c4acb246fd6</ParentProjectId> <PlaceOfServiceProvision>sample string 23</PlaceOfServiceProvision> <PrivatePool>26.1</PrivatePool> <ProjectAvailability>AvailableForAll</ProjectAvailability> <ProjectChargingJourneyTime>1.1</ProjectChargingJourneyTime> <ProjectCode>sample string 31</ProjectCode> <ProjectCustomerId>e9c49ff3-e33d-4786-bd31-fae468eb4a90</ProjectCustomerId> <ProjectDescription>sample string 11</ProjectDescription> <ProjectId>55760f76-dce7-423c-8f8d-0b6620a499de</ProjectId> <ProjectLifeCycle>Undefined</ProjectLifeCycle> <ProjectMaxWorkingTime>1.1</ProjectMaxWorkingTime> <ProjectName>sample string 10</ProjectName> <ProjectOwnerId>abee7a55-6003-4698-aa94-9ae0097de297</ProjectOwnerId> <ProjectPricePerHour>6.1</ProjectPricePerHour> <ProjectStateDescription>sample string 17</ProjectStateDescription> <RedTrafficLight>16.1</RedTrafficLight> <ReportingDate>2025-09-17T22:45:48.7444122+02:00</ReportingDate> <RoundPrecisionInMinutes>14</RoundPrecisionInMinutes> <Rounding>NotRounded</Rounding> <ScheduledWork>27.1</ScheduledWork> <SharedPool>25.1</SharedPool> <StartDate>2025-09-17T22:45:48.7444122+02:00</StartDate> <TaskList> <ReportTaskDto i:nil="true" /> <ReportTaskDto z:Id="i2"> <Id>6a1f8076-c26d-42e1-962e-244337b0b58d</Id> <IsNew>true</IsNew> <Created>2025-09-17T22:45:48.7444122+02:00</Created> <CreatedBy>b76a079d-cb1a-4081-b3bf-87e50c8d30dd</CreatedBy> <CreatedByUser>sample string 15</CreatedByUser> <LastUpdate>2025-09-17T22:45:48.7444122+02:00</LastUpdate> <LastUpdateBy>34824fd0-9356-4987-8dc8-b0c735a5520a</LastUpdateBy> <LastUpdateByUser>sample string 16</LastUpdateByUser> <CostFactor>5.1</CostFactor> <ProjectId>d109989e-f259-4538-8489-eb33db89b471</ProjectId> <TaskCode>sample string 6</TaskCode> <TaskDescription>sample string 4</TaskDescription> <TaskId>74c4378d-d1c8-4d33-8eb0-af5122752178</TaskId> <TaskNameId>sample string 3</TaskNameId> <Usage>WorkTime</Usage> <OtherTypeNo>sample string 9</OtherTypeNo> <WorkTypeNo>sample string 8</WorkTypeNo> <WorktimeFactor>7.1</WorktimeFactor> <MaxTaskWorkingTimePerDay>1.1</MaxTaskWorkingTimePerDay> <WorkTimeRestriction>NoRestriction</WorkTimeRestriction> <TaskLifeCycle>Undefined</TaskLifeCycle> <TaskBackgroundColor>10</TaskBackgroundColor> </ReportTaskDto> </TaskList> <TextColor>8</TextColor> <UserRelations> <ReportProjectUserDto i:nil="true" /> <ReportProjectUserDto z:Id="i3"> <Id>73adb894-140c-4cad-8bda-f6566dde49a0</Id> <IsNew>true</IsNew> <Created>2025-09-17T22:45:48.7444122+02:00</Created> <CreatedBy>fb38dadc-ad36-4a46-b91b-0a03ce5c77b2</CreatedBy> <CreatedByUser>sample string 7</CreatedByUser> <LastUpdate>2025-09-17T22:45:48.7444122+02:00</LastUpdate> <LastUpdateBy>89f716a8-6de9-4dfe-8ec2-d4b1b72a7ffc</LastUpdateBy> <LastUpdateByUser>sample string 8</LastUpdateByUser> <IsAllowedToUseProject>true</IsAllowedToUseProject> <ProjectUserId>532d62e0-a281-41b3-b611-865713cb0c47</ProjectUserId> <UserChargingJourneyTime>1.1</UserChargingJourneyTime> <UserCustomerId>be2aaabf-be2b-4687-a391-a41d9b8edc67</UserCustomerId> <UserMaxWorkingTime>1.1</UserMaxWorkingTime> <UserPricePerHour>1.1</UserPricePerHour> <UserProjectId>dfeafb32-0bb3-400c-a94a-115903bd2670</UserProjectId> </ReportProjectUserDto> </UserRelations> <Vat>7.1</Vat> <YellowTrafficLight>15.1</YellowTrafficLight> <ProjectOwner>sample string 4</ProjectOwner> <DefaultTask z:Ref="i2" /> <IsDescriptionMandatory>true</IsDescriptionMandatory> <ShowAccountingDetails>true</ShowAccountingDetails> </ReportProjectDto> </ArrayOfReportProjectDto>