CustomTableService
CustomTable Service
A particular custom table belonging to an object can be modified using the custom table service.
- Please use the Bimplus Object Service for creating a custom table or to deal with the group of custom tables belonging to an object.
Get details of the custom table
Resource: customtables/<customtable_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>
Example:https://api-stage.bimplus.net/v2/bimplus/customtables/e16336b3-95e4-4108-a9ee-0a9c010dfe9b
GET
Get details of a specified custom table.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
{
"name": "Sample custom table",
"description": "Sample custom table with all column types",
"relatedId": "8688fe5c-855e-455a-92cb-afce4abdbf78",
"created": "2017-06-19T13:31:23",
"createdBy": null,
"changed": "2017-06-19T13:46:54",
"changedBy": {
"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email": null
},
"revision": null,
"dataTable": {
"columns": [
{ "name": "Int column", "type": "Int32" },
{ "name": "DateTime column", "type": "DateTime" },
{ "name": "String column", "type": "String" },
{ "name": "Double column", "type": "Double" },
{ "name": "Guid column", "type": "Guid" },
{ "name": "Bool column", "type": "Boolean" }
],
"rows": [
{ "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
]
},
"id": "e16336b3-95e4-4108-a9ee-0a9c010dfe9b"
}
Update the custom table
Resource: customtables/<customtable_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>
Example: https://api-stage.bimplus.net/v2/bimplus/customtables/db540336-47a3-426e-b3bf-1e532bfac8ea
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
| relatedId | madatory | string(guid) | The id of the object the custom table belongs to. |
| name | optional | string | Custom table name |
| description | optional | string | Custom table description |
| id | will be ignored | string(guid) | The id of the custom table. Will be taken from request url. |
created |
will be ignored |
string (date) |
Creation date of the custom table |
createdBy |
will be ignored |
object |
The user which created custom table |
| changed | will be ignored | string (date) | Modified date of the custom table |
| changedBy | will be ignored | string (date) | The user which recently modified custom table |
| revision | optional | int (null=current) | Object revision. If revision is specified, then the call will get the object from the requested revision, otherwise return current object ( latest revision ). |
| dataTable | mandatory | object | A JSON string which includes data for custom table. An example template is specified below. Please remember, the server will process the dataTable information as a json string and hence the client has to take care on the information that is stored & retrieved. |
PUT
Update the specified customtable.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "Updated name of Sample custom table",
"description": "Updated description of Sample custom table with all column types",
"relatedId": "8688fe5c-855e-455a-92cb-afce4abdbf78",
"dataTable": {
"columns": [
{ "name": "Int column", "type": "Int32" },
{ "name": "DateTime column", "type": "DateTime" },
{ "name": "String column", "type": "String" },
{ "name": "Double column", "type": "Double" },
{ "name": "Guid column", "type": "Guid" },
{ "name": "Bool column", "type": "Boolean" }
],
"rows": [
{ "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
]
},
}
Status
Status: 200 OK
JSON
{
"name": "Updated name of Sample custom table",
"description": "Updated description of Sample custom table with all column types",
"relatedId": "8688fe5c-855e-455a-92cb-afce4abdbf78",
"created": "2017-06-19T13:31:23",
"createdBy": null,
"changed": "2017-06-19T13:46:54",
"changedBy": {
"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email": null
},
"revision": null,
"dataTable": {
"columns": [
{ "name": "Int column", "type": "Int32" },
{ "name": "DateTime column", "type": "DateTime" },
{ "name": "String column", "type": "String" },
{ "name": "Double column", "type": "Double" },
{ "name": "Guid column", "type": "Guid" },
{ "name": "Bool column", "type": "Boolean" }
],
"rows": [
{ "items": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 3, "2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
{ "items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
]
},
"id": "e16336b3-95e4-4108-a9ee-0a9c010dfe9b"
}
Delete the custom table
Resource: customtables/<customtable_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>
Example: https://api-stage.bimplus.net/v2/bimplus/customtables/e16336b3-95e4-4108-a9ee-0a9c010dfe9b
DELETE
Deletes a specified customtable.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
