Jump to

• Request
• Response

Batch Update Document Folder Structure Templates

put

/api/restapi/folderTemplate/batch

Send a request to this endpoint to update one or more document folder structure templates. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

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 Update Document Folder Structure Templates

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

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

Back to Top