Download OpenAPI specification:Download
Contains methods to create and render reports.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Deletes report categories.
| reportCategoryId required | integer <int32> The ID of the report category |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Updates report categories.
| reportCategoryId required | integer <int32> The ID of the report category |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| name | string Nullable |
| parentId | integer <int32> Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "parentId": 0
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a report definition by ID.
| reportDefinitionId required | integer <int32> The ID of the report definition |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "id": 0,
- "key": "string",
- "name": "string",
- "description": "string",
- "parameters": [
- {
- "name": "string",
- "type": "Boolean",
- "isRequired": true
}
], - "createDate": "2023-10-25T07:53:50Z",
- "isActive": true,
- "template": "string",
- "reportType": {
- "key": "Contact",
- "name": "string",
- "id": 0
}, - "reportCategory": {
- "id": 0,
- "name": "string"
}, - "storageMetadataReference": {
- "id": 0,
- "name": "string"
}
}Updates an existing report definition.
| reportDefinitionId required | integer <int32> The ID of the report definition |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| reportDefinitionKey required | string non-empty The key of the report definition. |
| name required | string non-empty The name of the report definition. |
| description | string Nullable A description of the report definition. |
| template required | string non-empty The Base64 encoded report definition template. |
| isActive | boolean Indicates if the report definition is active. |
| reportTypeKey required | string (ReportTypeKey) Enum: "Contact" "LegalEntity" "Member" "Portfolio" "Proposal" |
| reportCategoryId | integer <int32> Nullable |
| storageMetadataReferenceId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "reportDefinitionKey": "string",
- "name": "string",
- "description": "string",
- "template": "string",
- "isActive": true,
- "reportTypeKey": "Contact",
- "reportCategoryId": 0,
- "storageMetadataReferenceId": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Generates a report from an existing report definition and/or uploads the report to DMS (Document Management System). The report can be generated/saved in the following formats: PDF, CSV, XLSX, PPTX, RTF, IMAGE and DOCX.
Note: SVG images as part of a report template are not recommended for non-PDF export formats. In case an SVG image needs to be used, the following condition should be used in the image element value: '= RenderingFormat.Name = "PDF" ? "Base64 of SVG Image" : "Base64 of Raster image format" '.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| reportDefinitionId | integer <int32> Nullable The ID of an existing report definition. |
| reportDefinitionKey | string Nullable The key of an existing report definition. |
| reportParameters | Array of objects (ReportParameter) Nullable The list of report parameters to use for the report generation. |
| generationType | string (ReportGenerationType) Enum: "Download" "Save" "DownloadAndSave" |
| fileName | string Nullable |
| documentValidityDate | string <date-time> Nullable |
| exportFormat | string (ReportExportFormat) Enum: "PDF" "CSV" "XLSX" "PPTX" "RTF" "IMAGE" "DOCX" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "reportParameters": [
- {
- "name": "ConnectionString",
- "value": "Persist Security Info=true;Data Source=.;Initial Catalog=additiv-ci-mis;Integrated Security=True;"
}, - {
- "name": "ContactId",
- "value": "1"
}
], - "generationType": "Download",
- "exportFormat": "XLSX",
- "reportDefinitionId": 1
}{- "report": "string",
- "dmsDocumentId": 0
}Creates a new report definition.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| reportDefinitionKey required | string non-empty The key of of the report definition |
| name required | string non-empty The name of the report definition. |
| description | string Nullable A description of the report definition. |
| template required | string non-empty The Base64 encoded report definition template. |
| isActive | boolean Indicates if the report definition is active. |
| reportTypeKey required | string (ReportTypeKey) Enum: "Contact" "LegalEntity" "Member" "Portfolio" "Proposal" |
| reportCategoryId | integer <int32> Nullable |
| storageMetadataReferenceId | string Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "reportDefinitionKey": "string",
- "name": "string",
- "description": "string",
- "template": "string",
- "isActive": true,
- "reportTypeKey": "Contact",
- "reportCategoryId": 0,
- "storageMetadataReferenceId": "string"
}{- "id": 0
}Searches report definitions by given criteria.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| page | integer <int32> |
| pageSize | integer <int32> |
| sortBy | string Nullable |
| sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
| searchText | string Nullable The text to search for in the name, key and description fields |
| name | string Nullable The filter for the Name property |
| key | string Nullable The filter for the Key property |
| description | string Nullable The filter for the Description property |
| createDateFrom | string <date-time> Nullable The filter for the CreateDate property to be starting from the specified date |
| createDateTo | string <date-time> Nullable The filter for the CreateDate property to be until the specified date |
| isActive | boolean Nullable The filter for the IsActive property |
| reportCategoryIds | Array of integers <int32> Nullable |
| reportTypeKeys | Array of strings (ReportTypeKey) Nullable Items Enum: "Contact" "LegalEntity" "Member" "Portfolio" "Proposal" |
| storageMetadataReferenceId | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "searchText": "test",
- "createDateFrom": "2021-08-05T00:00:00",
- "createDateTo": "2021-09-01T00:00:00",
- "isActive": true,
- "reportCategoryIds": [
- 1,
- 2
], - "reportTypeKeys": [
- "Contact",
- "Member"
], - "storageMetadataReferenceId": "test",
- "sortBy": "Name",
- "sortOrder": "Descending",
- "page": 1,
- "pageSize": 5
}{- "results": [
- {
- "id": 0,
- "key": "string",
- "name": "string",
- "description": "string",
- "createDate": "2023-10-25T07:53:50Z",
- "isActive": true,
- "reportType": {
- "key": "Contact",
- "name": "string",
- "id": 0
}, - "reportCategory": {
- "id": 0,
- "name": "string"
}, - "storageMetadataReference": {
- "id": 0,
- "name": "string"
}
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Generates a report from an existing report definition and/or uploads the report to DMS (Document Management System). The report can be generated/saved in the following formats: PDF, CSV, XLSX, PPTX, RTF, IMAGE and DOCX. The endpoint contemplates the hierarchical access validation to member.
Note: SVG images as part of a report template are not recommended for non-PDF export formats. In case an SVG image needs to be used, the following condition should be used in the image element value: '= RenderingFormat.Name = "PDF" ? "Base64 of SVG Image" : "Base64 of Raster image format" '.
| contactId required | integer <int32> The ID of the contact to create the report for |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| reportDefinitionId | integer <int32> Nullable The ID of an existing report definition. |
| reportDefinitionKey | string Nullable The key of an existing report definition. |
| reportParameters | Array of objects (ReportParameter) Nullable The list of report parameters to use for the report generation. |
| generationType | string (ReportGenerationType) Enum: "Download" "Save" "DownloadAndSave" |
| fileName | string Nullable |
| documentValidityDate | string <date-time> Nullable |
| exportFormat | string (ReportExportFormat) Enum: "PDF" "CSV" "XLSX" "PPTX" "RTF" "IMAGE" "DOCX" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "reportParameters": [
- {
- "name": "ConnectionString",
- "value": "Persist Security Info=true;Data Source=.;Initial Catalog=additiv-ci-mis;Integrated Security=True;"
}, - {
- "name": "ContactId",
- "value": "1"
}
], - "generationType": "Download",
- "exportFormat": "XLSX",
- "reportDefinitionId": 1
}{- "report": "string",
- "dmsDocumentId": 0
}Retrieves a list of enumerations for multiple tables. The tables available are: ReportType
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
| enumerationTypes | Array of strings (EnumerationType) Nullable Items Value: "ReportType" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "enumerationTypes": [
- "ReportType"
]
}{- "enumerations": [
- {
- "name": "ReportType",
- "values": [
- {
- "id": 0,
- "name": "string",
- "key": "string"
}
]
}
]
}Searches report categories.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| page | integer <int32> |
| pageSize | integer <int32> |
| sortBy | string Nullable |
| sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
| name | string Nullable |
| parentIds | Array of integers <int32> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "name": "string",
- "parentIds": [
- 0
]
}{- "results": [
- {
- "id": 0,
- "name": "string",
- "parentId": 0,
- "childrenIds": [
- 0
]
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Creates report categories.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
| name | string Nullable |
| parentId | integer <int32> Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "parentId": 0
}{- "id": 0
}