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": "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
                ]
             11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {
                "items": [
                    3,
                    "2017-05-12T00:00:00",
                    "Third row",
                    31,
                    "d8b5939d-a7a1-482c-b9c9-0b89848129b8",
                    true
                ]
             11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            {
                "items": [
                    4,
                    "2017-04-12T00:00:00",
                    "Fourth"Third row",
                    41,
                    "5bf3ea87-e1e4-4a51-ae20-85caee9b28a7",
                    false
                ]
             11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
        ]
    },
    "id": "e16336b3-95e4-4108-a9ee-0a9c010dfe9b"
}

...

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
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

{
    "name": "Updated name of Sample custom table",
     "issueId"description": "Updated description of Sample custom table with all column types",
    "relatedId": "8415bd8d8688fe5c-7e27855e-4975455a-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": {
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 ] },
            { "iditems": "132a78a5-b523-4bf2-8382-7098fac3f803"[ 4, "2017-04-12T00:00:00", "Third 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

{
    "issueIdname": "8415bd8d-7e27-4975-bddb-b1b365719770Updated name of Sample custom table",
    "textdescription": "Second Comment: The fire exit should be x:120, y: 120; z: 340Updated description of Sample custom table with all column types",
    "relatedId": "8688fe5c-855e-455a-92cb-afce4abdbf78",
    "createdAtcreated": "20132017-1106-20T0819T13:17:36+00:00"31:23",
    "createdBy": null,
    "modifiedAtchanged": "20132017-1106-20T0819T13:17:36+00:0046:54",
    "authorchangedBy": {
        "id": "132a78a578a94d0e-b5230d58-4bf23f85-8382aafa-7098fac3f8031e631c51b5d2",
        "email": "test@bimplus.net",null
    },
    "statusrevision": "Active",null,
    "dataTable": {
        "firstnamecolumns": null,[
            { "name": "Int column", "lastnametype": null"Int32" },
        "company": null    { "name": "DateTime column", "type": "DateTime" },
        "displayname": null,
   { "name": "String column", "type": "infoString": null},
        "gender": null,
    { "name": "Double column", "phoneWorktype": null"Double" },
        "phoneHome": null,
   { "name": "Guid column", "type": "faxGuid": null},
            { "mobilename": null,"Bool column", "type": "Boolean" }
        "birthDate": null],
        "addressrows": {[
            { "streetitems": [ 1, "2017-07-12T00:00:00", "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "streetNritems": [ 2, "2017-06-12T00:00:00",
 "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
     "zip": "",
      { "items": [ 3, "2017-05-12T00:00:00", "Third "city": "",
row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
            { "countryitems": [ 4, ""
        },2017-04-12T00:00:00", "Third 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 6

Key