GET api/Projects?search={search}&lifeCylce={lifeCylce}&withTasks={withTasks}&userDefinedCustomers={userDefinedCustomers}

Request Information

URI Parameters

Name	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 ReportProjectDto

Name	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": "274245db-06fc-4d4a-89dd-1537e2e1a2c5",
    "ReportingDate": "2025-07-04T16:39:07.1238631+02:00",
    "ProjectId": "be5d3c17-5c9e-49e2-941d-67306fa3d171",
    "ParentProjectId": "9524935b-0edf-4ce4-9134-4133e469a6b8",
    "ProjectOwnerId": "9d3e896b-d1b8-4ae8-b374-256c798dec45",
    "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-07-04T16:39:07.1238631+02:00",
    "EndDate": "2025-07-04T16:39:07.1238631+02:00",
    "TaskList": [
      null,
      {
        "$id": "2",
        "ProjectId": "d20bed50-95fe-47a4-8588-43a829b54f03",
        "TaskId": "9e2ea526-6827-4ff4-af39-2dc15fe61278",
        "TaskNameId": "sample string 3",
        "TaskDescription": "sample string 4",
        "Usage": 0,
        "CostFactor": 5.1,
        "TaskCode": "sample string 6",
        "CreatedBy": "4a2591f6-3c42-4923-a5d3-c963c39d95a9",
        "Created": "2025-07-04T16:39:07.1238631+02:00",
        "LastUpdateBy": "bda4cebf-b9eb-42aa-8a08-3d167587086c",
        "LastUpdate": "2025-07-04T16:39:07.1238631+02:00",
        "CreatedByUser": "sample string 15",
        "LastUpdateByUser": "sample string 16",
        "Id": "2b127c2c-c964-4001-b23e-87f93f903d02",
        "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": "06b5d905-7a0d-453b-bdcd-35690f9beb6e",
        "ProjectUserId": "c3f3e087-812e-4749-ba7c-37764262adf1",
        "IsAllowedToUseProject": true,
        "UserPricePerHour": 1.1,
        "UserMaxWorkingTime": 1.1,
        "UserCustomerId": "d8494e90-c298-4d05-97c4-a04c84b78801",
        "UserChargingJourneyTime": 1.1,
        "CreatedBy": "6782de18-edf5-46f7-9fd0-bab90401d78c",
        "Created": "2025-07-04T16:39:07.1238631+02:00",
        "LastUpdateBy": "31391cbe-35da-41eb-b7bc-d35de6db2d51",
        "LastUpdate": "2025-07-04T16:39:07.1238631+02:00",
        "CreatedByUser": "sample string 7",
        "LastUpdateByUser": "sample string 8",
        "Id": "05bb56b0-386f-4dd9-a379-18c9c2212494",
        "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": "ccb3da2a-7eb5-4260-be5c-77ab2c2bf9d7",
    "Created": "2025-07-04T16:39:07.1238631+02:00",
    "LastUpdateBy": "6c31ce40-8a54-4589-9d6e-ef2a39f2604c",
    "LastUpdate": "2025-07-04T16:39:07.1238631+02:00",
    "CreatedByUser": "sample string 39",
    "LastUpdateByUser": "sample string 40",
    "Id": "8d3e57b7-64af-4256-8f1c-25525fe4073d",
    "IsNew": true,
    "ProjectOwner": "sample string 4",
    "DefaultTask": {
      "$ref": "2"
    },
    "IsDescriptionMandatory": true,
    "ShowAccountingDetails": true
  }
]

text/html

Sample:

[null,{"$id":"1","Customer":null,"ProjectCustomerId":"274245db-06fc-4d4a-89dd-1537e2e1a2c5","ReportingDate":"2025-07-04T16:39:07.1238631+02:00","ProjectId":"be5d3c17-5c9e-49e2-941d-67306fa3d171","ParentProjectId":"9524935b-0edf-4ce4-9134-4133e469a6b8","ProjectOwnerId":"9d3e896b-d1b8-4ae8-b374-256c798dec45","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-07-04T16:39:07.1238631+02:00","EndDate":"2025-07-04T16:39:07.1238631+02:00","TaskList":[null,{"$id":"2","ProjectId":"d20bed50-95fe-47a4-8588-43a829b54f03","TaskId":"9e2ea526-6827-4ff4-af39-2dc15fe61278","TaskNameId":"sample string 3","TaskDescription":"sample string 4","Usage":0,"CostFactor":5.1,"TaskCode":"sample string 6","CreatedBy":"4a2591f6-3c42-4923-a5d3-c963c39d95a9","Created":"2025-07-04T16:39:07.1238631+02:00","LastUpdateBy":"bda4cebf-b9eb-42aa-8a08-3d167587086c","LastUpdate":"2025-07-04T16:39:07.1238631+02:00","CreatedByUser":"sample string 15","LastUpdateByUser":"sample string 16","Id":"2b127c2c-c964-4001-b23e-87f93f903d02","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":"06b5d905-7a0d-453b-bdcd-35690f9beb6e","ProjectUserId":"c3f3e087-812e-4749-ba7c-37764262adf1","IsAllowedToUseProject":true,"UserPricePerHour":1.1,"UserMaxWorkingTime":1.1,"UserCustomerId":"d8494e90-c298-4d05-97c4-a04c84b78801","UserChargingJourneyTime":1.1,"CreatedBy":"6782de18-edf5-46f7-9fd0-bab90401d78c","Created":"2025-07-04T16:39:07.1238631+02:00","LastUpdateBy":"31391cbe-35da-41eb-b7bc-d35de6db2d51","LastUpdate":"2025-07-04T16:39:07.1238631+02:00","CreatedByUser":"sample string 7","LastUpdateByUser":"sample string 8","Id":"05bb56b0-386f-4dd9-a379-18c9c2212494","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":"ccb3da2a-7eb5-4260-be5c-77ab2c2bf9d7","Created":"2025-07-04T16:39:07.1238631+02:00","LastUpdateBy":"6c31ce40-8a54-4589-9d6e-ef2a39f2604c","LastUpdate":"2025-07-04T16:39:07.1238631+02:00","CreatedByUser":"sample string 39","LastUpdateByUser":"sample string 40","Id":"8d3e57b7-64af-4256-8f1c-25525fe4073d","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>8d3e57b7-64af-4256-8f1c-25525fe4073d</Id>
    <IsNew>true</IsNew>
    <Created>2025-07-04T16:39:07.1238631+02:00</Created>
    <CreatedBy>ccb3da2a-7eb5-4260-be5c-77ab2c2bf9d7</CreatedBy>
    <CreatedByUser>sample string 39</CreatedByUser>
    <LastUpdate>2025-07-04T16:39:07.1238631+02:00</LastUpdate>
    <LastUpdateBy>6c31ce40-8a54-4589-9d6e-ef2a39f2604c</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-07-04T16:39:07.1238631+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>9524935b-0edf-4ce4-9134-4133e469a6b8</ParentProjectId>
    <PlaceOfServiceProvision>sample string 23</PlaceOfServiceProvision>
    <PrivatePool>26.1</PrivatePool>
    <ProjectAvailability>AvailableForAll</ProjectAvailability>
    <ProjectChargingJourneyTime>1.1</ProjectChargingJourneyTime>
    <ProjectCode>sample string 31</ProjectCode>
    <ProjectCustomerId>274245db-06fc-4d4a-89dd-1537e2e1a2c5</ProjectCustomerId>
    <ProjectDescription>sample string 11</ProjectDescription>
    <ProjectId>be5d3c17-5c9e-49e2-941d-67306fa3d171</ProjectId>
    <ProjectLifeCycle>Undefined</ProjectLifeCycle>
    <ProjectMaxWorkingTime>1.1</ProjectMaxWorkingTime>
    <ProjectName>sample string 10</ProjectName>
    <ProjectOwnerId>9d3e896b-d1b8-4ae8-b374-256c798dec45</ProjectOwnerId>
    <ProjectPricePerHour>6.1</ProjectPricePerHour>
    <ProjectStateDescription>sample string 17</ProjectStateDescription>
    <RedTrafficLight>16.1</RedTrafficLight>
    <ReportingDate>2025-07-04T16:39:07.1238631+02:00</ReportingDate>
    <RoundPrecisionInMinutes>14</RoundPrecisionInMinutes>
    <Rounding>NotRounded</Rounding>
    <ScheduledWork>27.1</ScheduledWork>
    <SharedPool>25.1</SharedPool>
    <StartDate>2025-07-04T16:39:07.1238631+02:00</StartDate>
    <TaskList>
      <ReportTaskDto i:nil="true" />
      <ReportTaskDto z:Id="i2">
        <Id>2b127c2c-c964-4001-b23e-87f93f903d02</Id>
        <IsNew>true</IsNew>
        <Created>2025-07-04T16:39:07.1238631+02:00</Created>
        <CreatedBy>4a2591f6-3c42-4923-a5d3-c963c39d95a9</CreatedBy>
        <CreatedByUser>sample string 15</CreatedByUser>
        <LastUpdate>2025-07-04T16:39:07.1238631+02:00</LastUpdate>
        <LastUpdateBy>bda4cebf-b9eb-42aa-8a08-3d167587086c</LastUpdateBy>
        <LastUpdateByUser>sample string 16</LastUpdateByUser>
        <CostFactor>5.1</CostFactor>
        <ProjectId>d20bed50-95fe-47a4-8588-43a829b54f03</ProjectId>
        <TaskCode>sample string 6</TaskCode>
        <TaskDescription>sample string 4</TaskDescription>
        <TaskId>9e2ea526-6827-4ff4-af39-2dc15fe61278</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>05bb56b0-386f-4dd9-a379-18c9c2212494</Id>
        <IsNew>true</IsNew>
        <Created>2025-07-04T16:39:07.1238631+02:00</Created>
        <CreatedBy>6782de18-edf5-46f7-9fd0-bab90401d78c</CreatedBy>
        <CreatedByUser>sample string 7</CreatedByUser>
        <LastUpdate>2025-07-04T16:39:07.1238631+02:00</LastUpdate>
        <LastUpdateBy>31391cbe-35da-41eb-b7bc-d35de6db2d51</LastUpdateBy>
        <LastUpdateByUser>sample string 8</LastUpdateByUser>
        <IsAllowedToUseProject>true</IsAllowedToUseProject>
        <ProjectUserId>c3f3e087-812e-4749-ba7c-37764262adf1</ProjectUserId>
        <UserChargingJourneyTime>1.1</UserChargingJourneyTime>
        <UserCustomerId>d8494e90-c298-4d05-97c4-a04c84b78801</UserCustomerId>
        <UserMaxWorkingTime>1.1</UserMaxWorkingTime>
        <UserPricePerHour>1.1</UserPricePerHour>
        <UserProjectId>06b5d905-7a0d-453b-bdcd-35690f9beb6e</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>