Loading
API docs by Redocly

DFS Reporting Services API (latest)

Download OpenAPI specification:

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.

Reporting

Delete report category.

Deletes report categories.

Authorizations:
Bearer
path Parameters
reportCategoryId
required
integer <int32>

The ID of the report category

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update report category.

Updates report categories.

Authorizations:
Bearer
path Parameters
reportCategoryId
required
integer <int32>

The ID of the report category

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

name
string or null
parentId
integer or null <int32>

Responses

Request samples

Content type
{
  • "name": "string",
  • "parentId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get report definition by ID.

Gets a report definition by ID.

Authorizations:
Bearer
path Parameters
reportDefinitionId
required
integer <int32>

The ID of the report definition

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "description": "string",
  • "parameters": [
    ],
  • "createDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "template": "string",
  • "reportType": {
    },
  • "reportCategory": {
    },
  • "storageMetadataReference": {
    }
}

Update report definition.

Updates an existing report definition.

Authorizations:
Bearer
path Parameters
reportDefinitionId
required
integer <int32>

The ID of the report definition

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

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 or null

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 or null <int32>
storageMetadataReferenceId
string or null

Responses

Request samples

Content type
{
  • "reportDefinitionKey": "string",
  • "name": "string",
  • "description": "string",
  • "template": "string",
  • "isActive": true,
  • "reportTypeKey": "Contact",
  • "reportCategoryId": 0,
  • "storageMetadataReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Generate report and/or upload report to DMS

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" '.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

reportDefinitionId
integer or null <int32>

The ID of an existing report definition.

reportDefinitionKey
string or null

The key of an existing report definition.

Array of objects or null (ReportParameter)

The list of report parameters to use for the report generation.

generationType
string (ReportGenerationType)
Enum: "Download" "Save" "DownloadAndSave"
fileName
string or null
documentValidityDate
string or null <date-time>
exportFormat
string (ReportExportFormat)
Enum: "PDF" "CSV" "XLSX" "PPTX" "RTF" "IMAGE" "DOCX"

Responses

Request samples

Content type
{
  • "reportParameters": [
    ],
  • "generationType": "Download",
  • "exportFormat": "XLSX",
  • "reportDefinitionId": 1
}

Response samples

Content type
application/json
{
  • "report": "string",
  • "dmsDocumentId": 0
}

Create report definition.

Creates a new report definition.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

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 or null

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 or null <int32>
storageMetadataReferenceId
string or null

Responses

Request samples

Content type
{
  • "reportDefinitionKey": "string",
  • "name": "string",
  • "description": "string",
  • "template": "string",
  • "isActive": true,
  • "reportTypeKey": "Contact",
  • "reportCategoryId": 0,
  • "storageMetadataReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Search report definitions.

Searches report definitions by given criteria.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
searchText
string or null

The text to search for in the name, key and description fields

name
string or null

The filter for the Name property

key
string or null

The filter for the Key property

description
string or null

The filter for the Description property

createDateFrom
string or null <date-time>

The filter for the CreateDate property to be starting from the specified date

createDateTo
string or null <date-time>

The filter for the CreateDate property to be until the specified date

isActive
boolean or null

The filter for the IsActive property

reportCategoryIds
Array of integers or null <int32> [ items <int32 > ]
reportTypeKeys
Array of strings or null (ReportTypeKey)
Enum: "Contact" "LegalEntity" "Member" "Portfolio" "Proposal"
storageMetadataReferenceId
string or null

Responses

Request samples

Content type
{
  • "searchText": "test",
  • "createDateFrom": "2021-08-05T00:00:00",
  • "createDateTo": "2021-09-01T00:00:00",
  • "isActive": true,
  • "reportCategoryIds": [
    ],
  • "reportTypeKeys": [
    ],
  • "storageMetadataReferenceId": "test",
  • "sortBy": "Name",
  • "sortOrder": "Descending",
  • "page": 1,
  • "pageSize": 5
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Generate report and/or upload report to DMS with hierarchical validations

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" '.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The ID of the contact to create the report for

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

reportDefinitionId
integer or null <int32>

The ID of an existing report definition.

reportDefinitionKey
string or null

The key of an existing report definition.

Array of objects or null (ReportParameter)

The list of report parameters to use for the report generation.

generationType
string (ReportGenerationType)
Enum: "Download" "Save" "DownloadAndSave"
fileName
string or null
documentValidityDate
string or null <date-time>
exportFormat
string (ReportExportFormat)
Enum: "PDF" "CSV" "XLSX" "PPTX" "RTF" "IMAGE" "DOCX"

Responses

Request samples

Content type
{
  • "reportParameters": [
    ],
  • "generationType": "Download",
  • "exportFormat": "XLSX",
  • "reportDefinitionId": 1
}

Response samples

Content type
application/json
{
  • "report": "string",
  • "dmsDocumentId": 0
}

Get enumerations from multiple tables

Retrieves a list of enumerations for multiple tables. The tables available are: ReportType

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Request data

enumerationTypes
Array of strings or null (EnumerationType)
Value: "ReportType"

Responses

Request samples

Content type
{
  • "enumerationTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "enumerations": [
    ]
}

Search report categories.

Searches report categories.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
name
string or null
parentIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "name": "string",
  • "parentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Create report category.

Creates report categories.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

name
string or null
parentId
integer or null <int32>

Responses

Request samples

Content type
{
  • "name": "string",
  • "parentId": 0
}

Response samples

Content type
application/json
{
  • "id": 0
}