Jump to

• Request
• Response

Update a Document Folder Structure Template

put

/api/restapi/folderTemplate

Send a request to this endpoint to update a document folder structure template. An application object with an ID value that matches the ID value provided in the JSON object in the request body 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 : 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

• associationType: string
  Read 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: string
  Read Only: true

  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  Deprecated. As of 24.4.
  The push down type of the document folder structure.
• systemGenerated: boolean
  Read 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.

{
    "title":"ApiEntityDocumentFolderStructureTemplateInput",
    "required":[
        "templateName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "templateName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the document template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The push down type of the document folder structure.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The type of association in the relationship between the document folder structure and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "systemGenerated":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Determines whether a template was created by a user or the system.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "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 Update a Document Folder Structure Template

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top