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
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"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": {
"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email": null
},
"changed": "2017-06-19T13:31:23",
"changedBy": {
"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email": null
},
"revision": 0,
"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",
21,
"5b2eae50-6ddf-4f74-b7c2-4cceb725380e",
false
]
},
{
"items": [
3,
"2017-05-12T00:00:00",
"Third row",
31,
"d8b5939d-a7a1-482c-b9c9-0b89848129b8",
true
]
},
{
"items": [
4,
"2017-04-12T00:00:00",
"Fourth row",
41,
"5bf3ea87-e1e4-4a51-ae20-85caee9b28a7",
false
]
}
]
},
"id": "e16336b3-95e4-4108-a9ee-0a9c010dfe9b"
}
Update the custom table
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 |
|---|---|---|---|
| issueId | will be ignored | string(guid) | The id of the issue |
text |
mandatory |
string |
The comment text |
createdAt |
will be ignored |
string (date) |
Creation date of the comment |
| modifiedAt | will be ignored | string (date) | Modified date of the comment |
author |
optional |
object |
The author of the comment |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{
"issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
"text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-11-20T08:17:36+00:00",
"modifiedAt": "2013-11-20T08:17:36+00:00",
"author": {
"id": "132a78a5-b523-4bf2-8382-7098fac3f803"
}
}
Status: 200 OK
{
"issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
"text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-11-20T08:17:36+00:00",
"modifiedAt": "2013-11-20T08:17:36+00:00",
"author": {
"id": "132a78a5-b523-4bf2-8382-7098fac3f803",
"email": "test@bimplus.net",
"status": "Active",
"firstname": null,
"lastname": null,
"company": null,
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
}
Delete the custom table
URL: https://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>
Example: https://api-stage.bimplus.net/v2/bimplus/customtables/8836308d-f09f-4bb7-b6d2-354a2db205a6
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
