Page History

...

Deck of Cards

id	bimGetCurrentUserInfo

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api-stage.bimplus.net/v2/user

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Anchor

	teamService
	teamService

...

Deck of Cards

id	bimGetTeamFromCurrentUser

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

URL: https://api-stage.bimplus.net/v2/teams

Card

label	Description

Get a team list in which the current logged in user is a member of

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "displayname": "Best Company (best-company)",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": true,
        "rights": {
            "projectCreate": true
        }
    },
    {
        "id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
        "slug": "nemetschek",
        "name": "Nemetschek",
        "displayname": "Nemetschek (nemetschek)",
        "owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "totalStorage": 0,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "slug": "bimplus-demo",
        "name": "BimPlusDemo",
        "displayname": "BimPlusDemo (bimplus-demo)",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "totalStorage": 53687091200,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    }
]

Anchor

	membershipService
	membershipService

...

Deck of Cards

id	bimdeleteProjectRole

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/members

URL: https://api-stage.bimplus.net/v2/projects/<project_id>/members

Example: https://api-stage.bimplus.net/v2/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

Card

label	Description

Remove the user from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	messagingServicedbServerStatisticsmessagingService
	dbServerStatistics

...

Database Server Statistics Service

...

Anchor

	createMessagegetAllDBServers	createMessage

...

	getAllDBServers

Get all the database server details

Deck of Cards

id	bimCreateMessagebimGetAllDBServers

Card

label	HTTP Method

POST GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/dbserverstatistics

messages URL: https://api-stage.bimplus.net/v2/messagesadministration/dbserverstatistics

Example: https://api-stage.bimplus.net/v2/administration/messages

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
userId	mandatory	string	Id of the user
source	mandatory	string	Source of the message (eg: Import Service)
topic	mandatory	string	Topic of the message
severity	mandatory	object	Severity can be Info, Warning, Error
returnCode	mandatory	string	Readable return code
timestamp	will be ignored	string	Creation date of the message
unread	mandatory	boolean	Whether the message was unread
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

dbserverstatistics

Card

label	Description

Retrieves the details of all the DB servers found in the Bimplus platform

Card

label	Description

Create a new message for an user

.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

 [
    {
        "id": "4633d5226c3bcbd4-53aadf39-4d814b5c-90b49d55-704681e0573d257d15b6f2f2",
        "useriddbServerName": "c7040e44-508a-4d10-88dc-b7c7ace6c650k3345.ims-firmen.de",
        "sourcedbServerStatus": "ServiceNameActive",
        "topicusageStatisticsIsWorking": "SKETCHUP_JOB"true,
        "severitydbServerIsClosed": "Warn"false,
        "returncodedbSpaceTotal": "FILE_TOO_BIG"800000,
        "unreaddbSpaceUsed": false24603,
     "timestamp": "2013-11-15T10:55:53"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

...

Get the message list of the current user

Deck of Cards

id	bimGetMessageList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages

Example: https://api-stage.bimplus.net/v2/messages

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {   "growingSumLastWeekSpaceUsed": 2717,
        "growingSumLastMonthSpaceUsed": 14853,
        "idgrowingPerDayLastWeekSpaceUsed": "481713d6-7dab-410c-8c8a-d65ff1d4a766"388.14285714285717,
        "useridgrowingPerDayLastMonthSpaceUsed": 479.1290322580645,
   "b7040e44-508a-4d00-88dc-b7c7ace6c650"     "growingDaysLastMonth": 31,
        "sourcegrowingDaysLastWeek": 7,
        "ServiceName2dbSpaceRemaining": 775397,
        "topicdbSpaceRemainingPercentage": 96.9,
  "SKETCHUP_JOB"      "numberOfTeams": 100,
        "severitygrowingSumLastWeekTeams": 12,
        "InfogrowingSumLastMonthTeams": 63,
        "returncodegrowingPerDayLastWeekTeams": 1.7142857142857142,
        "FILE_TOO_BIG"growingPerDayLastMonthTeams": 2.032258064516129,
        "timestampnumberOfProjects": 194,
 "2013-11-18T14:55:22"       "growingSumLastWeekProjects": 30,
        "unreadgrowingSumLastMonthProjects": false123,
        "additionaldatagrowingPerDayLastWeekProjects": null4.285714285714286,
        "correlationidgrowingPerDayLastMonthProjects": null3.967741935483871,
    },
     "numberOfProjectsMin": 0,
         {"numberOfProjectsMax": 32,
        "idteamDbSpaceMin": "93c29c5d-1391-4ae8-8876-ef9815e60f7d"20,
        "useridteamDbSpaceMax": "b7040e44-508a-4d00-88dc-b7c7ace6c650"3017,
        "sourcepopularity": "ServiceName"98.5742,
        "topicunitSpace": "IFC_JOB"MB"
    },
    {
        "severityid": "Infoc37d4829-b547-4c8d-b031-ffd2101b7c54",
        "returncodedbServerName": "OKk2222.ims-firmen.de",
        "timestampdbServerStatus": "2013-11-18T14:30:53Active",
        "unreadusageStatisticsIsWorking": true,
        "additionaldatadbServerIsClosed": nullfalse,
        "correlationiddbSpaceTotal": null800000,
     }
]

...

Get information about a specified message

Deck of Cards

id	bimGetMessage

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

Card

label	Description

Get information about a specified message

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
   "dbSpaceUsed": 19011,
        "idgrowingSumLastWeekSpaceUsed": "93c29c5d-1391-4ae8-8876-ef9815e60f7d"2114,
        "useridgrowingSumLastMonthSpaceUsed": "b7040e44-508a-4d00-88dc-b7c7ace6c650"9595,
        "sourcegrowingPerDayLastWeekSpaceUsed": "ServiceName"302,
        "topicgrowingPerDayLastMonthSpaceUsed": "IFC_JOB"309.51612903225805,
        "severitygrowingDaysLastMonth": "Info"31,
        "returncodegrowingDaysLastWeek": "OK"7,
    "timestamp": "2013-11-18T14:30:53",
    "unreaddbSpaceRemaining": true780989,
      "additionaldata": null,
  "dbSpaceRemainingPercentage": 97.6,
        "numberOfTeams": 101,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.193548387096774,
        "numberOfProjects": 147,
        "growingSumLastWeekProjects": 26,
        "growingSumLastMonthProjects": 96,
        "growingPerDayLastWeekProjects": 3.7142857142857144,
        "growingPerDayLastMonthProjects": 3.096774193548387,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 26,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 4447,
        "popularity": 98.16266,
        "correlationidunitSpace": null
}"MB"
    }
]

Anchor

	deleteMessagegetDBServerdeleteMessage
	getDBServer

...

Get the particular database server details

Deck of Cards

id	bimDeleteMessagebimGetDBServer

Card

label	HTTP Method

DELETE GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messagesadministration/dbserverstatistics/<message<server_id> id>

URL: https://api-stage.bimplus.net/v2/messagesadministration/dbserverstatistics/<message<server_id>

Example: https://api-stage.bimplus.net/v2/administration/messages/<message_id>dbserverstatistics/cccbcbd4-df39-4b5c-9d55-257d15b6f2f2

Card

label	Description

Retrieves the details of a particular database server.

Delete the specified message.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Mark a message as "read"

Deck of Cards

id	bimMessageRead

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Card

label	Request

Resource: messages/<message_id>/markasread URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Card

label	Description

Mark a message as read.

Code Block

borderColor	GreenRed
title	HeadersJSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

{
    "id": "cccbcbd4-df39-4b5c-9d55-257d15b6f2f2",
    "dbServerName": "k2222.ims-firmen.de",
    "dbServerStatus": "Active",
    "usageStatisticsIsWorking": true,
    "dbServerIsClosed": false,
    "dbSpaceTotal": 800000,
    "dbSpaceUsed": 24603,
    "growingSumLastWeekSpaceUsed": 2717,
    "growingSumLastMonthSpaceUsed": 14853,
    "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
    "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
    "growingDaysLastMonth": 31,
    "growingDaysLastWeek": 7,
    "dbSpaceRemaining": 775397,
    "dbSpaceRemainingPercentage": 96.9,
    "numberOfTeams": 100,
    "growingSumLastWeekTeams": 12,
    "growingSumLastMonthTeams": 63,
    "growingPerDayLastWeekTeams": 1.7142857142857142,
    "growingPerDayLastMonthTeams": 2.032258064516129,
    "numberOfProjects": 194,
    "growingSumLastWeekProjects": 30,
    "growingSumLastMonthProjects": 123,
    "growingPerDayLastWeekProjects": 4.285714285714286,
    "growingPerDayLastMonthProjects": 3.967741935483871,
    "numberOfProjectsMin": 0,
    "numberOfProjectsMax": 32,
    "teamDbSpaceMin": 20,
    "teamDbSpaceMax": 3017,
    "popularity": 98.5742,
    "unitSpace": "MB",
    "adminLog": []
}

Anchor

	messagingService
	messagingService

Messaging Service

...

Anchor

	createMessage
	createMessage

Create a new message for an user

Deck of Cards

id	bimCreateMessage

Card

label	HTTP Method

POST

...

Log Service

...

Get all the log data

Deck of Cards

id	bimGetAllLog

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs

Example: https://api-stage.bimplus.net/v2/logs

Card

label	Description

Retrieves the whole log information from the beginning of the time.

Info
It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": ""
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": ""
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": ""
    },.....]

...

Get the log data between the time interval

Deck of Cards

id	bimGetAllLog

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource:

logs

messages

URL: https://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>messages

Example: https://api-stage.bimplus.net/v2/logs/20130101/20130102

OR

https://api-stage.bimplus.net/v2/logs/201301011200/201301011400

messages

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
userId	mandatory	string	Id of the user
source	mandatory	string	Source of the message (eg: Import Service)
topic	mandatory	string	Topic of the message
severity	mandatory	object	Severity can be Info, Warning, Error
returnCode	mandatory	string	Readable return code
timestamp	will be ignored	string	Creation date of the message
unread	mandatory	boolean	Whether the message was unread
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

Card

label	Description

Create a new message for an user.

Card

label	Description

Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
     {
        "id": 853539"4633d522-53aa-4d81-90b4-704681e0573d",
        "serveruserid": "K2177c7040e44-508a-4d10-88dc-b7c7ace6c650",
        "datesource": "2013-12-16T10:00:23ServiceName",
        "requestidtopic": "653750b3-a97e-451f-bd01-1a4671344087SKETCHUP_JOB",
        "threadseverity": "51Warn",
        "levelreturncode": "INFOFILE_TOO_BIG",
        "loggerunread": "PerformanceLog.ServiceLog"false,
        "messagetimestamp": "2013-11-15T10:55:53"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Anchor

	getMessageList
	getMessageList

Get the message list of the current user

Deck of Cards

id	bimGetMessageList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages

Example: https://api-stage.bimplus.net/v2/messages

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": ""
    },
    {
        "id": 853540"481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "serveruserid": "K2177b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "datesource": "2013-12-16T10:00:23ServiceName2",
        "requestidtopic": "653750b3-a97e-451f-bd01-1a4671344087"SKETCHUP_JOB",
        "threadseverity": "51Info",
        "levelreturncode": "INFOFILE_TOO_BIG",
        "loggertimestamp": "PerformanceLog.UserLog2013-11-18T14:55:22",
        "messageunread": "User found byId: bestcustomer@bimplus.net" false,
        "additionaldata": null,
        "exceptioncorrelationid": ""null
    },
    {
        "id": 853541"93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "serveruserid": "K2177b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "datesource": "ServiceName",
        "topic"2013-12-16T10:00:23: "IFC_JOB",
        "requestidseverity": "653750b3-a97e-451f-bd01-1a4671344087Info",
        "threadreturncode": "51OK",
        "leveltimestamp": "INFO2013-11-18T14:30:53",
        "loggerunread": "PerformanceLog.ServiceLog"true,
        "additionaldata": null,
        "correlationid"message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": ""
    },.....]

...

: null
    }
]

Anchor

	getMessage
	getMessage

Get information about a specified message

Deck of Cards

id	bimGetMessage

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

Card

label	Description

Get information about a specified message

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

Anchor

	deleteMessage
	deleteMessage

Delete the specified message

Deck of Cards

id	bimDeleteMessage

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

Card

label	Description

Delete the specified message.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	messageRead
	messageRead

Mark a message as "read"

Deck of Cards

id	bimMessageRead

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasread

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Card

label	Description

Mark a message as read.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	logService
	logService

Log Service

...

Anchor

	getAllLogs
	getAllLogs

Get all the log data

Deck of Cards

id	bimGetAllLog

...

Database Server Statistics Service

...

Get all the database server details

Deck of Cards

id	bimGetAllDBServers

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/dbserverstatisticslogs

URL: https://api-stage.bimplus.net/v2/administration/dbserverstatisticslogs

Example: https://api-stage.bimplus.net/v2/administration/dbserverstatisticslogs

Card

label	Description

Retrieves the whole log information from the details of all the DB servers found in the Bimplus platform.beginning of the time.

Info
It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

 [
    {
        "id": "6c3bcbd4-df39-4b5c-9d55-257d15b6f2f2",
        "dbServerName": "k3345.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,{
        "dbSpaceUsedid": 24603853539,
        "growingSumLastWeekSpaceUsedserver": 2717"K2177",
        "growingSumLastMonthSpaceUseddate": 14853"2013-12-16T10:00:23",
        "growingPerDayLastWeekSpaceUsedrequestid": 388.14285714285717"653750b3-a97e-451f-bd01-1a4671344087",
        "growingPerDayLastMonthSpaceUsedthread": 479.1290322580645"51",
        "growingDaysLastMonthlevel": 31"INFO",
        "growingDaysLastWeeklogger": 7"PerformanceLog.ServiceLog",
        "dbSpaceRemainingmessage": 775397,
"BEGIN Request       "dbSpaceRemainingPercentage": 96.9(GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "numberOfTeamsexception": 100,""
    },
    "growingSumLastWeekTeams": 12,{
        "growingSumLastMonthTeamsid": 63853540,
        "growingPerDayLastWeekTeamsserver": 1.7142857142857142"K2177",
        "growingPerDayLastMonthTeamsdate": 2.032258064516129"2013-12-16T10:00:23",
        "numberOfProjectsrequestid": 194"653750b3-a97e-451f-bd01-1a4671344087",
        "growingSumLastWeekProjectsthread": 30"51",
        "growingSumLastMonthProjectslevel": 123"INFO",
        "growingPerDayLastWeekProjectslogger": 4"PerformanceLog.285714285714286UserLog",
        "message"growingPerDayLastMonthProjects": "User found byId: 3bestcustomer@bimplus.967741935483871net",
        "numberOfProjectsMinexception": 0,""
    },
    "numberOfProjectsMax": 32,{
        "teamDbSpaceMinid": 20853541,
        "teamDbSpaceMaxserver": 3017"K2177",
        "popularitydate": 98.5742"2013-12-16T10:00:23",
        "unitSpacerequestid": "MB"
    }653750b3-a97e-451f-bd01-1a4671344087",
    {
        "idthread": "c37d4829-b547-4c8d-b031-ffd2101b7c54"51",
        "dbServerNamelevel": "k2222.ims-firmen.deINFO",
        "dbServerStatuslogger": "ActivePerformanceLog.ServiceLog",
        "usageStatisticsIsWorkingmessage": true,
        "dbServerIsClosed": false"END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "dbSpaceTotalexception": 800000,""
        "dbSpaceUsed": 19011,
        "growingSumLastWeekSpaceUsed": 2114,},.....]

Anchor

	getLogTime
	getLogTime

Get the log data between the time interval

Deck of Cards

id	bimGetAllLog

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>

Example: https://api-stage.bimplus.net/v2/logs/20130101/20130102

OR

https://api-stage.bimplus.net/v2/logs/201301011200/201301011400

Card

label	Description

Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
     {
        "growingSumLastMonthSpaceUsedid": 9595853539,
        "growingPerDayLastWeekSpaceUsedserver": 302,
        "growingPerDayLastMonthSpaceUsedK2177": 309.51612903225805,
        "growingDaysLastMonthdate": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 780989,
        "dbSpaceRemainingPercentage": 97.6"2013-12-16T10:00:23",
        "numberOfTeamsrequestid": 101,
        "growingSumLastWeekTeams": 12 "653750b3-a97e-451f-bd01-1a4671344087",
        "growingSumLastMonthTeamsthread": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142"51",
        "growingPerDayLastMonthTeamslevel": 2.193548387096774,
        "numberOfProjectsINFO": 147,
        "growingSumLastWeekProjectslogger": 26,
        "growingSumLastMonthProjects": 96PerformanceLog.ServiceLog",
        "growingPerDayLastWeekProjectsmessage": 3.7142857142857144,
        "growingPerDayLastMonthProjects": 3.096774193548387,
        "numberOfProjectsMin": 0"BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "numberOfProjectsMaxexception": 26,""
    },
    "teamDbSpaceMin": 20,{
        "teamDbSpaceMaxid": 4447853540,
        "popularityserver": 98.16266"K2177",
        "unitSpacedate": "MB"
    }
]

...

Get the particular database server details

Deck of Cards

id	bimGetDBServer

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: administration/dbserverstatistics/<server_id>

URL: https://api-stage.bimplus.net/v2/administration/dbserverstatistics/<server_id>

Example: https://api-stage.bimplus.net/v2/administration/dbserverstatistics/cccbcbd4-df39-4b5c-9d55-257d15b6f2f2

Card

label	Description

Retrieves the details of a particular database server.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "cccbcbd4-df39-4b5c-9d55-257d15b6f2f22013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
    "dbServerName": "k2222.ims-firmen.de",
    "dbServerStatusthread": "Active51",
    "usageStatisticsIsWorking": true,
    "dbServerIsClosedlevel": false"INFO",
    "dbSpaceTotal": 800000,
    "dbSpaceUsedlogger": 24603"PerformanceLog.UserLog",
    "growingSumLastWeekSpaceUsed": 2717,
    "growingSumLastMonthSpaceUsedmessage": 14853,
"User found   "growingPerDayLastWeekSpaceUsed"byId: 388bestcustomer@bimplus.14285714285717net",
        "growingPerDayLastMonthSpaceUsedexception": 479.1290322580645,""
    "growingDaysLastMonth": 31},
     "growingDaysLastWeek": 7,
{
        "dbSpaceRemainingid": 775397853541,
        "dbSpaceRemainingPercentageserver": 96.9"K2177",
    "numberOfTeams": 100,
    "growingSumLastWeekTeamsdate": "2013-12-16T10:00:23",
    "growingSumLastMonthTeams": 63,
    "growingPerDayLastWeekTeamsrequestid": 1.7142857142857142"653750b3-a97e-451f-bd01-1a4671344087",
    "growingPerDayLastMonthTeams": 2.032258064516129,
    "numberOfProjectsthread": 194"51",
    "growingSumLastWeekProjects": 30,
    "growingSumLastMonthProjectslevel": 123"INFO",
    "growingPerDayLastWeekProjects": 4.285714285714286,
    "growingPerDayLastMonthProjectslogger": 3"PerformanceLog.967741935483871ServiceLog",
    "numberOfProjectsMin": 0,
    "numberOfProjectsMaxmessage": 32,
"END Request (GET  "teamDbSpaceMin": 20,
    "teamDbSpaceMax": 3017,
    "popularity": 98.5742,
/v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "unitSpaceexception": "MB",
    "adminLog": []
}},.....]

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 356

New Version 357

Key

Database Server Statistics Service

Get all the database server details

Get the message list of the current user

Get information about a specified message

Get the particular database server details

Mark a message as "read"

Messaging Service

Create a new message for an user

Log Service

Get all the log data

Get the log data between the time interval

Get the message list of the current user

Get information about a specified message

Delete the specified message

Mark a message as "read"

Log Service

Get all the log data

Database Server Statistics Service

Get all the database server details

Get the log data between the time interval

Get the particular database server details