Batch Create Document Folder Structure Templates
post
/api/restapi/folderTemplate/batch
Send a request to this endpoint to create one or more document folder structure templates. An application object will be created for each JSON object provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityDocumentFolderStructureTemplateInput>
Type:
array
Title:
Show Source
List<ApiEntityDocumentFolderStructureTemplateInput>
-
Array of:
object ApiEntityDocumentFolderStructureTemplateInput
Title:
ApiEntityDocumentFolderStructureTemplateInput
This entity represents a DocumentFolderStructureTemplate object, a unique DocumentFolderStructureTemplate object can be identified by the following combinations of the fields.- documentFolderStructureTemplateId
- templateName,workspaceId
- templateName,workspaceCode
Nested Schema : ApiEntityDocumentFolderStructureTemplateInput
Type:
object
Title:
ApiEntityDocumentFolderStructureTemplateInput
This entity represents a DocumentFolderStructureTemplate object, a unique DocumentFolderStructureTemplate object can be identified by the following combinations of the fields.
Show Source
- documentFolderStructureTemplateId
- templateName,workspaceId
- templateName,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.4.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)Read Only:true
Deprecated. As of 24.4.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
pushDownType: stringRead Only:true
Allowed Values:[ "MANUAL", "AUTOMATIC" ]
Deprecated. As of 24.4.The push down type of the document folder structure. -
systemGenerated: booleanRead Only:true
Deprecated. As of 24.4.Determines whether a template was created by a user or the system. -
templateName(required): string
Maximum Length:
255
The name of the document template. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
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.
400 Response
Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request.