Loading
Documentation Powered by ReDoc

DFS Reporting Services API (latest)

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.

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

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

delete/v1.0/reports/categories/{reportCategoryId}
https://example-host/v1.0/reports/categories/{reportCategoryId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "BadRequest",
  • "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:
application/json

The parameter DTO.

name
string Nullable
parentId
integer <int32> Nullable

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.0/reports/categories/{reportCategoryId}
https://example-host/v1.0/reports/categories/{reportCategoryId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "parentId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "BadRequest",
  • "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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.1/reports/definitions/{reportDefinitionId}
https://example-host/v1.1/reports/definitions/{reportDefinitionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "description": "string",
  • "parameters":
    [
    ],
  • "createDate": "2022-03-15T09:48:25Z",
  • "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:
application/json

The parameter DTO.

reportDefinitionKey
required
string

The key of the report definition.

name
required
string

The name of the report definition.

description
string Nullable

A description of the report definition.

template
required
string

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

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v1.1/reports/definitions/{reportDefinitionId}
https://example-host/v1.1/reports/definitions/{reportDefinitionId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportDefinitionKey": "string",
  • "name": "string",
  • "description": "string",
  • "template": "string",
  • "isActive": true,
  • "reportTypeKey": "Contact",
  • "reportCategoryId": 0,
  • "storageMetadataReferenceId": "string"
}

Response samples

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

Generate report. Deprecated

Generates a report from an existing report definition. The report is generated in in the PDF format.
This API is deprecated. Use POST /v1.1/reports/generate instead

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
application/json

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.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/reports/generate
https://example-host/v1.0/reports/generate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportParameters":
    [
    ],
  • "reportDefinitionId": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "report": "string"
}

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 is generated/saved in a PDF format.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
application/json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/reports/generate
https://example-host/v1.1/reports/generate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportDefinitionId": 0,
  • "reportDefinitionKey": "string",
  • "reportParameters":
    [
    ],
  • "generationType": "Download",
  • "fileName": "string",
  • "documentValidityDate": "2022-03-15T09:48:25Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO.

reportDefinitionKey
required
string

The key of of the report definition

name
required
string

The name of the report definition.

description
string Nullable

A description of the report definition.

template
required
string

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

Responses

201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/reports/definitions
https://example-host/v1.1/reports/definitions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportDefinitionKey": "string",
  • "name": "string",
  • "description": "string",
  • "template": "string",
  • "isActive": true,
  • "reportTypeKey": "Contact",
  • "reportCategoryId": 0,
  • "storageMetadataReferenceId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/reports/definitions/search
https://example-host/v1.1/reports/definitions/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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
Copy
 Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Generate contact’s report. Deprecated

Generates contact’s report considering its hierarchical access. The report is generated in in the PDF format.
This API is deprecated. Use POST /v1.1/reports/contacts/{contactId}/generate instead

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:
application/json

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.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/reports/contacts/{contactId}/generate
https://example-host/v1.0/reports/contacts/{contactId}/generate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportParameters":
    [
    ],
  • "reportDefinitionId": 1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "report": "string"
}

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 is generated/saved in a PDF format. The endpoint contemplates the hierarchical access validation to member.

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:
application/json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/reports/contacts/{contactId}/generate
https://example-host/v1.1/reports/contacts/{contactId}/generate

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "reportDefinitionId": 0,
  • "reportDefinitionKey": "string",
  • "reportParameters":
    [
    ],
  • "generationType": "Download",
  • "fileName": "string",
  • "documentValidityDate": "2022-03-15T09:48:25Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Request data

enumerationTypes
Array of strings (EnumerationType) Nullable
Items Value: "ReportType"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/reports/enumerations
https://example-host/v1.0/reports/enumerations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enumerationTypes":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/reports/categories/search
https://example-host/v1.0/reports/categories/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "name": "string",
  • "parentIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO.

name
string Nullable
parentId
integer <int32> Nullable

Responses

201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/reports/categories
https://example-host/v1.0/reports/categories

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "parentId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0
}