POST v1/projects/search

Searches for projects using the search filters.

Request Information

URI Parameters

None.

Body Parameters

All available search parameters

Name	Description	Type	Additional information
Name		string	None.
Customer	If provided, projects will be filtered based on the customer Id or Number or Name. If all of them are provided, Id takes the first precedence, then the number and then the name. All matching projects will be returned.	CustomerRef	None.
Status	Collection of Status Ids	Collection of integer	None.
Type	Collection of Type Ids	Collection of integer	None.
DateCreatedRange	The date and time (in company time zone) when the project was created.	DateRange	None.
LastUpdatedRange	The date and time (in company time zone) when the project was last updated.	DateRange	None.
SortExpression	Available Sort Expresstions: [Name Default ASC, Type, DateCreated, LastUpdatedDate]	string	None.
PageIndex	zero-based page number	integer	None.
PageSize	Default value is 100	integer	Range: inclusive between 1 and 1000
SortOrder	Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending)	integer	Range: inclusive between 1 and 2

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "customer": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "status": [
    1,
    2
  ],
  "type": [
    1,
    2
  ],
  "dateCreatedRange": null,
  "lastUpdatedRange": null,
  "sortExpression": "sample string 2",
  "pageIndex": 3,
  "pageSize": 4,
  "sortOrder": 5
}

application/xml, text/xml

Sample:

<ProjectSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Project">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">4</PageSize>
  <SortExpression i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models" />
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</SortOrder>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </Customer>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <LastUpdatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Name>sample string 1</Name>
  <SortExpression>sample string 2</SortExpression>
  <Status xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Status>
  <Type xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Type>
</ProjectSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfProjectSearchResult

Name	Description	Type	Additional information
TotalCount		integer	None.
Data		Collection of ProjectSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "customer": {
        "id": 1,
        "number": "sample string 2",
        "name": "sample string 3"
      },
      "type": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2024-05-08T17:02:31.6721862-04:00",
      "createdBy": {
        "id": 1,
        "name": "sample string 2"
      },
      "lastUpdatedDate": "2024-05-08T17:02:31.6721862-04:00",
      "lastUpdatedBy": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    {
      "id": 1,
      "name": "sample string 2",
      "customer": {
        "id": 1,
        "number": "sample string 2",
        "name": "sample string 3"
      },
      "type": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2024-05-08T17:02:31.6721862-04:00",
      "createdBy": {
        "id": 1,
        "name": "sample string 2"
      },
      "lastUpdatedDate": "2024-05-08T17:02:31.6721862-04:00",
      "lastUpdatedBy": {
        "id": 1,
        "name": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResultOfProjectSearchResultXIiBPlVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Project">
    <d2p1:ProjectSearchResult>
      <d2p1:CreatedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:CreatedBy>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Number>sample string 2</d4p1:Number>
      </d2p1:Customer>
      <d2p1:DateCreated>2024-05-08T17:02:31.6721862-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:LastUpdatedBy>
      <d2p1:LastUpdatedDate>2024-05-08T17:02:31.6721862-04:00</d2p1:LastUpdatedDate>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Status>
      <d2p1:Type xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Type>
    </d2p1:ProjectSearchResult>
    <d2p1:ProjectSearchResult>
      <d2p1:CreatedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:CreatedBy>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Number>sample string 2</d4p1:Number>
      </d2p1:Customer>
      <d2p1:DateCreated>2024-05-08T17:02:31.6721862-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:LastUpdatedBy>
      <d2p1:LastUpdatedDate>2024-05-08T17:02:31.6721862-04:00</d2p1:LastUpdatedDate>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Status>
      <d2p1:Type xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Type>
    </d2p1:ProjectSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfProjectSearchResultXIiBPlVO>