Jump to

• Request
• Response

View Document Folder Structure Templates by Name

get

/api/restapi/folderTemplate/name/{templateName}

This endpoint returns document folder structure templates that meet the following requirements:

• The object has a name that matches the value of the {templateName} path parameter.

Request

Path Parameters

• templateName(required): string
  The name of a folder template.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

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"
            ]
        },
        "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":"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"
            ]
        },
        "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":"The push down type of the document folder structure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "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"
            ]
        },
        "systemGenerated":{
            "type":"boolean",
            "description":"Determines whether a template was created by a user or the system.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

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.

Back to Top