Page History

...

Deck of Cards

id	bimGetCustomTable

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified custom table.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	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": {
        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "email": null
    },
    "changed": "2017-06-19T13:3146:2354",
    "changedBy": {
        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "email": null
    },
    "revision": 0null,
    "dataTable": {
        "columns": [
            {
    "name": "Int column", "type": "Int32" },
            { "name": "IntDateTime column", "type": "DateTime" },
            { "name": "String column", "type": "Int32String" },
            },
            {{ "name": "Double column", "type": "Double" },
            { "name": "Guid column", "nametype": "Guid"DateTime column"},
            { "name": "Bool column", "type": "DateTimeBoolean"
 }
           }],
            {"rows": [
            { "items": [ 1, "name":2017-07-12T00:00:00", "StringFirst columnrow",
 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "typeitems": [ 2, "String"
           2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {
  "items": [ 3, "2017-05-12T00:00:00", "Third          "name": "Double column"row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {    "typeitems": [ "Double"
            },4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    {},
                "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
                ]"id": "e16336b3-95e4-4108-a9ee-0a9c010dfe9b"
}

Anchor

	updateCustomTable
	updateCustomTable

Update the custom table

Deck of Cards

id	bimCustomTableUpdate

Card

default	true
label	URL / Resource / JSON Structure

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.

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified customtable.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	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" },
            { "itemsname": [
    "DateTime column", "type": "DateTime" },
            { "name": "String  2column",
 "type": "String" },
            { "name": "Double column", "type": "2017-06-12T00:00:00"Double" },
            { "name": "Guid column",     "Second row""type": "Guid" },
            { "name": "Bool      21,column", "type": "Boolean" }
            ],
        "5b2eae50-6ddf-4f74-b7c2-4cceb725380e",rows": [
            { "items": [ 1, "2017-07-12T00:00:00", "First row",  false
                ]
           11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {
 "items": [              "items": [
  2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {     "items": [ 3,
                    "2017- "2017-05-12T00:00:00",
 "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "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"
}

...

items": [ 4, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    },
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	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

...

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:

Deck of Cards

id	bimCustomTableUpdate

Card

default	true
label	URL / Resource / 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

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified customtable.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "textcreatedBy": "Second Comment: The fire exit should be x:120, y: 120; z: 340null,
    "changed": "2017-06-19T13:46:54",
    "createdAtchangedBy": "2013-11-20T08:17:36+00:00",
{
        "modifiedAtid": "2013-11-20T08:17:36+00:0078a94d0e-0d58-3f85-aafa-1e631c51b5d2",
        "authoremail": {null
     },
    "idrevision": "132a78a5-b523-4bf2-8382-7098fac3f803"null,
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
"dataTable": {
        "issueIdcolumns": "8415bd8d-7e27-4975-bddb-b1b365719770",
[
            { "textname": "Int column"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""type": "Int32" },
            { "name": "DateTime column", "type": "DateTime" },
    "author": {
       { "idname": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "emailString column", "type": "test@bimplus.netString" },
            { "statusname": "ActiveDouble column",
        "type": "firstnameDouble": null},
        "lastname": null,
   { "name": "Guid column", "type": "companyGuid": null},
        "displayname": null,
   { "name": "Bool column", "type": "infoBoolean": null,}
        "gender": null],
        "phoneWorkrows": null,[
        "phoneHome": null,
   { "items": [ 1,  "fax": null,
        "mobile": null,
   "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
     "birthDate": null,
       { "addressitems": {
[            "street": ""2, "2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "streetNritems": [ 3, "",
            "zip": ""2017-05-12T00:00:00", "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "cityitems": [ ""4,
            "country": ""
        }, "2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        "preferedLanguage": null]
    },
    "id": "db540336e16336b3-47a395e4-426e4108-b3bfa9ee-1e532bfac8ea0a9c010dfe9b"
}

Anchor

	deleteCustomTable
	deleteCustomTable

...

Deck of Cards

id	bimDeleteCustomTable

Card

default	true
label	URL / Resource / JSON Structure

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/8836308de16336b3-f09f95e4-4bb74108-b6d2a9ee-354a2db205a60a9c010dfe9b

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified customtable.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Update the custom table

Update the custom table