POST v1/item-builds/search

Search for available builds using the search filters.

Request Information

URI Parameters

None.

Body Parameters

All available search parameters

Name	Description	Type	Additional information
RefNumber		string	None.
ItemId	Manufactured Item	integer	None.
Status	Searches by the build status (can be one of the following, 182 - Incomplete, 186 - Pending, 170 - Finalized, 171 - Voided)	integer	None.
DateCreatedRange	The date and time (in company time zone) when the build was created.	DateRange	None.
LastUpdatedDateRange	The date and time (in company time zone) when the build was last updated.	DateRange	None.
SortExpression	Available Sort Expresstions: [BuildDate Default DESC, Id, RefNumber, Item, Status, 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:

{
  "refNumber": "sample string 1",
  "itemId": 1,
  "status": 1,
  "dateCreatedRange": null,
  "lastUpdatedDateRange": null,
  "sortExpression": "sample string 2",
  "pageIndex": 3,
  "pageSize": 4,
  "sortOrder": 5
}

application/xml, text/xml

Sample:

<ItemBuildSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <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>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <ItemId>1</ItemId>
  <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <RefNumber>sample string 1</RefNumber>
  <SortExpression>sample string 2</SortExpression>
  <Status>1</Status>
</ItemBuildSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfItemBuildSearchResult

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

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "refNumber": "sample string 2",
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "buildDate": "2024-04-19T06:05:02.1441403-04:00",
      "dateCreated": "2024-04-19T06:05:02.1441403-04:00",
      "lastUpdatedDate": "2024-04-19T06:05:02.1441403-04:00"
    },
    {
      "id": 1,
      "refNumber": "sample string 2",
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "buildDate": "2024-04-19T06:05:02.1441403-04:00",
      "dateCreated": "2024-04-19T06:05:02.1441403-04:00",
      "lastUpdatedDate": "2024-04-19T06:05:02.1441403-04:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResultOfItemBuildSearchResult9X4wrT_Pq 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.Accounting">
    <d2p1:ItemBuildSearchResult>
      <d2p1:BuildDate>2024-04-19T06:05:02.1441403-04:00</d2p1:BuildDate>
      <d2p1:DateCreated>2024-04-19T06:05:02.1441403-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Item 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:Item>
      <d2p1:LastUpdatedDate>2024-04-19T06:05:02.1441403-04:00</d2p1:LastUpdatedDate>
      <d2p1:RefNumber>sample string 2</d2p1:RefNumber>
      <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:ItemBuildSearchResult>
    <d2p1:ItemBuildSearchResult>
      <d2p1:BuildDate>2024-04-19T06:05:02.1441403-04:00</d2p1:BuildDate>
      <d2p1:DateCreated>2024-04-19T06:05:02.1441403-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Item 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:Item>
      <d2p1:LastUpdatedDate>2024-04-19T06:05:02.1441403-04:00</d2p1:LastUpdatedDate>
      <d2p1:RefNumber>sample string 2</d2p1:RefNumber>
      <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:ItemBuildSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfItemBuildSearchResult9X4wrT_Pq>