LawVu Fields (1.0)

Download OpenAPI specification:Download

Apis for field resources

LookupFields

Get available choices for a multi lookup field

Get available choices for a multi lookup field

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the field

query Parameters
skip
integer <int32>
Default: 0

Format - int32. Number of results to skip

Default: 0

take
integer <int32>
Default: 25

Format - int32. The maximum number of choices to return

Default: 25

search
string or null

Text filter

Responses
200

Success

get/v1/lookupFields/{id}/choices
Response samples 
null

Add a choice to the multi lookup field

Add a choice to the multi lookup field

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the lookup field

Request Body schema:

A model describing the choice to be added

label
string or null
Responses
200

Success

post/v1/lookupFields/{id}/choices
Request samples
{
  • "label": "string"
}
Response samples 
null

Deletes a choice from the the lookup field

Deletes a choice from the the lookup field

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the lookup field

choiceId
required
integer <int32>

Format - int32. The ID of the choice to remove

Responses
200

Success

delete/v1/lookupFields/{id}/choices/{choiceId}

Patch a choice, currently only move is supported to merge two choices together

Patch a choice, currently only move is supported to merge two choices together

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the lookup field

choiceId
required
integer <int32>

Format - int32. The choice to patch

Request Body schema:

A Json-Patch to apply

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

Success

patch/v1/lookupFields/{id}/choices/{choiceId}
Request samples
[
  • {
    }
]

Add a choice to the single lookup field

Add a choice to the single lookup field

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the lookup field

Request Body schema:

A model describing the choice to be added

label
string or null
Responses
200

Success

post/v1/lookupFields/{id}/choice/single
Request samples
{
  • "label": "string"
}
Response samples 
null

Get available choices for a single lookup field

Get available choices for a single lookup field

Request
path Parameters
id
required
integer <int32>

Format - int32. The ID of the field

query Parameters
skip
integer <int32>
Default: 0

Format - int32. Number of results to skip

Default: 0

take
integer <int32>
Default: 25

Format - int32. The maximum number of choices to return

Default: 25

search
string or null

Text filter

Responses
200

Success

get/v1/lookupFields/{id}/choices/single
Response samples 
null

Fields

Get fields

Request
query Parameters
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 fields to return

Default: 50

skip
integer <int32>
Default: 0

Format - int32.

Default: 0

search
string or null
fieldCategory
string or null

Options:

  • Custom
  • Lawvu
Enum: "Custom" "Lawvu"
Responses
200

Success

get/v1/fields
Response samples 
null

Get field schema

Get field schema

Request
path Parameters
fieldId
required
integer <int32>

Format - int32. e.g. 1234

Responses
200

Success

get/v1/fields/{fieldId}
Response samples 
null