LawVu Files (1.0)

Download OpenAPI specification:Download

Apis for files resources

Files

Get files

Gets a list of files in LawVu (with filters)

Request
query Parameters
recordType
string

The record type the file in linked to (Matter, Contract, Organisation etc)

Options:

  • Matter
  • Milestone
  • Task
  • Organisation
  • Contract
  • File
  • InvoiceBatch
  • KnowledgeArticle
  • Folder
  • FolderTemplate
  • KnowledgeLibrary
  • InboundEmail
  • User
  • MessageThread
  • TimelineEntry
  • MatterStatus
  • ContractStatus
  • Message
  • Comment

Enum: "Matter" "Milestone" "Task" "Organisation" "Contract" "File" "InvoiceBatch" "KnowledgeArticle" "Folder" "FolderTemplate" "KnowledgeLibrary" "InboundEmail" "User" "MessageThread" "TimelineEntry" "MatterStatus" "ContractStatus" "Message" "Comment"
recordId
integer <int32>

Format - int32. The record id the file is linked to

skip
integer <int32>

Format - int32. The number of files to skip (used for paging)

folderId
integer or null <int32>

Format - int32. The folder id to get files from

filtering.field
string or null

Field to filter by (optional)

filtering.operator
string

Operator used for filtering (optional)

Options:

  • eq
  • neq
  • lt
  • lte
  • gt
  • gte
  • startswith
  • endswith
  • contains
  • doesnotcon
  • isnull

Enum: "eq" "neq" "lt" "lte" "gt" "gte" "startswith" "endswith" "contains" "doesnotcon" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

Format - int32. The maximum number of files to return

Default: 50

recursive
boolean
Default: false

Set to true in order to include subdirectories and nested files

Default: False

Responses
200

Success

get/v1/files
Response samples 
null

Delete file

Deletes a file in LawVu

Request
path Parameters
fileId
required
integer <int32>

Format - int32. The Id of the file

Responses
200

Success

delete/v1/files/{fileId}

Patch file

Updates a file

Request
path Parameters
fileId
required
integer <int32>

Format - int32. The Id of the file

Request Body schema:

JSON patch definition for the update. Currently only [name] is supported (file rename)

Array
value
object or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

patch/v1/files/{fileId}
Request samples
[
  • {
    }
]

Get file

Get file meta from LawVu

Request
path Parameters
fileId
required
integer <int32>

Format - int32. The Id of the file

Responses
200

Success

get/v1/files/{fileId}
Response samples 
null

Download file

Download file

Request
path Parameters
fileId
required
integer <int32>

Format - int32. The Id of the file

Responses
200

Success

get/v1/files/{fileId}/download
Response samples 
null

Move file

Moves a file. If there is a conflict in the destination, set the ConflictResolution

See notes for destinationId when moving a file to the root folder of a matter or contract

Request
path Parameters
fileId
required
integer <int32>

Format - int32. The Id of the file

destinationId
required
integer or null <int32>

Format - int32. The destination location for the file.
If moving the file to the root folder of the matter or contract, omit this value from the path i.e. 'POST /{fileId}/move/'

query Parameters
conflictResolution
string

Conflict handling

Options:

  • Replace
  • KeepBoth
  • SaveVersion
  • Skip

Enum: "Replace" "KeepBoth" "SaveVersion" "Skip"
Responses
204

Success

post/v1/files/{fileId}/move/{destinationId}

Upload file

Upload a file to LawVu. The body of the post should be the contents of the file.

Request
path Parameters
targetType
required
string

The target entity type in LawVu

Options:

  • Matter
  • Milestone
  • Task
  • Organisation
  • Contract
  • File
  • InvoiceBatch
  • KnowledgeArticle
  • Folder
  • FolderTemplate
  • KnowledgeLibrary
  • InboundEmail
  • User
  • MessageThread
  • TimelineEntry
  • MatterStatus
  • ContractStatus
  • Message
  • Comment

Enum: "Matter" "Milestone" "Task" "Organisation" "Contract" "File" "InvoiceBatch" "KnowledgeArticle" "Folder" "FolderTemplate" "KnowledgeLibrary" "InboundEmail" "User" "MessageThread" "TimelineEntry" "MatterStatus" "ContractStatus" "Message" "Comment"
targetId
required
integer <int32>

Format - int32. The target entity in LawVu

Request Body schema:

The upload details

folderId
integer or null <int32>

Id of the folder for the file upload

isBrowsable
boolean

File is browseable in the files collection

fileData
string or null <binary>

The upload file details

Responses
200

Success

post/v1/files/{targetType}/{targetId}
Request samples
{
  • "folderId": 0,
  • "isBrowsable": true,
  • "fileData": "string"
}
Response samples 
null

Finalise upload

(communicate the outcome) of an individual file upload (which may be one of a set of files being uploaded)

Request
path Parameters
targetType
required
string

The target of the upload

Options:

  • Matter
  • Milestone
  • Task
  • Organisation
  • Contract
  • File
  • InvoiceBatch
  • KnowledgeArticle
  • Folder
  • FolderTemplate
  • KnowledgeLibrary
  • InboundEmail
  • User
  • MessageThread
  • TimelineEntry
  • MatterStatus
  • ContractStatus
  • Message
  • Comment

Enum: "Matter" "Milestone" "Task" "Organisation" "Contract" "File" "InvoiceBatch" "KnowledgeArticle" "Folder" "FolderTemplate" "KnowledgeLibrary" "InboundEmail" "User" "MessageThread" "TimelineEntry" "MatterStatus" "ContractStatus" "Message" "Comment"
targetId
required
integer <int32>

Format - int32. The id of the target type

uploadId
required
integer <int32>

Format - int32. The id of the upload

Request Body schema:

The details of the finalisation

outcome
string

Options:

  • Failed
  • Succeeded
Enum: "Failed" "Succeeded"
conflictResolution
string or null

Options:

  • Replace
  • KeepBoth
  • SaveVersion
  • Skip
Enum: "Replace" "KeepBoth" "SaveVersion" "Skip"
failureReason
string or null
comments
string or null
isSigned
boolean
Responses
200

Success

put/v1/files/{targetType}/{targetId}/uploads/{uploadId}
Request samples
{
  • "outcome": "Failed",
  • "conflictResolution": "Replace",
  • "failureReason": "string",
  • "comments": "string",
  • "isSigned": true
}
Response samples 
null

Folders

Get folders

Gets a list of folders in LawVu

Request
query Parameters
recordId
required
integer <int32>

Format - int32. The record ID the folders are linked to

recordType
required
string

The record type the folders are linked to (Matter, Contract, Organisation etc)

Options:

  • Matter
  • Milestone
  • Task
  • Organisation
  • Contract
  • File
  • InvoiceBatch
  • KnowledgeArticle
  • Folder
  • FolderTemplate
  • KnowledgeLibrary
  • InboundEmail
  • User
  • MessageThread
  • TimelineEntry
  • MatterStatus
  • ContractStatus
  • Message
  • Comment

Enum: "Matter" "Milestone" "Task" "Organisation" "Contract" "File" "InvoiceBatch" "KnowledgeArticle" "Folder" "FolderTemplate" "KnowledgeLibrary" "InboundEmail" "User" "MessageThread" "TimelineEntry" "MatterStatus" "ContractStatus" "Message" "Comment"
parentFolderId
integer or null <int32>

Format - int32. Returns folders under the specified parentd folder ID otherwise it returns them from the root folder

Responses
200

Success

get/v1/folders
Response samples 
[
  {
    "id": 1,
    "name": "Folder 1 test"
  },
  {
    "id": 2,
    "name": "Folder 2 test"
  }
]

Create folder

Creates a folder within a entity, optionally as a subfolder

Request
path Parameters
targetType
required
string

The target type the folder should be created in

Options:

  • Matter
  • Contract

Enum: "Matter" "Contract"
targetId
required
integer <int32>

Format - int32. The target entity in LawVu

Request Body schema:

Details of the folder to create

name
required
string

Name of the folder to create

parentFolderId
integer or null <int32>

The parent folder ID the folder will be created within, otherwise the folder is created at the root of the record.

Responses
201

Success

post/v1/folders/{targetType}/{targetId}
Request samples
{
  • "name": "New Folder",
  • "parentFolderId": 4375767
}
Response samples 
null