Batch Profile

Batch Profile - Get

HTTP Request

GET /api/v1/batch-profile/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific batch profile identified by the provided ID, enabling users to access and review profile attributes for informed decision-making.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBatchProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Update

HTTP Request

PUT /api/v1/batch-profile/{id}

Interactive Demo

📋 Description: Updates the batch profile identified by the specified ID, allowing for modifications to its attributes to reflect the latest business requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	BatchProfileDto	true	Request body containing the updated batch profile information, including relevant attributes and configuration settings for the specified profile ID.

Body Parameters

{
  "id": 0,
  "name": "string",
  "principalPositionType": "LESSEE",
  "erpSystemFilterType": "ALL",
  "erpSystems": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseAreaFilterType": "ALL",
  "leaseAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "businessUnitFilterType": "ALL",
  "businessUnits": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "companyFilterType": "ALL",
  "companyCodes": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string"
    }
  ],
  "departmentFilterType": "ALL",
  "leaseDepartments": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseGroupFilterType": "ALL",
  "leaseGroups": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "costCenterFilterType": "ALL",
  "costCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "profitCenterFilterType": "ALL",
  "profitCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "validTo": "2019-08-24",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "workBreakdownStructureFilterType": "ALL",
  "workBreakdownStructures": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "objectStatus": "CREATED",
  "securityProfileId": 0,
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "cpiCategoryFilterType": "ALL",
  "cpiCategories": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "scriptProfile": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBatchProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Delete

HTTP Request

DELETE /api/v1/batch-profile/{id}

Interactive Demo

📋 Description: Deletes a specified batch profile identified by its unique ID, ensuring the removal of associated data from the system to maintain data integrity and compliance.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Create Or Update

HTTP Request

PUT /api/v1/batch-profile/createOrUpdate

Interactive Demo

📋 Description: Creates or updates batch profile information in the system, ensuring that user data is accurately maintained and readily accessible for operational needs.

Parameters

Name	In	Type	Required	Description
body	body	BatchProfileDto	true	Request body containing the batch profile data, including identifiers and attributes necessary for creating or updating profiles in the system.

Body Parameters

{
  "id": 0,
  "name": "string",
  "principalPositionType": "LESSEE",
  "erpSystemFilterType": "ALL",
  "erpSystems": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseAreaFilterType": "ALL",
  "leaseAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "businessUnitFilterType": "ALL",
  "businessUnits": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "companyFilterType": "ALL",
  "companyCodes": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string"
    }
  ],
  "departmentFilterType": "ALL",
  "leaseDepartments": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseGroupFilterType": "ALL",
  "leaseGroups": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "costCenterFilterType": "ALL",
  "costCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "profitCenterFilterType": "ALL",
  "profitCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "validTo": "2019-08-24",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "workBreakdownStructureFilterType": "ALL",
  "workBreakdownStructures": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "objectStatus": "CREATED",
  "securityProfileId": 0,
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "cpiCategoryFilterType": "ALL",
  "cpiCategories": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "scriptProfile": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseBatchProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Create Or Update Bulk

HTTP Request

PUT /api/v1/batch-profile/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple batch profiles in a single operation, streamlining the management of bulk data entries for enhanced operational efficiency.

Parameters

Name	In	Type	Required	Description
body	body	BatchProfileDto	true	Request body containing an array of batch profile objects for creating or updating multiple profiles in a single operation.

Body Parameters

[
  {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBatchProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "name": "string",
      "principalPositionType": "LESSEE",
      "erpSystemFilterType": "ALL",
      "erpSystems": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseAreaFilterType": "ALL",
      "leaseAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "businessUnitFilterType": "ALL",
      "businessUnits": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "companyFilterType": "ALL",
      "companyCodes": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string"
        }
      ],
      "departmentFilterType": "ALL",
      "leaseDepartments": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseGroupFilterType": "ALL",
      "leaseGroups": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "costCenterFilterType": "ALL",
      "costCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "profitCenterFilterType": "ALL",
      "profitCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "workBreakdownStructureFilterType": "ALL",
      "workBreakdownStructures": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "objectStatus": "CREATED",
      "securityProfileId": 0,
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "cpiCategoryFilterType": "ALL",
      "cpiCategories": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "scriptProfile": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Bulk Update

HTTP Request

PUT /api/v1/batch-profile/bulk

Interactive Demo

📋 Description: Updates multiple batch profiles in a single request, allowing for efficient management of profile data across the organization.

Parameters

Name	In	Type	Required	Description
body	body	BatchProfileDto	true	Request body containing an array of batch profile data for bulk updates, including relevant identifiers and attributes for efficient processing.

Body Parameters

[
  {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListBatchProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "name": "string",
      "principalPositionType": "LESSEE",
      "erpSystemFilterType": "ALL",
      "erpSystems": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseAreaFilterType": "ALL",
      "leaseAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "businessUnitFilterType": "ALL",
      "businessUnits": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "companyFilterType": "ALL",
      "companyCodes": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string"
        }
      ],
      "departmentFilterType": "ALL",
      "leaseDepartments": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseGroupFilterType": "ALL",
      "leaseGroups": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "costCenterFilterType": "ALL",
      "costCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "profitCenterFilterType": "ALL",
      "profitCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "workBreakdownStructureFilterType": "ALL",
      "workBreakdownStructures": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "objectStatus": "CREATED",
      "securityProfileId": 0,
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "cpiCategoryFilterType": "ALL",
      "cpiCategories": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "scriptProfile": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Search

HTTP Request

POST /api/v1/batch-profile/search

Interactive Demo

📋 Description: Submits a request to search for batch profiles, enabling users to efficiently locate and retrieve specific profile data based on defined criteria.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	BatchProfileDtoFilter	false	Request body containing the criteria for batch profile search, including filters and parameters to refine the search results based on business requirements.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "nameLike": "string",
  "principalPositionTypeEqual": "LESSEE",
  "erpSystemFilterTypeIn": [
    "ALL"
  ],
  "erpSystemsIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseAreaFilterTypeIn": [
    "ALL"
  ],
  "leaseAreasIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "businessUnitFilterTypeIn": [
    "ALL"
  ],
  "businessUnitsIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "companyFilterTypeIn": [
    "ALL"
  ],
  "companyCodesIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string"
    }
  ],
  "departmentFilterTypeIn": [
    "ALL"
  ],
  "leaseDepartmentsIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseGroupFilterTypeIn": [
    "ALL"
  ],
  "leaseGroupsIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "costCenterFilterTypeIn": [
    "ALL"
  ],
  "costCentersIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "profitCenterFilterTypeIn": [
    "ALL"
  ],
  "profitCentersIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "validTo": "2019-08-24",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "workBreakdownStructureFilterTypeIn": [
    "ALL"
  ],
  "workBreakdownStructuresIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "objectStatusIn": [
    "CREATED"
  ],
  "securityProfileIdLike": "string",
  "businessAreaFilterTypeIn": [
    "ALL"
  ],
  "businessAreasIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "functionalAreaFilterTypeIn": [
    "ALL"
  ],
  "functionalAreasIn": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageBatchProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "principalPositionType": "LESSEE",
      "erpSystemFilterType": "ALL",
      "erpSystems": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseAreaFilterType": "ALL",
      "leaseAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "businessUnitFilterType": "ALL",
      "businessUnits": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "companyFilterType": "ALL",
      "companyCodes": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string"
        }
      ],
      "departmentFilterType": "ALL",
      "leaseDepartments": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseGroupFilterType": "ALL",
      "leaseGroups": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "costCenterFilterType": "ALL",
      "costCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "profitCenterFilterType": "ALL",
      "profitCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "workBreakdownStructureFilterType": "ALL",
      "workBreakdownStructures": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "objectStatus": "CREATED",
      "securityProfileId": 0,
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "cpiCategoryFilterType": "ALL",
      "cpiCategories": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "scriptProfile": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Find All

HTTP Request

GET /api/v1/batch-profile

Interactive Demo

📋 Description: Fetches batch profile data, allowing users to access detailed information related to batch processing operations within the system.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, allowing for efficient data retrieval and improved performance when accessing large datasets.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageBatchProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "principalPositionType": "LESSEE",
      "erpSystemFilterType": "ALL",
      "erpSystems": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseAreaFilterType": "ALL",
      "leaseAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "businessUnitFilterType": "ALL",
      "businessUnits": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "companyFilterType": "ALL",
      "companyCodes": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string"
        }
      ],
      "departmentFilterType": "ALL",
      "leaseDepartments": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseGroupFilterType": "ALL",
      "leaseGroups": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "costCenterFilterType": "ALL",
      "costCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "profitCenterFilterType": "ALL",
      "profitCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "workBreakdownStructureFilterType": "ALL",
      "workBreakdownStructures": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "objectStatus": "CREATED",
      "securityProfileId": 0,
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "cpiCategoryFilterType": "ALL",
      "cpiCategories": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "scriptProfile": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Get Profile

HTTP Request

GET /api/v1/batch-profile/{id}/{securityProfileId}

Interactive Demo

📋 Description: Fetches the details of a specific batch profile identified by the provided ID and associated security profile ID, enabling users to access relevant configuration and compliance information.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
securityProfileId	path	integer(int64)	true	Unique identifier for the security profile

Responses

Status	Meaning	Description	Schema
200	OK	OK	BatchProfileDto

Example Responses

{
  "id": 0,
  "name": "string",
  "principalPositionType": "LESSEE",
  "erpSystemFilterType": "ALL",
  "erpSystems": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseAreaFilterType": "ALL",
  "leaseAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "businessUnitFilterType": "ALL",
  "businessUnits": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "companyFilterType": "ALL",
  "companyCodes": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string"
    }
  ],
  "departmentFilterType": "ALL",
  "leaseDepartments": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseGroupFilterType": "ALL",
  "leaseGroups": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "costCenterFilterType": "ALL",
  "costCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "profitCenterFilterType": "ALL",
  "profitCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "validTo": "2019-08-24",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "workBreakdownStructureFilterType": "ALL",
  "workBreakdownStructures": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "objectStatus": "CREATED",
  "securityProfileId": 0,
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "cpiCategoryFilterType": "ALL",
  "cpiCategories": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "scriptProfile": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Get Profile (With User Name And User Name)

HTTP Request

GET /api/v1/batch-profile/{id}/user-name/{userName}

Interactive Demo

📋 Description: Fetches the user profile associated with the specified user name within a given batch profile, enabling efficient access to user-specific information for enhanced data management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
userName	path	string	true	Name of the user

Responses

Status	Meaning	Description	Schema
200	OK	OK	BatchProfileDto

Example Responses

{
  "id": 0,
  "name": "string",
  "principalPositionType": "LESSEE",
  "erpSystemFilterType": "ALL",
  "erpSystems": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseAreaFilterType": "ALL",
  "leaseAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "businessUnitFilterType": "ALL",
  "businessUnits": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "companyFilterType": "ALL",
  "companyCodes": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string"
    }
  ],
  "departmentFilterType": "ALL",
  "leaseDepartments": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "leaseGroupFilterType": "ALL",
  "leaseGroups": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "costCenterFilterType": "ALL",
  "costCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "profitCenterFilterType": "ALL",
  "profitCenters": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "validTo": "2019-08-24",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "workBreakdownStructureFilterType": "ALL",
  "workBreakdownStructures": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "objectStatus": "CREATED",
  "securityProfileId": 0,
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string"
    }
  ],
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "cpiCategoryFilterType": "ALL",
  "cpiCategories": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "scriptProfile": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Batch Profile - Get All Profiles

HTTP Request

GET /api/v1/batch-profile/user-name/{userName}

Interactive Demo

📋 Description: Retrieves the batch profile associated with the specified user name, providing essential user data for analysis and reporting purposes.

Parameters

Name	In	Type	Required	Description
userName	path	string	true	Name of the user

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "name": "string",
    "principalPositionType": "LESSEE",
    "erpSystemFilterType": "ALL",
    "erpSystems": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterType": "ALL",
    "leaseAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterType": "ALL",
    "businessUnits": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterType": "ALL",
    "companyCodes": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterType": "ALL",
    "leaseDepartments": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterType": "ALL",
    "leaseGroups": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterType": "ALL",
    "costCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterType": "ALL",
    "profitCenters": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterType": "ALL",
    "workBreakdownStructures": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatus": "CREATED",
    "securityProfileId": 0,
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "cpiCategoryFilterType": "ALL",
    "cpiCategories": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "scriptProfile": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[BatchProfileDto]	false	none	[Data transfer object representing a collection of user profiles for batch processing, facilitating efficient management and analysis of user data within enterprise applications.]
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» erpSystemId	integer(int64)	false	none	Unique identifier for the erp system
»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
»» countryId	integer(int64)	false	none	Unique identifier for the country
»» countryDisplayId	string	false	none	Unique identifier for the country display
»» name	string	false	none	none
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
»» validTo	string(date)	false	none	Date until which the resource is valid
»» erpSystemId	integer(int64)	false	none	Unique identifier for the erp system
»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
»» status	string	false	none	Status of the resource
»» name	string	false	none	Name of the resource
» filterObjectDto	FilterObjectDto	false	none	Data transfer object representing a set of criteria used to filter data within the application, enabling users to refine search results and enhance decision-making processes.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» profileId	integer(int64)	false	none	Unique identifier for the profile
»» displayId	string	false	none	Unique identifier for the display
»» objectType	string	false	none	Type of the object
» 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.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
» 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
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
workBreakdownStructureFilterType	ALL, LIST

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---