Report Profile

Report Profile - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the detailed profile report associated with the specified ID, providing insights into key metrics and performance indicators 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	ResponseReportProfileDto

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
}

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

Report Profile - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the report profile identified by the specified ID, allowing users to modify existing profile details to ensure accurate and relevant reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ReportProfileDto	true	Request body containing the updated report 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,
  "calendarType": "REGULAR_CALENDAR",
  "fiscalVariant": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "isCalendarYear": true,
    "yearDependent": true,
    "erpSystemDisplayId": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "vendorFilterType": "ALL",
  "vendors": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "leaseClassificationFilterType": "ALL",
  "leaseClassifications": "string",
  "accountingStandardType": "string",
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "scriptProfile": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReportProfileDto

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
}

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

Report Profile - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified report profile identified by its unique ID, ensuring the removal of outdated or unnecessary reporting configurations from the system.

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

Report Profile - Create Or Update

HTTP Request

PUT /api/v1/report-profile/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a report profile based on the provided data, ensuring that users can maintain accurate and up-to-date reporting configurations.

Parameters

Name	In	Type	Required	Description
body	body	ReportProfileDto	true	Request body containing the report profile data, including identification details and configuration settings for creating or updating the report profile.

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,
  "calendarType": "REGULAR_CALENDAR",
  "fiscalVariant": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "isCalendarYear": true,
    "yearDependent": true,
    "erpSystemDisplayId": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "vendorFilterType": "ALL",
  "vendors": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "leaseClassificationFilterType": "ALL",
  "leaseClassifications": "string",
  "accountingStandardType": "string",
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "scriptProfile": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseReportProfileDto

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
}

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

Report Profile - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple report profiles in bulk, enabling efficient management of reporting configurations to enhance data analysis and decision-making processes.

Parameters

Name	In	Type	Required	Description
body	body	ReportProfileDto	true	Request body containing an array of report profile objects for bulk creation or update, including relevant attributes and metadata for efficient data management.

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReportProfileDto

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,
      "calendarType": "REGULAR_CALENDAR",
      "fiscalVariant": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "isCalendarYear": true,
        "yearDependent": true,
        "erpSystemDisplayId": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "vendorFilterType": "ALL",
      "vendors": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "leaseClassificationFilterType": "ALL",
      "leaseClassifications": "string",
      "accountingStandardType": "string",
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "scriptProfile": true
    }
  ]
}

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

Report Profile - Bulk Update

HTTP Request

PUT /api/v1/report-profile/bulk

Interactive Demo

📋 Description: Updates multiple report profiles in bulk, allowing for efficient management and modification of reporting configurations to enhance data analysis and decision-making processes.

Parameters

Name	In	Type	Required	Description
body	body	ReportProfileDto	true	Request body containing an array of report profile objects for bulk updates, including relevant identifiers and updated attributes.

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListReportProfileDto

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,
      "calendarType": "REGULAR_CALENDAR",
      "fiscalVariant": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "isCalendarYear": true,
        "yearDependent": true,
        "erpSystemDisplayId": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "vendorFilterType": "ALL",
      "vendors": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "leaseClassificationFilterType": "ALL",
      "leaseClassifications": "string",
      "accountingStandardType": "string",
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "scriptProfile": true
    }
  ]
}

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

Report Profile - Search

HTTP Request

POST /api/v1/report-profile/search

Interactive Demo

📋 Description: Submits a request to search for report profiles, enabling users to efficiently locate specific profiles 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	ReportProfileDtoFilter	false	Request body containing search criteria and filters for retrieving specific report profiles based on user-defined parameters.

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",
  "calendarTypeEqual": "REGULAR_CALENDAR",
  "fiscalVariantEqual": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "isCalendarYear": true,
    "yearDependent": true,
    "erpSystemDisplayId": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReportProfileDto

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,
      "calendarType": "REGULAR_CALENDAR",
      "fiscalVariant": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "isCalendarYear": true,
        "yearDependent": true,
        "erpSystemDisplayId": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "vendorFilterType": "ALL",
      "vendors": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "leaseClassificationFilterType": "ALL",
      "leaseClassifications": "string",
      "accountingStandardType": "string",
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "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

Report Profile - Find All

HTTP Request

GET /api/v1/report-profile

Interactive Demo

📋 Description: Fetches the report profile details, providing insights into key performance metrics and enabling informed decision-making for business operations.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results returned from the report profile endpoint should be paginated, enhancing the efficiency of data retrieval for large datasets.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReportProfileDto

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,
      "calendarType": "REGULAR_CALENDAR",
      "fiscalVariant": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "isCalendarYear": true,
        "yearDependent": true,
        "erpSystemDisplayId": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "vendorFilterType": "ALL",
      "vendors": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "leaseClassificationFilterType": "ALL",
      "leaseClassifications": "string",
      "accountingStandardType": "string",
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "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

Report Profile - Get Profile

HTTP Request

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

Interactive Demo

📋 Description: Fetches the detailed report profile associated with the specified identifiers, enabling users to access critical insights for informed decision-making.

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	ReportProfileDto

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,
  "calendarType": "REGULAR_CALENDAR",
  "fiscalVariant": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "isCalendarYear": true,
    "yearDependent": true,
    "erpSystemDisplayId": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "vendorFilterType": "ALL",
  "vendors": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "leaseClassificationFilterType": "ALL",
  "leaseClassifications": "string",
  "accountingStandardType": "string",
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "scriptProfile": true
}

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

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

HTTP Request

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

Interactive Demo

📋 Description: Fetches the user profile report associated with a specific user name, identified by the provided ID, to facilitate targeted analysis and decision-making.

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	ReportProfileDto

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,
  "calendarType": "REGULAR_CALENDAR",
  "fiscalVariant": {
    "id": 0,
    "displayId": "string",
    "status": "CREATED",
    "isCalendarYear": true,
    "yearDependent": true,
    "erpSystemDisplayId": "string"
  },
  "assetClassFilterType": "ALL",
  "assetClasses": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "functionalAreaFilterType": "ALL",
  "functionalAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "businessAreaFilterType": "ALL",
  "businessAreas": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "vendorFilterType": "ALL",
  "vendors": [
    {
      "id": 0,
      "displayId": "string"
    }
  ],
  "leaseClassificationFilterType": "ALL",
  "leaseClassifications": "string",
  "accountingStandardType": "string",
  "filterObjectDto": {
    "id": 0,
    "profileId": 0,
    "displayId": "string",
    "objectType": "string"
  },
  "scriptProfile": true
}

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

Report Profile - Get All Profiles

HTTP Request

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

Interactive Demo

📋 Description: Fetches the report profile associated with the specified user name, providing insights into user-specific data and preferences for enhanced decision-making.

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,
    "calendarType": "REGULAR_CALENDAR",
    "fiscalVariant": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    },
    "assetClassFilterType": "ALL",
    "assetClasses": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "functionalAreaFilterType": "ALL",
    "functionalAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "businessAreaFilterType": "ALL",
    "businessAreas": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "vendorFilterType": "ALL",
    "vendors": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "leaseClassificationFilterType": "ALL",
    "leaseClassifications": "string",
    "accountingStandardType": "string",
    "filterObjectDto": {
      "id": 0,
      "profileId": 0,
      "displayId": "string",
      "objectType": "string"
    },
    "scriptProfile": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ReportProfileDto]	false	none	[Data transfer object representing a customizable report profile, encapsulating user-defined parameters and preferences for generating tailored reports within the enterprise system.]
» 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	Array of ERP system identifiers associated with the report profile, enabling integration and data synchronization across enterprise resource planning platforms.
»» 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	Array of designated lease areas associated with the report profile, facilitating effective management and analysis 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 report profile, facilitating targeted analysis and reporting 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
» companyFilterType	string	true	none	Type of the company filter
» companyCodes	[CompanyLiteDto]	false	none	An array of unique company codes associated with the report profile, enabling precise identification and categorization of data within the reporting framework.
»» 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	Array of departments associated with the lease, providing insights into the organizational structure relevant to lease management.
»» 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 report profile, used to categorize and manage leasing data effectively.
»» 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 center identifiers associated with the report profile, enabling detailed financial analysis 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	An array of profit center identifiers used to categorize and analyze financial performance 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	Array of work breakdown structures that define the hierarchical decomposition of project deliverables for effective resource allocation and project management.
»» 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
» calendarType	string	true	none	Type of the calendar
» fiscalVariant	FiscalVariantLiteDto	false	none	Data transfer object representing a simplified fiscal variant, encapsulating essential financial attributes and metadata for streamlined reporting and analysis within financial management processes.
»» 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
»» isCalendarYear	boolean	false	none	Whether the resource is calendar year
»» yearDependent	boolean	false	none	Indicates whether the fiscal variant is dependent on the specific year, impacting financial reporting and planning processes.
»» erpSystemDisplayId	string	false	none	Unique identifier for the erp system display
» assetClassFilterType	string	false	none	Type of the asset class filter
» assetClasses	[BaseId]	false	none	List of asset classes associated with the report profile, enabling users to categorize and analyze financial data effectively.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
» functionalAreaFilterType	string	false	none	Type of the functional area filter
» functionalAreas	[BaseId]	false	none	Array of functional areas associated with the report profile, enabling targeted analysis and reporting within the business context.
» businessAreaFilterType	string	false	none	Type of the business area filter
» businessAreas	[BaseId]	false	none	An array representing the various business areas associated with the report profile, enabling targeted analysis and reporting within the organization.
» vendorFilterType	string	false	none	Type of the vendor filter
» vendors	[BaseId]	false	none	List of vendors associated with the report profile, enabling efficient management and analysis of vendor-related data.
» leaseClassificationFilterType	string	false	none	Type of the lease classification filter
» leaseClassifications	string	false	none	Defines the classification of the lease, providing essential categorization for effective management and reporting within the system.
» accountingStandardType	string	false	none	Type of the accounting standard
» 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
» scriptProfile	boolean	false	none	Indicates whether the report profile is associated with a script, enabling tailored reporting capabilities for enhanced analysis.

Enumerated Values

Attribute	Value
assetClassFilterType	ALL, LIST
businessAreaFilterType	ALL, LIST
businessUnitFilterType	ALL, LIST
calendarType	FISCAL_VARIANT, REGULAR_CALENDAR, _360
companyFilterType	ALL, LIST
costCenterFilterType	ALL, LIST
departmentFilterType	ALL, LIST
erpSystemFilterType	ALL, LIST
functionalAreaFilterType	ALL, LIST
leaseAreaFilterType	ALL, LIST
leaseClassificationFilterType	ALL, LIST
leaseGroupFilterType	ALL, LIST
objectStatus	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
principalPositionType	LESSEE, LESSOR
profitCenterFilterType	ALL, LIST
status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
vendorFilterType	ALL, LIST
workBreakdownStructureFilterType	ALL, LIST

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

---