Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : List<ApiEntityDocumentFolderStructureTemplateInput>

Type: array

Title: List<ApiEntityDocumentFolderStructureTemplateInput>

Show Source

• 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

{
    "title":"List<ApiEntityDocumentFolderStructureTemplateInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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.

• documentFolderStructureTemplateId
• templateName,workspaceId
• templateName,workspaceCode

Show Source

• 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.
• templateName(required): string
  Maximum Length: 255

  The name of the document template.
• 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.

{
    "title":"ApiEntityDocumentFolderStructureTemplateInput",
    "required":[
        "templateName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "templateName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the document template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documentFolderStructureTemplateId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a DocumentFolderStructureTemplate object, a unique DocumentFolderStructureTemplate object can be identified by the following combinations of the fields.<ul><li>documentFolderStructureTemplateId</li><li>templateName,workspaceId</li><li>templateName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Document Folder Structure Templates

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityDocumentFolderStructureTemplate>

Type: array

Title: List<ApiEntityDocumentFolderStructureTemplate>

Show Source

• Array of: object ApiEntityDocumentFolderStructureTemplate
  Title: ApiEntityDocumentFolderStructureTemplate

{
    "title":"List<ApiEntityDocumentFolderStructureTemplate>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityDocumentFolderStructureTemplate

Type: object

Title: ApiEntityDocumentFolderStructureTemplate

Show Source

• 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.

{
    "title":"ApiEntityDocumentFolderStructureTemplate",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the document folder structure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the document folder structure and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "templateName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the document template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documentFolderStructureTemplateId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "systemGenerated":{
            "type":"boolean",
            "description":"Determines whether a template was created by a user or the system.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request.

Back to Top