View all Document Folder Structure Templates by Workspace
get
/api/restapi/folderTemplate/workspace/{workspaceId}
This endpoint returns document folder structure templates that meet the following requirements:
- The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityDocumentFolderStructureTemplate>
Type:
array
Title:
Show Source
List<ApiEntityDocumentFolderStructureTemplate>
-
Array of:
object ApiEntityDocumentFolderStructureTemplate
Title:
ApiEntityDocumentFolderStructureTemplate
Nested Schema : ApiEntityDocumentFolderStructureTemplate
Type:
object
Title:
Show Source
ApiEntityDocumentFolderStructureTemplate
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the document folder structure and the workspace. Possible values are Owned and Inherited. -
documentFolderStructureTemplateId: integer
(int64)
The system-generated identifier of a document folder structure template. This value should not be provided in create operation request data, however, it is required for update requests.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the document folder structure. -
systemGenerated: boolean
Determines whether a template was created by a user or the system.
-
templateName: string
Maximum Length:
255
The name of the document template. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
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.