BusinessUnitSearchRequestDto

Example Json Object

 1{
 2  "searchTerm": "string",
 3  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 4  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 5  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 6  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 7  "createdByLike": "string",
 8  "createdByEqual": "string",
 9  "statusEqual": "CREATED",
10  "statusIn": [
11    "CREATED"
12  ],
13  "idIn": [
14    0
15  ],
16  "leaseAreaIdIn": [
17    0
18  ],
19  "leaseAreaIdEqual": 0
20}

📄 Description: Data transfer object representing a request to search for business units within an organization, facilitating efficient retrieval of relevant unit information for operational and strategic decision-making.

Properties

Name

Type

Required

Restrictions

Description

searchTerm

string

false

none

The searchTerm field specifies the keyword or phrase used to filter and retrieve relevant business unit information within the API.

createdAtGreaterThanOrEqual

string(date-time)

false

none

Filter where created at is greater than or equal to specified value

createdAtLessThanOrEqual

string(date-time)

false

none

Filter where created at is less than or equal to specified value

modifiedAtGreaterThanOrEqual

string(date-time)

false

none

Filter where modified at is greater than or equal to specified value

modifiedAtLessThanOrEqual

string(date-time)

false

none

Filter where modified at is less than or equal to specified value

createdByLike

string

false

none

Filter by partial match of created by

createdByEqual

string

false

none

Filter by exact match of created by

statusEqual

string

false

none

Filter by exact match of status

statusIn

[string]

false

none

Filter by multiple values of status

idIn

[integer]

false

none

Filter by multiple values of id

leaseAreaIdIn

[integer]

false

none

Filter by multiple values of lease area id

leaseAreaIdEqual

integer(int64)

false

none

Filter by exact match of lease area id

Enumerated Values

Attribute

Value

statusEqual

ACTIVE, CREATED, DECOMMISSIONED, DISABLED