GET api/consumer/v1/projects/search?q={q}&page={page}&pageSize={pageSize}&sortField={sortField}&sortAscending={sortAscending}
Search Projects
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| q |
Search param |
string |
Required |
| page |
Current page |
integer |
Default value is 1 |
| pageSize |
Page size |
integer |
Default value is 50 |
| sortField |
Name of the field to use for sorting |
string |
Default value is |
| sortAscending |
True for ascending sorting, false otherwise |
boolean |
Default value is True |
Body Parameters
None
Response Information
Resource Description
List of projects
Collection of ProjectDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ProjectType |
Type of project |
ProjectTypeMinDto |
None |
| Owner |
Owner of project |
UserMinDto |
None |
| OrganizationalUnit |
Organizational unit of project |
OrganizationalUnitMinDto |
None |
| Customer |
Customer of project |
CustomerMinDto |
None |
| WorkFlow |
Approval work flow of project |
WorkflowMinDto |
None |
| StartDate |
Start date of project |
date |
None |
| EndDate |
End date of project |
date |
None |
| Notes |
Notes of project |
string |
None |
| CustomerRequest |
Customer request of project |
string |
None |
| IsTimeMaterial |
Yes if project is time material |
boolean |
None |
| NumMaxHours |
Max hours of project |
decimal number |
None |
| Attachments |
Attachements of project |
integer |
None |
| AutoTaskType |
Auto task type |
character |
None |
| AutoTask |
Auto task of project |
TaskMinDto |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
[
{
"ProjectType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Owner": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"OrganizationalUnit": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Customer": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"WorkFlow": {
"Code": "sample string 1",
"Description": "sample string 2",
"IsActive": true,
"Id": 4
},
"StartDate": "2024-12-21T17:22:57.5059915+01:00",
"EndDate": "2024-12-21T17:22:57.5059915+01:00",
"Notes": "sample string 3",
"CustomerRequest": "sample string 4",
"IsTimeMaterial": true,
"NumMaxHours": 6.0,
"Attachments": 7,
"AutoTaskType": "A",
"AutoTask": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Code": "sample string 8",
"Description": "sample string 9",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-12-21T17:22:57.5059915+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-12-21T17:22:57.5059915+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 11
},
{
"ProjectType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Owner": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"OrganizationalUnit": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Customer": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"WorkFlow": {
"Code": "sample string 1",
"Description": "sample string 2",
"IsActive": true,
"Id": 4
},
"StartDate": "2024-12-21T17:22:57.5059915+01:00",
"EndDate": "2024-12-21T17:22:57.5059915+01:00",
"Notes": "sample string 3",
"CustomerRequest": "sample string 4",
"IsTimeMaterial": true,
"NumMaxHours": 6.0,
"Attachments": 7,
"AutoTaskType": "A",
"AutoTask": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Code": "sample string 8",
"Description": "sample string 9",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-12-21T17:22:57.5059915+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-12-21T17:22:57.5059915+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 11
}
]
application/xml, text/xml
Sample:
<ArrayOfProjectDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<ProjectDto>
<Id>11</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-12-21T17:22:57.5059915+01:00</CreationDate>
<LastUpdateDate>2024-12-21T17:22:57.5059915+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 8</Code>
<Description>sample string 9</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Attachments>7</Attachments>
<AutoTask>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</AutoTask>
<AutoTaskType>65</AutoTaskType>
<Customer>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</Customer>
<CustomerRequest>sample string 4</CustomerRequest>
<EndDate>2024-12-21T17:22:57.5059915+01:00</EndDate>
<IsTimeMaterial>true</IsTimeMaterial>
<Notes>sample string 3</Notes>
<NumMaxHours>6</NumMaxHours>
<OrganizationalUnit>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</OrganizationalUnit>
<Owner>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</Owner>
<ProjectType>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</ProjectType>
<StartDate>2024-12-21T17:22:57.5059915+01:00</StartDate>
<WorkFlow>
<Id>4</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsActive>true</IsActive>
</WorkFlow>
</ProjectDto>
<ProjectDto>
<Id>11</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-12-21T17:22:57.5059915+01:00</CreationDate>
<LastUpdateDate>2024-12-21T17:22:57.5059915+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 8</Code>
<Description>sample string 9</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Attachments>7</Attachments>
<AutoTask>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</AutoTask>
<AutoTaskType>65</AutoTaskType>
<Customer>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</Customer>
<CustomerRequest>sample string 4</CustomerRequest>
<EndDate>2024-12-21T17:22:57.5059915+01:00</EndDate>
<IsTimeMaterial>true</IsTimeMaterial>
<Notes>sample string 3</Notes>
<NumMaxHours>6</NumMaxHours>
<OrganizationalUnit>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</OrganizationalUnit>
<Owner>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</Owner>
<ProjectType>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</ProjectType>
<StartDate>2024-12-21T17:22:57.5059915+01:00</StartDate>
<WorkFlow>
<Id>4</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsActive>true</IsActive>
</WorkFlow>
</ProjectDto>
</ArrayOfProjectDto>