Class: GetFolderContentRequest

tibco.objectapi.service.request.GetFolderContentRequest

new GetFolderContentRequest()

Object GetFolderContentRequest Usage: RestApiService.getDocumentService().getFolderContent(request, callback);
Since:
  • 4.0.0

Members

caseRef :string

Query parameter: 'caseref' (optional) A reference to the case (for example, bds-1-com.example.ordemodel.Order-1-2). Can be obtained using getCaseReferencesForDataView.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

depth :number

Query parameter: 'depth' (Java type: int) (optional) The number of levels to recurse the folder structure in the CMS. The default value is -1, which means no limit.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1

folderRef :string

Query parameter: 'folderref' (optional) A reference to the folder. The folderRef can be obtained by a prior call to this API when subordinate folders have been added to the case folder in the CMS.

Note that either caseRef or folderRef must be specified, but not both. Also, some CMIS servers use characters in case references that must be URL encoded. If you are using such a CMIS server, URL encode the case reference, or use the alternative function that passes a GetFolderContentRequestType element.)

Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

metadata :boolean

Query parameter: 'metadata' (optional) Pass true to include document metadata in the response.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false