RESTful API documentation


Release date: 2024-10-01T12:08:58+0000

For more advanced testing, browser addons like Postman for Chrome or RESTClient for Firefox can be used. With these addons you can compose any GET/POST/PUT/DELETE/... request and save them. Information on how to compose these requests can be found in the API Documentation Index. You can also observe the calls the Bricsys 24/7 webservice makes to the server. In most browsers you can track network activity. For chrome, the F12 key opens the developers panel by default. Here in the network tab you can filter out the XHR requests, these are the ones that return human-readable text. If this stays open, and you continue to use Bricsys 24/7, you'll see a list of all requests made to the server. For each request you can view the url on which the request was performed, which parameters were used, what the payload looked like and what the response of the server was. Other browsers should have similar features available.

API Documentation Index Conventions

[]optional part of a URL
{}required part of a URL to fill in
  required payload part

URL parameter values or JSON values are either a number, a string or a boolean. The API Documentation Index also lists custom types like WorkflowInstanceStatus or ItemType. Here an id or string is required that has a specific meaning to the server. These are enums and are listed below.
E.g. To add an Event to the server we send a post request to following URL: /api/rest/Event?{f=FolderID}
This request requires a payload containing information about the event to add. The payload has JSON attributes "Status" and "Category" which require a value of type EventStatus and EventCategory respectively. An example payload could look like:
{
    "Category": "MEETING",
    "Status": "CONFIRMED",
    "Description": "We will discuss the importance of the color blue in our interface.",
    "Name": "Weekly Bricsys 24/7 Meeting",
    "End": "1424962800000",
    "Start": "1424955600000"
}

Universal parameters

These parameters can be added to any URL

Custom type enums


INACTIVE1  
ACTIVE2  
COMPLETED3  
CANCELED4  
LOOP5  
DELETED6  
OTHER1  
MEETING2  
TASK3  
TRAVEL4  
VACATION5  
HOLIDAY6  
CALL7  
BIRTHDAY8  
WORKFLOW9  
NOT_APPLICABLE1  
TENTATIVE2  
CONFIRMED3  
MEETING_CANCELED4  
OPEN5  
ASSIGNED6  
ON_HOLD7  
POSTPONED8  
IN_PROGRESS9  
COMPLETED2510  
COMPLETED5011  
COMPLETED7512  
COMPLETED13  
DONT_SHOW_IN_CALENDAR15  
CANCELED16  
LOOP17  
DOCUMENTS1  
ADDRESSBOOK2  
CALENDAR3  
MAIL4  
WORKFLOWS6  
FORUM16  
BINDER17  
FORM26  
BIM991  
DRAWINGS992  
RELATION990  
SEPARATOR999  
ITEM0  
PROJECT1  
FOLDER2  
DOCUMENT3  
CONTACT4  
ORGANIZATION5  
EVENT6  
MESSAGE7  
ROLE9  
ANNOTATION10  
WORKFLOW11  
WORKFLOWINSTANCE12  
URL14  
NOTE16  
NOTIFY17  
FORUM18  
FORUMPOST19  
BINDER21  
REVISION22  
QUERY24  
FORM26  
MAILLIST27  
USER28  
FORMROW29  
REPOSITORYLINK30  
REPOSITORYTABLE31  
REPOSITORYCOLUMN32  
ACTIVITY33  
FORMFIELD34  
DOCUMENTSTATUS36  
DOCUMENTVIEW37  
COUNTRY38  
TASK40  
EVENTATTENDEE42  
LOGRECENT43  
LOGROOT44  
LANGUAGE45  
ROLEMEMBER46  
FOLDERACCESS47  
TRANSITIONINSTANCE48  
ACTIVITYSTATE49  
TRANSITION50  
FORMOPTION52  
FORMFIELDOPTION53  
REPOSITORYTABLEACCESS57  
REPOSITORYCOLUMNACCESS58  
FORMRECORD59  
FORMRECORDFIELD60  
FOLDERSUBSCRIPTION61  
AUTOWORKFLOW62  
FOLDERCONTACT65  
FOLDERORGANIZATION66  
ACTIVITYINSTANCE67  
WORKFLOWINSTANCESTATE68  
ORGANIZATIONMEMBER70  
APP71  
REPOSITORYACCESS72  
DOCUMENTSHARE82  
DELAYEDNOTIFY84  
FOLDERAPROPLAN85  
OBJECTSETTING86  
APROPLANSYNCQUEUE87  
APROPLANFOLDER89  
APROPLANPROJECT90  
APROPLANUSER88  
CUSTOMER91  
RECYCLEBIN92  
SEARCH93  
LINKEDDOCUMENT94  
BINDERITEM95  
GUEST96  
FOLDERACCESSSNAPSHOT97  
TILE98  
TILEDATA99  
TILEINFO100  
APPPLUGIN101  
APPVISIBILITY102  
CSVHEADERS103  
ATTACHMENT104  
LOGAPP105  
BIM106  
BIM_BUILDING108  
BIM_STORY109  
TAG107  
ADMIN_ACCESS110  
AUTHENTICATIONTOKEN111  
ANNOTATION3D112  
VIEWER_DATA123  
OBJECTLINK127  
XREF128  
USERACCESSTOKEN129  
DB_ACTIVITY_INSTANCE130  
ANNOTATION2D_MARKER131  
ANNOTATION3D_MARKER132  
TODO133  
COMMUNICATION134  
WORKFLOW_COMMENT135  
ANNOTATION_GENERIC138  
LOOSE_WORKFLOWINSTANCE993  
STORAGEENTRY994  
STORAGE995  
STORAGELOCATION996  
FILELOCATION997  
LOG998  
ALL-1  
LOWEST10  
LOW20  
NORMAL30  
HIGH40  
HIGHEST50  
HOUR10  
DAY5  
WEEK3  
MONTH2  
DAY5  
WEEK3  
MONTH2  
YEAR1  
NEW0  
RELEASED20  
OBSOLETE30  

API Documentation Index


REVISION

ACTIVITYINSTANCE

ADMIN_ACCESS

ANNOTATION

ANNOTATION3D

APP

APPVISIBILITY

FOLDERAPROPLAN

APROPLANFOLDER

APROPLANPROJECT

APROPLANSYNCQUEUE

APROPLANUSER

ATTACHMENT

AUTOWORKFLOW

BIM

BINDERITEM

BIM_BUILDING

CONTACT

COUNTRY

CUSTOMER

DOCUMENT

DOCUMENTSHARE

DOCUMENTSTATUS

EVENT

EVENTATTENDEE

FOLDER

FOLDERACCESS

FOLDERACCESSSNAPSHOT

FOLDERSUBSCRIPTION

FORM

FORMROW

FORMRECORD

FORUM

FORUMPOST

GUEST

CSVHEADERS

LANGUAGE

LINKEDDOCUMENT

LOG

LOGRECENT

LOGROOT

MAILLIST

MESSAGE

REPOSITORYLINK

NOTE

NOTIFY

ORGANIZATION

PROJECT

QUERY

RECYCLEBIN

REPOSITORYTABLE

ROLE

ROLEMEMBER

SEARCH

BIM_STORY

TAG

TASK

TILEDATA

DB_ACTIVITY_INSTANCE

URL

USER

USERACCESSTOKEN

WORKFLOWINSTANCE

WORKFLOWINSTANCESTATE

WORKFLOW

XREF