POST v1/customer-assets/search

Gets a list of customer assets that meet the search parameter criteria

Request Information

URI Parameters

None.

Body Parameters

CustomerAssetSearchParameters
NameDescriptionTypeAdditional information
AssetName

string

None.

StatusId

integer

None.

AssetTypeId

integer

None.

LastUpdatedDateRange

The date and time (in company time zone) when the contact was last updated.

DateRange

None.

DateCreatedRange

The date and time (in company time zone) when the contact was created.

DateRange

None.

PageIndex

zero-based page number

integer

None.

PageSize

Default value is 100

integer

Range: inclusive between 1 and 1000

SortExpression

Specify the field name to sort the result set by. It can be one of the fields returned by the search.

string

None.

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:
{
  "assetName": "sample string 1",
  "statusId": 1,
  "assetTypeId": 1,
  "lastUpdatedDateRange": null,
  "dateCreatedRange": null,
  "pageIndex": 2,
  "pageSize": 3,
  "sortExpression": "sample string 4",
  "sortOrder": 5
}

application/xml, text/xml

Sample:
<CustomerAssetSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Assets">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">2</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">3</PageSize>
  <SortExpression xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">sample string 4</SortExpression>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</SortOrder>
  <AssetName>sample string 1</AssetName>
  <AssetTypeId>1</AssetTypeId>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <StatusId>1</StatusId>
</CustomerAssetSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfCustomerAssetSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of CustomerAssetSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "assetName": "sample string 2",
      "assetTypeId": 3,
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2022-07-01T15:04:54.3746421-04:00",
      "lastUpdatedDate": "2022-07-01T15:04:54.3746421-04:00"
    },
    {
      "id": 1,
      "assetName": "sample string 2",
      "assetTypeId": 3,
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2022-07-01T15:04:54.3746421-04:00",
      "lastUpdatedDate": "2022-07-01T15:04:54.3746421-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfCustomerAssetSearchResult_SxRknhTN 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.Assets">
    <d2p1:CustomerAssetSearchResult>
      <d2p1:AssetName>sample string 2</d2p1:AssetName>
      <d2p1:AssetTypeId>3</d2p1:AssetTypeId>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <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:Customer>
      <d2p1:DateCreated>2022-07-01T15:04:54.3746421-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2022-07-01T15:04:54.3746421-04:00</d2p1:LastUpdatedDate>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <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:CustomerAssetSearchResult>
    <d2p1:CustomerAssetSearchResult>
      <d2p1:AssetName>sample string 2</d2p1:AssetName>
      <d2p1:AssetTypeId>3</d2p1:AssetTypeId>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <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:Customer>
      <d2p1:DateCreated>2022-07-01T15:04:54.3746421-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2022-07-01T15:04:54.3746421-04:00</d2p1:LastUpdatedDate>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <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:CustomerAssetSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfCustomerAssetSearchResult_SxRknhTN>