Nothing Found

List Business Entities

Get paginated list of business entities associated with the given search criteria.

Securityoauth2
Request
Request Body schema:
code
string or null

Code for Business Entity.

id
integer <int32>

Unique identifier of Business Entity.

Array of objects or null (VAM.DealFoundry.Services.Entities.SearchParameter)

List of search parameters.

pageIndex
integer <int32>

Index of the Page

pageSize
integer <int32>

Indicates size of the collection.

sortParameter
integer <int32> (VAM.DealFoundry.Services.Entities.SortParameter)

Indicates sorting parameter.

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
totalRecords
integer <int32>

Indicates count of records

sortDirection
integer <int32> (VAM.DealFoundry.Services.Entities.SortDirection)
Enum: 0 1
startsWith
string or null

Indicates name that starts with

isLikeSearch
boolean

Set to True for LikeSearch

businessEntityIds
Array of integers or null <int32>

Collection of IDs

businessEntityCodes
Array of strings or null

Collection of codes

offerId
integer <int32>

Unique identifier of Offer.

baseofferId
integer <int32>

Unique identifier of base Offer.

parentId
integer <int32>

Unique identifier of Business Entity Id.

entityName
string or null

Name of the Business Entity.

entityType
string or null

Type of the Business Entity.

includeChildren
boolean

Indicates status to include all Business Entity details.

includeDependency
boolean

Indicates status

includeInvalidBusinessEntities
boolean

Indicates status

includeDetails
boolean

Indicates details of Business Entity.

offerItemId
integer <int32>

Indicates unique identifier of Offer Item.

locationId
integer <int32>

Indicates unique identifier of Location Business entity.

includeParent
boolean

Indicates status to include Parent Business Entity details.

validateForms
boolean

Indicates status to validate Forms.

lobName
string or null

Name of the Line of Business.

Responses
200

Success

401

Unauthorized

403

Forbidden

post/api/v1/businessEntities/search
Request samples
{
  • "code": "string",
  • "id": 0,
  • "searchParameters": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "sortParameter": 0,
  • "totalRecords": 0,
  • "sortDirection": 0,
  • "startsWith": "string",
  • "isLikeSearch": true,
  • "businessEntityIds": [
    ],
  • "businessEntityCodes": [
    ],
  • "offerId": 0,
  • "baseofferId": 0,
  • "parentId": 0,
  • "entityName": "string",
  • "entityType": "string",
  • "includeChildren": true,
  • "includeDependency": true,
  • "includeInvalidBusinessEntities": true,
  • "includeDetails": true,
  • "offerItemId": 0,
  • "locationId": 0,
  • "includeParent": true,
  • "validateForms": true,
  • "lobName": "string"
}
Response samples
No sample