Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimCustomTableUpdate
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: customtables/<customtable_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/customtables/db540336-47a3-426e-b3bf-1e532bfac8ea

JSON Structure:

Name

Mandatory / Optional

Type

Description

relatedIdmadatorystring(guid)The id of the custom table
nameoptionalstringCustom table name
descriptionoptionalstringCustom table description
idwill be ignoredstring(guid)The id of the custom table. Will be taken from request url.

created

will be ignored

string (date)

Creation date of the comment

createdBy

will be ignored

object

The user which created custom table

changedwill be ignoredstring (date)Modified date of the comment
changedBywill be ignoredstring (date)The user which recently modified custom table
revisionwill be ignored  
dataTablemadatorymandatoryobject 

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
labelHTTP Method
 PUT
Card
labelDescription
Update the specified customtable.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "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 ] }
        ]
    },
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
titleJSON
{
    "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"
}

...