Skip to content

LawVu Files (1.0)

Apis for files resources

Download OpenAPI description
LawVu Files.openapi.json
LawVu Files.openapi.yaml
Languages
Servers
Sandbox API
https://api-sandbox.lawvu.com/file-apis
Production API
https://api.lawvu.com/file-apis

Files

Operations

Get files

Request

Gets a list of files in LawVu (with filters)

Query
recordTypestring

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"
recordIdinteger(int32)

The record id the file is linked to

skipinteger(int32)

The number of files to skip (used for paging)

folderIdinteger(int32)

The folder id to get files from

filtering.fieldstring

Field to filter by (optional)

filtering.operatorstring

Operator used for filtering (optional)

Enum"eq""neq""lt""lte""gt""gte""startswith""endswith""contains""doesnotcon"
filtering.valuestring

Value to filter by (optional)

sorting.directionstring

Set the sorting direction

Enum"asc""desc"
sorting.fieldstring

Set the sorting fields

takeinteger(int32)

The maximum number of files to return

Default: 50

Default 50
recursiveboolean

Set to true in order to include subdirectories and nested files

Default: False

Default false
No request payload

Responses

Success

Body
dataArray of objects or null(FileListItem)

Represents a single page of processed data.

totalinteger(int32)

The total number of records available.

Response
No response example

Get file

Request

Get file meta from LawVu

Path
fileIdinteger(int32)required

The Id of the file

No request payload

Responses

Success

Body
idinteger(int32)
typestring

Options:

  • Folder
  • File
Enum"Folder""File"
sizeinteger(int64)
descriptionstring or null
namestring or null
versioninteger(int32)
createdDateUtcstring(date-time)
uploadedBystring or null
pathstring or null
isLockedbooleanread-only
isPrivateboolean
lockExpiryUtcstring or null(date-time)
documentIdstring or null
externalContentTypestring or null
externalWebUristring or null
parentRecordIdinteger(int32)
parentRecordTypestring

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"
Response
No response example

Delete file

Request

Deletes a file in LawVu

Path
fileIdinteger(int32)required

The Id of the file

No request payload

Responses

Success

Patch file

Request

Updates a file

Path
fileIdinteger(int32)required

The Id of the file

Body

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

Array [
valueobject or null
pathstring or null
opstring or null
fromstring or null
]
[
  {
    "value": {},
    "path": "string",
    "op": "string",
    "from": "string"
  }
]

Responses

Success

Download file

Request

Path
fileIdinteger(int32)required

The Id of the file

No request payload

Responses

Success

Body
integer(int32)
Response
No response example

Move file

Request

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

Path
fileIdinteger(int32)required

The Id of the file

destinationIdinteger(int32)required

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
conflictResolutionstring

Conflict handling

Options:

  • Replace
  • KeepBoth
  • SaveVersion
  • Skip

Enum"Replace""KeepBoth""SaveVersion""Skip"
No request payload

Responses

No Content

Upload file

Request

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

Path
targetTypestringrequired

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"
targetIdinteger(int32)required

The target entity in LawVu

Body

The upload details

folderIdinteger or null(int32)

Id of the folder for the file upload

isBrowsableboolean

File is browseable in the files collection

fileDatastring or null(binary)

The upload file details

{
  "folderId": 0,
  "isBrowsable": true,
  "fileData": "string"
}

Responses

Success

Body
integer(int32)
Response
No response example

Finalise upload

Request

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

Path
targetTypestringrequired

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"
targetIdinteger(int32)required

The id of the target type

uploadIdinteger(int32)required

The id of the upload

Body

The details of the finalisation

outcomestring

Options:

  • Failed
  • Succeeded
Enum"Succeeded""Failed"
conflictResolutionstring or null

Options:

  • Replace
  • KeepBoth
  • SaveVersion
  • Skip
Enum"Replace""KeepBoth""SaveVersion""Skip"
failureReasonstring or null
commentsstring or null
isSignedboolean
{
  "outcome": "Succeeded",
  "conflictResolution": "Replace",
  "failureReason": "string",
  "comments": "string",
  "isSigned": true
}

Responses

Success

Body
integer(int32)
Response
No response example

Folders

Operations