Versions Compared

Old Version 32

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 33

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

The author of the comment
Deck of Cards
idbimCreateCustomTableForObject
createdAt
Card
defaulttrue
labelURL / 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

issueId
relatedId
will be ignored
optionalstring(guid)The id of
the issue

text

mandatory

string

The comment text

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

created

will be ignored

string (date)

Creation date of the comment

modifiedAt

createdBy

will be ignored

object

The user which created custom table

changedwill be ignoredstring (date)Modified date of the comment
author
changedBywill be ignored

object

string (date)The user which recently modified custom table
revisionoptionalint (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 ).
dataTablemandatoryobject

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
 POST
Card
labelDescription
Create a new comment custom table for a specified object.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
      "textname": "TheSample fire exit should be x:120, y: 120; z: 340"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
custom table",
    "description": "Sample custom table with all column types",
    "dataTable": {
        "columns": [
            { "idname": "00000000-0000-0000-0000-000000000000",
        "emailInt column", "type": "Int32" },
            { "firstnamename": "UnknownDateTime column",
        "lastnametype": "UserDateTime" },
            { "companyname": "String column",
        "fullnametype": "String"Unknown User"},
            { "displaynamename": "UnknownDouble Usercolumn",
        "info"type": "Double" },
        "gender": "",
       { "phoneWorkname": "Guid column",
        "phoneHometype": "Guid" },
        "fax": "",
       { "mobilename": "Bool column",
        "birthDatetype": "0000-00-00",Boolean" }
        "address": {
    ],
        "streetrows": "",[
            { "streetNritems": [ 1, "2017-07-12T00:00:00",
 "First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true       "zip": ""] },
            { "cityitems": [ 2, "2017-06-12T00:00:00",
 "Second           "country": ""
  row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
      },
      {  "preferedLanguageitems": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
[ 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: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "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"
}
 

Anchor
getCustomTablesOfObject
getCustomTablesOfObject
Anchor
getCommentsOfObjectgetCommentsOfObject

Get all the comments of the object
Deck of Cards
idbimGetAllCommentsOfObjectbimGetAllCustomTablesOfObject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: objects/<object_id>/comments customtables 

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/commentscustomtables 

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/commentscustomtables

Card
labelHTTP Method
 GET
Card
labelDescription
 Get all the comments custom tables of a specified object.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[
    {
	    "name": "Sample custom table",
    	"description": "Sample custom table with all column types",
	    "relatedId
Code Block
borderColorRed
langxml
titleJSON
[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
 	       "textcreated": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",2017-06-20T06:51:40.64",
	    "createdBy": {
	        "id": "78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
	        "email": null
	    },
	    "changed": "2017-06-20T06:51:40.64",
	    "changedBy": {
        	"modifiedAtid": "2013-07-03T13:26:18+00:00",
        "author78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
    	    "email": null
	    },
	    "revision": 0,
	    "dataTable": {
        	"idcolumns": "00000000-0000-0000-0000-000000000000",
[
    	        { "emailname": "Int column",
        "firstnametype": "UnknownInt32" },
	            { "lastnamename": "UserDateTime column",
        "companytype": "DateTime" },
	            { "fullnamename": "String column", "type"Unknown: User"String" },
            	{ "displaynamename": "Double "Unknown User"column", "type": "Double" },
        "info	    { "name": "Guid column",
        "gendertype": "Guid" },
    	        { "phoneWorkname": "Bool column", "type": "Boolean" }
	        "phoneHome": ""],
        	"faxrows": "",[
    	    "mobile": "",
   { "items": [ 1, "2017-07-12T00:00:00", "birthDate": "0000-00-00",
   First row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
	     "address": {
      { "items": [ 2,   "street": "",
            "streetNr": """2017-06-12T00:00:00", "Second row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] },
        	    { "zipitems": [ 3, "2017-05-12T00:00:00",
 "Third row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true       "city": ""] },
    	        { "countryitems": [ 4, ""
        },
2017-04-12T00:00:00", "Fourth row", 11, "614a203e-9f29-48b8-a9b7-a95a647edc65", true ] }
	        "preferedLanguage": null]
    	},
        	"id": "d258c9052517e000-c8afeb32-44634487-b0d8be36-ac09dbcfc255c5db90b9b943"
    	}
]

Anchor
deleteCommentsOfObjectdeleteCustomTablesOfObjectdeleteCommentsOfObject
deleteCustomTablesOfObject

Delete all the comments of the object
Deck of Cards
idbimDeleteCommentOfObjectbimDeleteCustomTablesOfObject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: objects/<object_id>/commentscustomtables

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/commentscustomtables

Example: https://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/commentscustomtables

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Delete all the comments from the issue custom tables of a specified object.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...