Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / attachFileFromSession

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Entity - Requests
  • Class: Entity
  • Required Privilege Level: guest
  • Required Rights: none

Description

This operation attaches a file from the WebDAV session folder to a Request. This operation is only called after a file has been uploaded to WebDAV.

Request Parameters

The attachFileFromSession API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
requestId xs:string Yes This parameter should be set with the Id of a Request.
fileName xs:string Yes This parameter should be set with the name of the file in the WebDAV session folder (e.g. /session/MyFileName.txt) that is to be attached to the supplied Request.
description xs:string Yes This parameter should be set with the description of the file that is to be attached to the supplied Request.
visibility xs:string No This optional parameter can be set with the visibility of the file.

Response Parameters

Name Type Description
fileId xs:string This parameter is set with the Id of the file that is attached.
fileName xs:string This parameter is set with the name of the file that is attached.
filePath xs:string This parameter is set with the WebDAV path of the file that is attached.
fileSize xs:string This parameter is set with the size of the file that is attached.
timeStamp xs:string This parameter is set with the timestamp of the file that is attached.
visibility xs:string This parameter is set with the visibility of the file that is attached.
strErrorMessage xs:string This parameter captures validation errors. The options are "notAllowedToView", "failedToOverwriteExistingFile", "failedToAttachFile" or the exception thrown by data::ntityAttachFile API.
exceptionName xs:string This parameter is deprecated.
exceptionDescription xs:string This parameter is set with the API response when there is an error.

Code Examples

In This Document