Objective

It allows to search in the FOLDER_ITEM table to retrieve one specific child of one folder. It is possible to define which child of the folder to retrieve with the fields “isFirst” and “nextItem”. DST must be provided.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
dbSchemaDatabase schema. By default is set to “DOCSADM” if an empty string is passed.String
parentDocNumberFolder document number. Only one document number is allowed.String
isFirstIf “true” the method retrieves the first object of the content folder list (if exists).String
nextItemThe System_ID of the next object of the content folder list. If “0” then it is the last object of the content folder list.

Note:

See the following examples about how to use isFirst and nextItem fields on this method.

Isfirst (true), nextItem (0)  the first child of the folder if only one child exists.
Isfirst (false), nexItem (0)  the last child if there is more than one child.
Isfirst (true) y nextItem (system_id)  the first child if there is more than one child, etc…

This method has been designed to be used in combination with methods “UploadDocumentToFolder” and “UploadDocumentAsBinaryToFolder”. Review the documentation of these methods to properly define the children’s order in folders.

String
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString

Rest Invoke

  • http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
  • UriTemplate:
    • “/GetFolderItem/?library={library}/{parentDocNumber}&user={user}&password={password}&dbSchema={dbSchema}/{isFirst}/{nextItem}&client={client}&project={project}”
    • “/GetFolderItemDST/?library={library}/{parentDocNumber}&user={user}&dst={dst}&dbSchema={dbSchema}/{isFirst}/{nextItem}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/GetFolderItem/?library=DMTESTLEGAL&parentDocNumber=5&user=admin&password=owc123&dbSchema=DOCSADM&isFirst=true&nextItem=1881

This method returns the System_ID (from FOLDER_ITEM table) of the specified child document (if it exists).

DST Example

http://localhost:8732/GSService/xml/GetFolderItemDST/?library=DMTESTLEGAL&parentDocNumber=5&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&dbSchema=DOCSADM&isFirst=true&nextItem=1881

Error

Detailed errors can be found in the error log. See Appendix D for more information about the edocs.log file.