Create a Document Folder Structure Template
post
/primeapi/restapi/folderTemplate
Send a request to this endpoint to create a document folder structure template. An application object will be created using the JSON data provided in the request body.
Request
Supported Media Types
- application/json
A document template object.
Root 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.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root 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.
400 Response
Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request.