Column View
The Column View API allows the user to organize the grid's column customization display style for different Venue Inventory data modules.
Security
jwt-bearer-token
apiKey | API Key |
|---|---|
Name | Authorization |
In | header |
Endpoints
GET /column-view/schema
Summary
Get the schema of the column view.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
GET /column-view
Summary
Get the column view.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
query |
| string | No | A filter expression in OData v4 format |
query |
| integer | No | The maximum documents to return. For example, if |
query |
| integer | No | The documents to skip before returning. For example, if |
query |
| string | No | |
query |
| string | No | An order by expression in OData v4 format |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
PATCH /column-view
Summary
Update the column view.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
body |
| Yes | The JSON formatted request |
Responses
Code | Description | Schema |
|---|---|---|
204 | No content | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
Data Models
column_view_get_response_1
Field Name | Type | Description |
|---|---|---|
| object | The column view schema definition |
column_view_get_response_2
Field Name | Type | Description |
|---|---|---|
| string |
|
| string |
|
| string | The module configuration |
| string | The module type |
| string | The module name |
| string |
|
| date/time | The column view's creation date |
| string |
|
| date/time | The column view's update date |
column_view_patch_body_3
Field Name | Type | Required | Description |
|---|---|---|---|
| string | No | The module type. Enum: |
| string | Yes | The module name. Enum: |
| string | Yes | The module configuration |