FilePaths

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Common/FilePaths

Represents a queryable file path.

GUID

D4041A7A-385E-46FB-81A7-75F1BE942EF6

Required permission

Show paths

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the file path.
Path String The server-local path of the file path.

  • Max length is 255
  • Not nullable
  • Unique
Description String The description of the file path.

  • Max length is 200
Active Boolean Specifies whether the file path is active or not.
 Introduced in version 2.45
Category Int32 The category of the file path.

  • FileViewer: 1
  • ExportAccounting: 2
  • ExportAgent: 3
  • ExportFactoring: 4
  • ExportServerPrinter: 5
 Introduced in version 26.3
FileType Int32 The file type of the file path.

  • FileSystem: 0
  • SharePoint: 1
 Introduced in version 26.3
PathType Int32 The path type of the file path.

  • LocalServerDrives: 1
  • UncServerShare: 2
  • SharePoint: 4
  • AvailablePaths: 8
  • RegisteredPaths: 16
  • LocalClient: 32

  • Bitmask
 Introduced in version 26.3

Example

{
  "Id": 0,
  "Path": null,
  "Description": null,
  "Active": false,
  "Category": 0,
  "FileType": 0,
  "PathType": 0
}