ReportRepositoryAddReportToCase Method (ODataService, String, Object, Boolean, String, String, String, String, String, DateTime, String, String, ICollectionKeyValuePairString, String, String, String)

Scanjour Workflow4 Reference Manual

Note: This API is now obsolete.

A Method to generate report document using reports API

Namespace:  Scanjour.Workflow4.Web.Services.Repositories
Assembly:  Scanjour.Workflow4.Web.Services (in Scanjour.Workflow4.Web.Services.dll) Version: 21.3.0.0 (21.3.0.0)
Syntax

[ObsoleteAttribute("Since release 2020.1. Only used by older processes.")]
public HttpResponseMessage AddReportToCase(
	ODataService context,
	string reportId,
	Object reportParameters,
	bool includeDocumentContents,
	string title,
	string stateValue,
	string recordTypeValue,
	string officerValue,
	string officerCulture,
	DateTime letterDate,
	string fileKeyValue,
	string reportUpdateId,
	ICollection<KeyValuePair<string, string>> customHeaders = null,
	string classification = "",
	string recordSource = ""
)

Parameters

context
Type: ODataService
OData context
reportId
Type: SystemString
The report guid.
reportParameters
Type: SystemObject
The report parameters.
includeDocumentContents
Type: SystemBoolean
Report parameter, if set to true referenced documents content will be included
title
Type: SystemString
Title of the report document to be saved on a case
stateValue
Type: SystemString
State of report document
recordTypeValue
Type: SystemString
Type of report document
officerValue
Type: SystemString
Username of a case Officer
officerCulture
Type: SystemString
Culture code of a case Officer
letterDate
Type: SystemDateTime
Creation date of the report
fileKeyValue
Type: SystemString
Case file the history is saved in
reportUpdateId
Type: SystemString
ID of report to update
customHeaders (Optional)
Type: System.Collections.GenericICollectionKeyValuePairString, String
Headers for report request, like watermark and other props from PDF API
classification (Optional)
Type: SystemString
Confidentiality classification, default from case or PUBLIC if not set
recordSource (Optional)
Type: SystemString
The source to be set on the pdf

Return Value

Type: HttpResponseMessage

[Missing <returns> documentation for "M:Scanjour.Workflow4.Web.Services.Repositories.ReportRepository.AddReportToCase(Scanjour.Process.OData.Client.Proxy.ODataService,System.String,System.Object,System.Boolean,System.String,System.String,System.String,System.String,System.String,System.DateTime,System.String,System.String,System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.String,System.String)"]

Remarks

Compatible version for version 2019.3 and lower
See Also

Reference