View Document Folder Structure Templates by Name
get
/primeapi/restapi/folderTemplate/name/{name}
This endpoint returns document folder structure templates that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
Request
Path Parameters
-
name: string
The name of a document template.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityDocumentFolderStructureTemplate
Type:
Show Source
object
-
folderStructureTemplateId(optional):
integer(int64)
The system-generated identifier of a document folder structure template.
-
link(optional):
string(url)
Read Only:
true
-
systemGenerated(optional):
boolean
Determines whether a template was created by a user or the system.
-
templateName(optional):
string
The name of the document template.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId(optional):
integer(int64)
The system-generated identifier of a workspace.
204 Response
Successful operation with no content.
404 Response
The requested document folder structure template does not exist, or you do not have access to it.