| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: objects/<object_id>/customtables URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/customtables Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/customtables JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
| relatedId | optional | string(guid) | The id of the object the custom table belongs to. Will be taken from request url. | | name | optional | string | Custom table name | | description | optional | string | Custom table description | | id | will be ignored | string(guid) | The id of the custom table. | created | will be ignored | string (date) | Creation date of the commentcustom table | createdBy | will be ignored | object | The user which created custom table | | changed | will be ignored | string (date) | Modified date of the comment | | 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. |
|
| Card |
|---|
| | Create a new custom table for a specified object. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "Sample custom table",
"description": "Sample custom table with all column types",
"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 ] }
]
},
}
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON |
|---|
| {
"name": "Sample custom table",
"description": "Sample custom table with all column types",
"relatedId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
"created": "2017-06-20T06:51:40.64",
"createdBy": {
"id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
"email": null
},
"changed": "2017-06-20T06:51:40.64",
"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", 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": "2517e000-eb32-4487-be36-c5db90b9b943"
}
|
|
|