BatchProfileDto

Example Json Object

  1{
  2  "id": 0,
  3  "name": "string",
  4  "principalPositionType": "LESSEE",
  5  "erpSystemFilterType": "ALL",
  6  "erpSystems": [
  7    {
  8      "id": 0,
  9      "displayId": "string",
 10      "status": "CREATED",
 11      "name": "string"
 12    }
 13  ],
 14  "leaseAreaFilterType": "ALL",
 15  "leaseAreas": [
 16    {
 17      "id": 0,
 18      "displayId": "string",
 19      "status": "CREATED",
 20      "name": "string"
 21    }
 22  ],
 23  "businessUnitFilterType": "ALL",
 24  "businessUnits": [
 25    {
 26      "id": 0,
 27      "displayId": "string",
 28      "status": "CREATED",
 29      "name": "string"
 30    }
 31  ],
 32  "companyFilterType": "ALL",
 33  "companyCodes": [
 34    {
 35      "id": 0,
 36      "displayId": "string",
 37      "status": "CREATED",
 38      "erpSystemId": 0,
 39      "erpSystemDisplayId": "string",
 40      "countryId": 0,
 41      "countryDisplayId": "string",
 42      "name": "string"
 43    }
 44  ],
 45  "departmentFilterType": "ALL",
 46  "leaseDepartments": [
 47    {
 48      "id": 0,
 49      "displayId": "string",
 50      "status": "CREATED",
 51      "name": "string"
 52    }
 53  ],
 54  "leaseGroupFilterType": "ALL",
 55  "leaseGroups": [
 56    {
 57      "id": 0,
 58      "displayId": "string",
 59      "status": "CREATED",
 60      "name": "string"
 61    }
 62  ],
 63  "costCenterFilterType": "ALL",
 64  "costCenters": [
 65    {
 66      "id": 0,
 67      "displayId": "string",
 68      "status": "CREATED",
 69      "name": "string"
 70    }
 71  ],
 72  "profitCenterFilterType": "ALL",
 73  "profitCenters": [
 74    {
 75      "id": 0,
 76      "displayId": "string",
 77      "status": "CREATED",
 78      "name": "string",
 79      "validTo": "2019-08-24",
 80      "erpSystemId": 0,
 81      "erpSystemDisplayId": "string"
 82    }
 83  ],
 84  "workBreakdownStructureFilterType": "ALL",
 85  "workBreakdownStructures": [
 86    {
 87      "id": 0,
 88      "displayId": "string",
 89      "status": "CREATED",
 90      "name": "string"
 91    }
 92  ],
 93  "objectStatus": "CREATED",
 94  "securityProfileId": 0,
 95  "businessAreaFilterType": "ALL",
 96  "businessAreas": [
 97    {
 98      "id": 0,
 99      "displayId": "string",
100      "status": "CREATED",
101      "name": "string"
102    }
103  ],
104  "functionalAreaFilterType": "ALL",
105  "functionalAreas": [
106    {
107      "id": 0,
108      "displayId": "string",
109      "status": "CREATED",
110      "name": "string"
111    }
112  ],
113  "filterObjectDto": {
114    "id": 0,
115    "profileId": 0,
116    "displayId": "string",
117    "objectType": "string"
118  },
119  "assetClassFilterType": "ALL",
120  "assetClasses": [
121    {
122      "id": 0,
123      "displayId": "string"
124    }
125  ],
126  "cpiCategoryFilterType": "ALL",
127  "cpiCategories": [
128    {
129      "id": 0,
130      "displayId": "string"
131    }
132  ],
133  "scriptProfile": true
134}

📄 Description: Data transfer object representing a collection of user profiles for batch processing, facilitating efficient management and analysis of user data within enterprise applications.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

name

string

false

none

Name of the resource

principalPositionType

string

true

none

Type of the principal position

erpSystemFilterType

string

true

none

Type of the erp system filter

erpSystems

[ErpSystemLiteDto]

false

none

List of ERP system profiles associated with the batch processing, enabling seamless integration and management of enterprise resources.

leaseAreaFilterType

string

true

none

Type of the lease area filter

leaseAreas

[LeaseAreaLiteDto]

false

none

An array of lease area identifiers associated with the batch profile, facilitating the management and organization of lease-related data.

businessUnitFilterType

string

true

none

Type of the business unit filter

businessUnits

[BusinessUnitLiteDto]

false

none

An array of business units associated with the batch profile, enabling effective organization and management of resources within the enterprise.

companyFilterType

string

true

none

Type of the company filter

companyCodes

[CompanyLiteDto]

false

none

An array of unique identifiers representing the company codes associated with the batch profile, facilitating streamlined data management and reporting.

departmentFilterType

string

true

none

Type of the department filter

leaseDepartments

[DepartmentLiteDto]

false

none

An array of departments associated with the lease, facilitating the management and organization of lease-related activities within the business.

leaseGroupFilterType

string

true

none

Type of the lease group filter

leaseGroups

[LeaseGroupLiteDto]

false

none

An array of lease groups associated with the batch profile, facilitating the organization and management of leasing agreements within the system.

costCenterFilterType

string

true

none

Type of the cost center filter

costCenters

[CostCenterLiteDto]

false

none

Array of cost centers associated with the batch profile, enabling effective financial tracking and resource allocation within the organization.

profitCenterFilterType

string

true

none

Type of the profit center filter

profitCenters

[ProfitCenterLiteDto]

false

none

Array of profit centers associated with the batch profile, enabling effective financial tracking and resource allocation within the organization.

workBreakdownStructureFilterType

string

true

none

Type of the work breakdown structure filter

workBreakdownStructures

[WorkBreakdownStructureLiteDto]

false

none

An array of work breakdown structures that detail the hierarchical decomposition of project deliverables for effective project management and resource allocation.

objectStatus

string

false

none

Status of the object

securityProfileId

integer(int64)

false

none

Unique identifier for the security profile

businessAreaFilterType

string

true

none

Type of the business area filter

businessAreas

[BusinessAreaLiteDto]

false

none

List of business areas associated with the batch profile, providing context for organizational focus and resource allocation.

functionalAreaFilterType

string

true

none

Type of the functional area filter

functionalAreas

[FunctionalAreaLiteDto]

false

none

An array representing the various functional areas associated with the batch profile, facilitating targeted management and analysis of organizational capabilities.

filterObjectDto

FilterObjectDto

false

none

Represents a structured set of criteria used to filter batch profile data for targeted analysis and reporting.

assetClassFilterType

string

false

none

Type of the asset class filter

assetClasses

[BaseId]

false

none

An array of asset classes associated with the batch profile, used to categorize and manage various types of assets within the system.

cpiCategoryFilterType

string

false

none

Type of the cpi category filter

cpiCategories

[BaseId]

false

none

Collection of categories associated with the batch profile, used to classify and organize related data for enhanced reporting and analysis.

scriptProfile

boolean

false

none

Indicates whether a specific script profile is enabled for batch processing within the system.

Enumerated Values

Attribute

Value

assetClassFilterType

ALL, LIST

businessAreaFilterType

ALL, LIST

businessUnitFilterType

ALL, LIST

companyFilterType

ALL, LIST

costCenterFilterType

ALL, LIST

cpiCategoryFilterType

ALL, LIST

departmentFilterType

ALL, LIST

erpSystemFilterType

ALL, LIST

functionalAreaFilterType

ALL, LIST

leaseAreaFilterType

ALL, LIST

leaseGroupFilterType

ALL, LIST

objectStatus

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

principalPositionType

LESSEE, LESSOR

profitCenterFilterType

ALL, LIST

workBreakdownStructureFilterType

ALL, LIST