0% found this document useful (0 votes)

22 views

Web Service Manual: November 2017 Author Tecnoteca SRL

Uploaded by

Elio Zerpa

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

22 views

Web Service Manual: November 2017 Author Tecnoteca SRL

Uploaded by

Elio Zerpa

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 89

Version

2.5

» Web Service Manual

November 2017
Author Tecnoteca srl
www.tecnoteca.com

ENG

www.cmdbuild.org
Web Service Manual

No part of this document may be reproduced, in whole or in part, without the express written permission
of Tecnoteca s.r.l.

CMDBuild ® uses many great technologies from the open source community:
PostgreSQL, Apache, Tomcat, Eclipse, Ext JS, JasperReports, IReport, Enhydra Shark, TWE, OCS
Inventory, Liferay, Alfresco, GeoServer, OpenLayers, Prefuse, Quartz, BiMserver.
We are thankful for the great contributions that led to the creation of these products.

CMDBuild ® is a project of Tecnoteca Srl. Tecnoteca is

responsible of software design and development, it's the official
maintainer and has registered the CMDBuild logo.

In the project also the Municipality of Udine was involved as the

initial customer.

CMDBuild ® is released under AGPL open source license (http://www.gnu.org/licenses/agpl-3.0.html)

CMDBuild ® is a registered trademark of Tecnoteca Srl.

Everytime the CMDBuild® logo is used, the official maintainer "Tecnoteca srl" must be mentioned; in
addition, there must be a link to the official website:
http://www.cmdbuild.org.
CMDBuild ® logo:
• cannot be modified (color, proportion, shape, font) in any way, and cannot be integrated into
other logos
• cannot be used as a corporate logo, nor the company that uses it may appear as author / owner
/ maintainer of the project
• cannot be removed from the application, and in particular from the header at the top of each
page

The official website is http://www.cmdbuild.org

CMDBuild – Open Source Configuration and Management Database Page 2

Web Service Manual

Contents
Introduction...................................................................................................................................... 4
CMDBuild modules...................................................................................................................................... 4
Available documentation.............................................................................................................................. 5
Interoperability standards................................................................................................................. 6
Service-Oriented Architecture (SOA)........................................................................................................... 6
Web service and SOAP protocol......................................................................................................7
Examples of usage...................................................................................................................................... 7
Provided services........................................................................................................................................ 7
Description of support data structures....................................................................................................... 10
Description of web service methods.......................................................................................................... 13
Definition of authentication policy file......................................................................................................... 16
REST web service.......................................................................................................................... 18
Services..................................................................................................................................................... 18
APPENDIX: Glossary..................................................................................................................... 85

CMDBuild – Open Source Configuration and Management Database Page 3

Web Service Manual Introduction

Introduction
CMDBuild is an Open Source web application designed to model and manage assets and services
controlled by the ICT Department, therefore it handles the related workflow operations, if
necessary according to ITIL best practices.
The management of a Configuration Database (CMDB) means keeping up-to-date, and available
to other processes, the database related to the components in use, their relations and their
changes over time.
With CMDBuild, the system administrator can build and extend its own CMDB (hence the project
name), modeling the CMDB according to the company needs; the administration module allows you to
progressively add new classes of items, new attributes and new relations. You can also define filters,
"views" and access permissions limited to rows and columns of every class.
CMDBuild provides complete support for ITIL best practices, which have become a "standard de
facto" by now, a non-proprietary system for services management with process-oriented criteria.
Thanks to the integrated workflow engine, you can create new workflow processes with external
visual editors, and import / execute them inside the CMDBuild application according to the
configured automatisms.
A task manager integrated in the user interface of the Administration Module is also available. It
allows to manage different operations (process starts, e-mail receiving and sending, connector
executions) and data controls on the CMDB (synchronous and asynchronous events). Based on
their findings, it sends notifications, starts workflows and executes scripts.
CMDBuild includes also JasperReports, an open source report engine that allows you to create
reports; you can design (with an external editor), import and run custom reports inside CMDBuild.
Then it is possible to define some dashboards made up of charts which immediately show the situation
of some indicators in the current system (KPI).
CMDBuild integrates Alfresco, the popular open source document management system. You can
attach documents, pictures and other files.
Moreover, you can use GIS features to georeference and display assets on a geographical map
(external map services) and / or an office plan (local GeoServer) and BIM features to view 3D
models (IFC format).
The system includes also a SOAP and a REST webservice, to implement interoperability solutions
with SOA.
CMDBuild includes two frameworks called Basic Connector and Advanced Connector, which are
able - through the SOAP webservice - to sync the information recorded in the CMDB with external
data sources, for example through automatic inventory systems (such as the open source OCS
Inventory) or through virtualization or monitoring systems.
Through the REST webservice, CMDBuild GUI Framework allows to issue custom webpages on
external portals able to interact with the CMDB.
A user interface for mobile tools (smartphones and tablets) is also available. It is implemented as
multi-platform app (iOS, Android) and linked to the CMDB through the REST webservice.

CMDBuild modules
The CMDBuild application includes two main modules:

CMDBuild – Open Source Configuration and Management Database Page 4

Web Service Manual Introduction

• the Administration Module, used to define the data model and set config options (classes
and relations, users and permissions, reports and workflows, main options and
preferences)
• the Management Module, used to manage cards and relations, add attachments, run
workflow processes, visualize dashboards and execute reports
The Administration Module is available only to the users with the "administrator" role; the
Management Module is used by all the users who view and edit data.

Available documentation
This manual is for computer technicians, who manage external applications and who are interested
in interoperating with CMDBuild. It supplies the detail information necessary to implement the
communication system for the read-write access of its data and functions.
You can find all the manuals on the official website (http://www.cmdbuild.org):
• system overview ("Overview Manual")
• system administration ("Administrator Manual")
• system usage (“User Manual”)
• installation and system management ("Technical Manual")
• webservice details and configuration (“Webservice Manual”)
• connectors to sync data through external systems (“ConnectorsManual”)

CMDBuild – Open Source Configuration and Management Database Page 5

Web Service Manual Interoperability standards

Interoperability standards
Service-Oriented Architecture (SOA)
In order to make different applications interoperable,
they must be created as components that cooperate
with the services implementation, and these services
must be set through high level interfaces defined under
standard protocols.
CMDBuild is designed with Service-Oriented
Architecture (SOA):
• decoupling the different logic levels (see the
schema)
• implementing and setting in every interface
external specifications as a single modality for
the access to relating data and methods
• using the interfaces both for the interactive
access of the web client and for the
programmatic access of external applications
From a technical point of view, we chose to use the
following technology of web services:
1. SOAP protocol
2. REST protocol
Through web services, and safety policy permitting, CMDBuild provides the data filed in the CMDB
and its management methods to allow the use within other applications involved with the
information itself, both for the technical management and for administration.

CMDBuild – Open Source Configuration and Management Database Page 6

Web Service Manual Web service and SOAP protocol

Web service and SOAP protocol

A web service is an interface that describes a collection of methods, available over a network and
working using XML messages.
With web services, an application allows other applications to interact with its methods.
SOAP is a standard protocol, based on
Application Http request SOAP service
XML, to access a web service.
The SOAP specifications are standardized SOAP Business
WSDL logic
by W3C. Client
Http
The web service solution offers important response
architecture advantages:
• it allows to reduce the dependence between client and server applications (“weak
coupling”)
• it offers an interoperability system independent from the platform and technologies
• it supports the interoperability in the web, since it is based on SOAP protocol which usually
uses HTTP as basic protocol (which all firewalls enable)
• it is based on XML descriptors (WSDL)

Examples of usage
The mechanism of application interoperability, provided by CMDBuild through the SOAP web
service, can be used to activate the dialogue with every other information system pre-existing in
the same organization and supporting that standard protocol.
Exhaustive examples of usage can include:
• activation in non-“JSR 168-compliant” intranet portals of simple interaction with CMDBuild
for non-technicians (report print, workflow start or development, etc)
• synchronization with other CMDB tools
• integration with management applications which require to recover from CMDBuild the
updated inventory of fixed assets or which must take to CMDBuild administration data of a
fixed asset
• integration with monitoring technical tools which need to know information on assets
subject to their control

Provided services
Method categories
The CMDBuild web service provides methods for the external execution of basic functions
managed in the system, dedicated in particular to manage and print cards and to perform
processes.
In particular the available methods categories are as follows:
• management of cards: creation, modify, delete, search, history
• management of lists used to bind information fields to groups of predefined values:

CMDBuild – Open Source Configuration and Management Database Page 7

Web Service Manual Web service and SOAP protocol

creation, modify, delete, search on lists and their values

• management of relations among cards: creation, modify, delete, search, history
• management of cards' attachments (filed in the repository of the document system Alfresco
used by CMDBuild): upload, download, modify, delete
• management of processes configured in the system (and interpreted by the workflow
engine Enhydra Shark integrated in CMDBuild): start, data recording, advancing at the
following step
All methods provided in the web service can be used upon authentication in the CMDBuild system.
The authentication is performed upon the WSS Username Token profile 1.0 specification 1 with
digest password.
You can find the detail description of single available methods in the next chapter.
Support data structures
Web service methods exposed by CMDBuild use specific support data structures corresponding to
the following object typologies:
• cards (data cards)
• attribute (single custom attribute in the card)
• lookup (value in the predefined list used to optimize an information attribute)
• query (filter query to select the card list)
• filter (specific to an atomic filter condition in the query)
• filterOperator (concatenation of filter conditions)
• order (organization among cards drawn from the filter query)
• relation (correlation among cards)
• attachment (document enclosed in a card)
You can find the detail description of single employed objects in the next chapter.
Authentication system
In order to have all services offered by the CMDBuild web services, the access user must be
authenticated in the system.
This is possible thanks to the authentication based on UsernameToken.
CMDBuild uses Axis2 to supply its services outside and the Apache Rampart module to manage
the users authentication via web service, employing the WSS Username Token profile 1.0
standard with digest password.
This standard provides the dispatch of credentials, meant as password username and hash. It is
calculated according to the algorithm defined in the specification, in the header of the SOAP
message.
Once the message has been received, the Rampart module verifies if CMDBuild provides a user
corresponding to the credentials.
When this occurs and if the user is allowed to access the required service, then the web service

1 The reference document can be found at http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-

profile-1.0.pdf

CMDBuild – Open Source Configuration and Management Database Page 8

Web Service Manual Web service and SOAP protocol

will report the result, otherwise there will be an error message.

Error management system
The error management in the CMDBuild system provides the use of custom error codes expressly
defined.
Using the web service, besides the errors of Axis (and the Rampart module about the
authentication), also CMDBuild custom errors can be returned.
In the following table you will find the list of custom error codes in CMDBuild; potentially, they can
be returned from the web service with their meaning.

Code Meaning
NOTFOUND_ERROR Element not found
AUTH_MULTIPLE_GROUPS The user is connected with multiple groups
AUTH_UNKNOWN_GROUP Unknown group
AUTH_NOT_AUTHORIZED The authorizations are not enough to
perform the operation
ORM_GENERIC_ERROR An error has occurred while reading/saving
data
ORM_DUPLICATE_TABLE There is already a class with this name
ORM_CAST_ERROR Error in the type conversion
ORM_UNIQUE_VIOLATION Not null constraint violated
ORM_CONTAINS_DATA You can not delete classes or attributes of
tables or domains containing data
ORM_TYPE_ERROR Not corresponding type
ORM_ERROR_GETTING_PK The main key can not be determined
ORM_ERROR_LOOKUP_CREATION The lookup can not be created
ORM_ERROR_LOOKUP_MODIFY The lookup can not be modified
ORM_ERROR_LOOKUP_DELETE The lookup can not be deleted
ORM_ERROR_RELATION_CREATE The relation can not be created
ORM_ERROR_RELATION_MODIFY The relation can not be modified
ORM_CHANGE_LOOKUPTYPE_ERROR The lookup type can not be changed
ORM_READ_ONLY_TABLE Read-only table
ORM_READ_ONLY_RELATION Read-only relation
ORM_DUPLICATE_ATTRIBUTE There is already an attribute with this
name
ORM_DOMAIN_HAS_REFERENCE Domains with reference attributes can not
be deleted
ORM_FILTER_CONFLICT Conflict by defining the filter
ORM_AMBIGUOUS_DIRECTION The direction relation can not be
automatically determined

CMDBuild – Open Source Configuration and Management Database Page 9

Web Service Manual Web service and SOAP protocol

Description of support data structures

“Card” object
It represents a general typology of card configured in the system.
Activity name Type Mandatory Default Description
className string Class name which includes the card.
It corresponds to the table name in the
database.
id integer Card identification, it is automatically assigned
by the database.
attributeList Attribute[] Array of "Attribute" objects containing the
values of additional custom attributes in the
class.
They correspond to additional attributes
defined in the CMDBuild Administration
Module and available in the card management.
The list includes also the ClassId (not the
className).
beginDate date It shows the creation date of the current card
version (in response to the initial insertion or
the last change.
It is a date object in the TimeZone definition
format of the standard XML Schema (YYYY-
MM-DDThh:mm:ssZ).
user string Username of the person that performed the
last operation on the card.

“Attribute” object
It represents a single "custom" attribute (which is additional if compared to the two default
attributes “Code” and “Description”) belonging to a card typology configured in the system.
Activity name Type Mandatory Default Description
name string Attribute name, as created with the CMDBuild
Administration Module.
It corresponds to the table name in the
database table.
value string It corresponds to the attribute value.
code string It is developed only for "Reference" attributes
with the id of the card.

“Lookup” object
It represents the value of a list with predefined values (Lookup list) used for the development of a
Lookup attribute.

CMDBuild – Open Source Configuration and Management Database Page 10

Web Service Manual Web service and SOAP protocol

Activity name Type Mandatory Default Description

id integer Lookup identification, it is automatically
assigned by the database
type string Name of the Lookup list which includes the
current heading.
description string Description of the Lookup heading (one single
heading of a Lookup list).
code string Code of the Lookup heading (one single
heading of a Lookup list).
parent Lookup Lookup object corresponding to the parent
heading of the current heading.
parentid integer Identification of the parent Lookup in the
current heading (if applicable)
position integer Location of the Lookup heading in the related
Lookup list
notes string Notes connected with the Lookup heading

“Query” object
It represents a filter on the values to search. The filter can be unique (Filter) or a set of conditions
with a common comparison operator (FilterOperator).
Activity name Type Mandatory Default Description
filter Filter Atomic filter condition
or
filterOperator FilterOperator Concatenation of filter conditions

“Filter” object
It represents an atomic filter condition to select a card list.
Activity name Type Mandatory Default Description
name string Attribute which the filter condition is applied to.
value string Value for the comparison with the attribute's
content.
operator string Comparison operator (values such as
EQUALS, LIKE are admitted).

“FilterOperator” object
It represents a concatenation of atomic filter conditions connected with an operator.
Activity name Type Mandatory Default Description
operator string Concatenation operator to join filter conditions
(values such as AND, OR are admitted)

CMDBuild – Open Source Configuration and Management Database Page 11

Web Service Manual Web service and SOAP protocol

subquery Filter “Filter” object containing the filter condition

applied to the query.

Sample of operation to perform: creation of the filter “Supplier = Quasartek s.r.l. OR Supplier =
IBM Italia s.p.a.”
Filter1:
name: Supplier
value: Quasartek s.r.l.
operator: EQUALS
Filter2:
name: Supplier
value: IBM Italia s.p.a.
operator: EQUALS
FilterOperator:
subquery: [Filter1, Filter2]
operator: OR
Query:
filterOperator: FilterOperator
“Order” object
It represents the ordering standard among the cards drawn from the filter query.
Activity name Type Mandatory Default Description
columnName string Attribute which the ordering is performed on.
type string Ordering typology applied (only ASC and
DESC values are admitted).

“Relation” object
It represents a correlation between pairs of cards, filed in the system.
Activity name Type Mandatory Default Description
domainName string Domain used for the relation.
class1Name string ClassName of the first card taking part in the
relation.
card1Id integer Identifier of the first card which takes part in
the relation
class2Name string ClassName of the second card which takes
part in the relation.
card2Id integer Identifier of the second card which takes part in
the relation.
status string A Relation status ('A' = active, 'N' = removed)
beginDate date Date when the relation was created (format

CMDBuild – Open Source Configuration and Management Database Page 12

Web Service Manual Web service and SOAP protocol

YYYY-MM-DDThh:mm:ssZ)
endDate date Date when the relation was created (format
YYYY-MM-DDThh:mm:ssZ)

“Attachment” object
It represents a document enclosed in a card filed in the system.
Activity name Type Mandatory Default Description
category string Category which the attachment belongs to
(from proper Lookup list).
description string Description related to the attachment.
filename string Attachment name with extension
version string Document version in the DMS Alfresco
author string User that performs the file upload
created date Date when the document was inserted in the
DMS
modified date Date of the last change to the document in the
DMS

Description of web service methods

Management area of cards
Here's the list of methods dedicated to the card management.
Activity name Input Output Description
createCard Card card integer id It creates in the database a new card,
containing the information inserted in the
"Card" object.
It returns the "id" identification attribute.
deleteCard string className boolean return It deletes logically - in the identified class -
integer cardId the pre-existing card with the identified "id".
It returns “true” if the operation went
through.
updateCard string className boolean return It updates a pre-existing card.
integer cardId It returns “true” if the operation went
Attribute[] attributeList through.
getCard string className Card card It returns the required card with all
integer cardId attributes specified in “attributeList” (all
Attribute[] attributeList card attributes if “attributeList” is null).

CMDBuild – Open Source Configuration and Management Database Page 13

Web Service Manual Web service and SOAP protocol

getCardList string className Card[] cardList It returns the card list resulting from the
Attribute[] attributeList specified query, completed with all
Query queryType attributes specified in “attributeList” (all
Order[] orderType card attributes if “attributeList” is null).
If the query is made on a superclass, the
"className" attribute of the returned Card
objects contains the name of the specific
subclass the card belongs to, while in the
attributeList it appears the ClassId of the
same subclass.
getCardHistory string className Card[] cardList It returns the list of the historicized
integer cardId versions of the specified card.

Management area of Lookup headings

Here's the list of methods dedicated to the management of Lookup headings (predefined values
lists which a card attribute is held to).
Activity name Input Output Description
createLookup Lookup lookup integer id It creates in the database a new heading of a
data Lookup list containing information
inserted in the “Lookup” object.
It returns the "id" identification attribute.
deleteLookup integer lookupId boolean return It deletes logically - in the identified class -
the pre-existing card with the identified "id".
It returns “true” if the operation went through.
updateLookup Lookup lookup boolean return It updates the pre-existing Lookup heading.
It returns “true” if the operation went through.
getLookupById integer id Lookup lookup It returns the Lookup heading which shows
the specified "Id" identification.
getLookupList string type Lookup[] It returns a complete list of Lookup values
string value lookupList corresponding to the specified "type".
boolean parentList If the "value" parameter is specified, only the
related heading is returned.
If “parentList” takes the “True” value, it returns
the complete hierarchy available for the
multilevel Lookup lists.

Management area of relations

Here's the list of methods dedicated to the relation management among cards.
Activity name Input Output Description
createRelation Relation relation boolean return It creates in the database a new relation
between the pair of cards specified in the
"Relation" object.
It returns “true” if the operation went through.

CMDBuild – Open Source Configuration and Management Database Page 14

Web Service Manual Web service and SOAP protocol

deleteRelation Relation relation boolean return It deletes the existing relation between the
pair of cards specified in the "Relation" object.
It returns “true” if the operation went through.
getRelationList string domain Relation[] It returns the complete list of relations of the
string className relationList card specified for the specified domain.
integer cardId
getRelationHi Relation relation Relation[] It returns the relation history of a card starting
story relationList from a "Relation" object in which only
"Class1Name" and "Card1Id" were defined.

Management area of workflows

Here's the list of methods dedicated to the management of the processes configurable in
CMDBuild.
Activity name Input Output Description
startWorkflow Card card integer id It starts a new instance of the workflow
boolean CompleteTask described in the specified "Card".
If the “CompleteTask” parameter takes the
“true” value, the process is advanced to the
following step.
It returns the "id" identification attribute.
updateWorkflow string processId boolean ret It updates the information of the card in the
Attribute[] attributeList specified process instance.
boolean CompleteTask If the “CompleteTask” parameter takes the
“true” value, the process is advanced to the
following step.
It returns “true” if the operation went through.

Management area of attachments

Here's the list of methods dedicated to the management of documents enclosed in a card.
Activity name Input Output Description
uploadAttach string className boolean return It uploads the specified file in the DMS
ment integer cardId Alfresco and the relating connection to the
Base64Binary file CMDBuild card belonging to the “className”
string fileName class and having the “id” identification.
string category It returns “true” if the operation went through.
string description
downloadAtta string className Base64Binary file It returns the file enclosed in the specified
chment integer cardId card, which has the specified name.
string fileName
deleteAttachm string className boolean return It removes from the DMS Alfresco the file
ent integer cardId enclosed in the specified card, which has the
string fileName specified name.
It returns “true” if the operation went through.

CMDBuild – Open Source Configuration and Management Database Page 15

Web Service Manual Web service and SOAP protocol

updateAttach string className boolean return It updates the description of the file enclosed
ment integer cardId in the specified card, which has the specified
string fileName name.
string description It returns “true” if the operation went through.

Definition of authentication policy file

File structure
The policy file - which must be passed to the Rampart module for client side - must be defined
using the Web Services Security Policy Language (WS-SecurityPolicy).
This language, derived from XML, allows to define security rules respected by the application.
For example, in order to define the authentication use through Username Token with Password
Digest, you have to define the policy as follows:
<?xml version="1.0" encoding="UTF-8"?>
<wsp:Policy wsu:Id="UTOverTransport"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-ssecurity-utility-
1.0.xsd" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
<wsp:ExactlyOne>
<sp:SignedSupportingTokens
xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
<wsp:Policy>
<sp:UsernameToken sp:IncludeToken="http://docs.oasis-open.org/ws-sx/ws-
securitypolicy/200702/IncludeToken/AlwaysToRecipient">
<wsp:Policy>
<sp:HashPassword/>
</wsp:Policy>
</sp:UsernameToken>
</wsp:Policy>
</sp:SignedSupportingTokens>
</wsp:ExactlyOne>
</wsp:Policy>
You can also indicate in the policy file, certain configuration parameters of the Rampart module.
For example, if you don't want to directly transfer the password in the code, but gather it from a
database, you can suggest Rampart to use a custom class which implements the CallbackHandler
function in which you can define how to find the password.
In that case you have to modify the policy file in the following way.
<?xml version="1.0" encoding="UTF-8"?>
<wsp:Policy wsu:Id="UTOverTransport"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-ssecurity-utility-
1.0.xsd" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
<wsp:ExactlyOne>
<sp:SignedSupportingTokens xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-
securitypolicy/200702">
<wsp:Policy>
<sp:UsernameToken sp:IncludeToken="http://docs.oasis-open.org/ws-sx/ws-

CMDBuild – Open Source Configuration and Management Database Page 16

Web Service Manual Web service and SOAP protocol

securitypolicy/200702/IncludeToken/AlwaysToRecipient">
<wsp:Policy>
<sp:HashPassword/>
</wsp:Policy>
</sp:UsernameToken>
</wsp:Policy>
</sp:SignedSupportingTokens>
<ramp:RampartConfgxmlns:ramp="http://ws.apache.org/rampart/policy">
<ramp:passwordCallbackClass>
org.cmdbuild.services.soap.secure.MyPasswordHandler
</ramp:passwordCallbackClass>
</ramp:RampartConfg>
</wsp:ExactlyOne>
</wsp:Policy>
For a deeper treatement of WS-SecurityPolicy, please refer to the related official document2.

2 http://specs.xmlsoap.org/ws/2005/07/securitypolicy/ws-securitypolicy.pdf

CMDBuild – Open Source Configuration and Management Database Page 17

Web Service Manual REST web service

REST web service

Services
Attention: all information in this section could be not updated or not detailed; it's a good
habit to always refer to the WADL, looking at the desired endpoint (e.g.
http://example.com/cmdbuild/services/rest/v1?_wadl).
If not differently specified, the content type of various HTTP methods will be “application/json”.
In order to prioritize resource description:
• JSON will be simplified omitting “ characters
• reported HTTP methods, references to the selected endpoint will be omitted

Version 1
Endpoint
http://hostname:port/cmdbuild/services/rest/v1

Dates format
All dates (time, timestamp and date attributes) uses the format "yyyy-MM-dd'T'HH:mm:ss".

Session management
Access to the various resources is subject to the opening of a session that have associated some
privileges. Each session is identified by an alphanumeric string or "token".
Access to those resources requiring a session
After a session has been created or updated, its identifier must be used for all those resources that
require it. The identifier should be sent within request's header.
GET .../classes/foo/cards/ HTTP/1.1
[various other headers]
CMDBuild-Authorization: 0123456789ABCDF...

If the resource requires a session and the token is not sent or is not correct then the answer will
be:
HTTP/1.1 401 Unauthorized
[various headers]

Creation of a session
This is the only one method that does not require a session.
POST .../sessions/ HTTP/1.1
[various other headers]

CMDBuild – Open Source Configuration and Management Database Page 18

Web Service Manual REST web service

{
username : ...,
password : ...
}

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : ${SESSION}
username : ...
password : null
role : ...
}
}

Reading a session
GET .../sessions/${SESSION}/ HTTP/1.1
[various other headers]

HTTP/1.1 200 OK
[various headers]
{
username : ...
password : null
role : ...
}

Paying attention to the attribute role, if valued with "null" or absent then you will have some partial
authorizations, otherwise you will have full authorizations. If the user has only one role, then
already after creating this will be present within the session. Alternatively you will need to update
the credentials.
Update of a session
PUT .../sessions/${SESSION}/ HTTP/1.1
[various other headers]
{
role : ...,
}

HTTP/1.1 204 No Content

[various headers]

CMDBuild – Open Source Configuration and Management Database Page 19

Web Service Manual REST web service

You can change the role associated with a session (thus passing from a session with partial
authorizations to complete and vice versa).

Deletion of a session
DELETE .../sessions/${SESSION}/ HTTP/1.1
[various other headers]

HTTP/1.1 204 OK
[various headers]

Reading of all roles associated to a session

GET /sessions/${SESSION}/roles/ HTTP/1.1
[various other headers]

HTTP/1.1 200 OK
[various headers]
{
data : [foo, bar]
}

Lookup management
Reading of all types
GET .../lookup_types HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id : ...,
name : ...,
parent : ...
},
...
{
...

CMDBuild – Open Source Configuration and Management Database Page 20

Web Service Manual REST web service

},
]
}

Read of the details of a type

GET .../lookup_types HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : ...,
name : ...,
parent : ...
}
}

Read of all values of a type

GET .../lookup_types/AlfrescoCategory/values HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_type" : AlfrescoCategory,
_id" : 703,
code" : null,
description" : Document,
parent_type" : null,
active" : true,
number" : 1,
default" : false,
parent_id" : null
},
...
{

CMDBuild – Open Source Configuration and Management Database Page 21

Web Service Manual REST web service

...
}
]
}

Read of the details of a value

GET .../lookup_types/AlfrescoCategory/values/703 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_type" : AlfrescoCategory,
_id" : 703,
code" : null,
description" : Document,
parent_type" : null,
active" : true,
number" : 1,
default" : false,
parent_id" : null
}
}

Classes and cards management

Reading of all classes
GET .../classes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_id : Asset,
name : Asset,
description : Asset,

CMDBuild – Open Source Configuration and Management Database Page 22

Web Service Manual REST web service

parent : Class,
prototype : true
},
...
{
...
}
]
}

Read of the details of a class

GET .../classes/Asset HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : Asset,
name : Asset,
description : Asset,
description_attribute_name : Description,
parent : Class,
prototype : true
}
}

Read of all attributes of a class

GET .../classes/Asset/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
lookupType : null,
index : 1,
group : General data,

CMDBuild – Open Source Configuration and Management Database Page 23

Web Service Manual REST web service

unique : false,
scale : null,
editorType : null,
targetClass : null,
active : true,
description : Code,
type : string,
displayableInList : true,
values : [],
length : 100,
name : Code,
_id : Code,
flter : null,
mandatory : false,
precision : null,
defaultValue" : null,
inherited" : true
},
...
{
...
}
]
}

Creation of a card
POST .../classes/Building/cards HTTP/1.1
[various headers]
{
Code = test,
...
}

HTTP/1.1 200 OK
[various headers]
{
data : 3217
}

Reading of all cards

GET .../classes/Asset/cards HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 24

Web Service Manual REST web service

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
Room : null,
Description : Acer - AL1716,
Notes : null,
Workplace : null,
ScreenSize : null,
Brand : 138,
PurchaseDate : null,
SerialNumber : null,
AcceptanceNotes : null,
Code : MON0001,
TechnicalReference" : null,
FinalCost : null,
AcceptanceDate : null,
Model : AL1716,
_id : 550,
_type : Asset,
Assignee : 134,
Type" : null,
Supplier" : null
},
{
...
}
]
}

Reading of the details of a card

GET .../classes/Asset/cards/550 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {

CMDBuild – Open Source Configuration and Management Database Page 25

Web Service Manual REST web service

Room : null,
Description : Acer - AL1716,
Notes : null,
Workplace : null,
ScreenSize : null,
Brand : 138,
PurchaseDate : null,
SerialNumber : null,
AcceptanceNotes : null,
Code : MON0001,
TechnicalReference" : null,
FinalCost : null,
AcceptanceDate : null,
Model : AL1716,
_id : 550,
_type : Asset,
Assignee : 134,
Type" : null,
Supplier" : null
}
}

Update of a card
PUT .../classes/Building/cards/3217 HTTP/1.1
[various headers]
{
Code = test,
...
}

HTTP/1.1 204 No Content

Deletion of a card
DELETE .../classes/Building/cards/3217 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Domains and relations management

Reading of all domains
GET .../domains HTTP/1.1

CMDBuild – Open Source Configuration and Management Database Page 26

Web Service Manual REST web service

[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_id : WorkplaceComposition,
name : WorkplaceComposition,
description : Workplace composition
},
...
{
...
}
]
}

Read of the details of a domain

GET .../domains/WorkplaceComposition HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
data" : {
_id : WorkplaceComposition,
descriptionMasterDetail : Asset,
sourceProcess : false,
descriptionInverse : belongs to workplace,
descriptionDirect : includes assets,
destinationProcess : false,
name : WorkplaceComposition,
source : Workplace,
destination : Asset,
cardinality : 1:N,
description : Workplace composition
}
}

CMDBuild – Open Source Configuration and Management Database Page 27

Web Service Manual REST web service

Read of all attributes of a domain

GET .../domains/UserRole/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : 1
},
data : [
{
targetClass : null,
editorType : null,
unique : false,
description : Default Group,
index : 1,
defaultValue : null,
lookupType : null,
active : true,
precision : null,
inherited : false,
displayableInList : true,
name : DefaultGroup,
mandatory : false,
type : boolean,
group : null,
scale : null,
values : [],
_id : DefaultGroup,
flter" : null,
length" : null
}
]
}

Creation of a relation
POST .../domains/UserRole/relations/ HTTP/1.1
[various headers]
{
date : {
_sourceType : User,

CMDBuild – Open Source Configuration and Management Database Page 28

Web Service Manual REST web service

_sourceId : 123,
_destinationType : Role,
_destinationId : 456,
DefaultGroup : false
}
}

HTTP/1.1 200 OK
[various headers]
{
data : 789
}

Reading of all relations

GET .../UserRole/relations HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_destinationDescription : Helpdesk,
_sourceDescription : Jones Patricia,
_sourceType : User,
_sourceId : 678,
_destinationType : Role,
_type : UserRole,
_destinationId : 677,
_id : 681
},
...
{
...
}
]
}

CMDBuild – Open Source Configuration and Management Database Page 29

Web Service Manual REST web service

Read of the details of a relation

GET .../domains/UserRole/relations/681 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : 681,
_destinationId : 677,
_destinationType : Role,
_destinationDescription : Helpdesk,
_sourceId : 678,
_sourceDescription : Jones Patricia,
_type : UserRole,
DefaultGroup : null,
_sourceType : User
}
}

Update of a relation
POST .../domains/UserRole/relations/123 HTTP/1.1
[various headers]
{
date : {
DefaultGroup : true
}
}

HTTP/1.1 204 No Content

Deletion of a relation
DELETE .../domains/UserRole/relations/123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Processes, instances and activities management

Read of all processes
GET .../processes HTTP/1.1

CMDBuild – Open Source Configuration and Management Database Page 30

Web Service Manual REST web service

[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_id : RequestForChange,
name : RequestForChange,
prototype : false,
parent : Activity,
description : Request for change
}
...
{
...
}
]
}
Read of the details of a process
GET .../processes/RequestForChange HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
name : RequestForChange,
statuses : [
6,
7,
8,
10
],
description : Request for change,
description_attribute_name : Description,
prototype : false,
_id : RequestForChange,
parent : Activity,

CMDBuild – Open Source Configuration and Management Database Page 31

Web Service Manual REST web service

defaultStatus : 6
}
}

Read of all attributes of a process

GET .../processes/RequestForChange/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
name : Dummy,
scale : null,
_id : Dummy,
inherited : false,
precision" : null,
description : Dummy,
editorType : null,
type : string,
unique : false,
targetClass : null,
defaultValue : null,
values : [],
flter : null,
group : null,
lookupType : null,
length : 100,
mandatory : false,
index : 0,
active : true,
displayableInList : false
},
...
{
...
}
]
}

CMDBuild – Open Source Configuration and Management Database Page 32

Web Service Manual REST web service

Read of all starting activities of a process

GET .../processes/RequestForChange/start_activities HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : 1
}
data : [
{
_id : RegisterRFC,
description : Register RFC,
writable : true
}
]
}

Read of the details of a starting activity

GET .../processes/RequestForChange/start_activities/RegisterRFC HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
attributes : [
{
mandatory : true,
_id : Requester,
index : 0,
writable : true
},
{
writable : true,
index : 1,
_id : RFCDescription,
mandatory : true
}
],

CMDBuild – Open Source Configuration and Management Database Page 33

Web Service Manual REST web service

instructions : ...,
description : Register RFC,
widgets : [],
_id : RegisterRFC
}
}

Read of all the activities of an instance

GET .../processes/RequestForChange/instances/1460/activities HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
description : Formal evaluation,
_id : foo,
writable : true
},
...
{
...
}
]
}

Read of the details of an activity

GET .../processes/RequestForChange/instances/1460/activities/foo HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
widgets : [
{
type : .OpenAttachment,
active : true,

CMDBuild – Open Source Configuration and Management Database Page 34

Web Service Manual REST web service

_id : widget-57a9a9d9,
required : false,
date : {
...
},
label : Attachments
},
...
{
...
}
],
_id : FormalEvaluation,
attributes : [
{
mandatory : false,
writable : false,
_id : RFCStartDate,
index : 0
},
...
{
...
}
],
instructions : ...,
description : Formal evaluation
}
}

Creation of a process instance

POST .../processes/RequestForChange/instances HTTP/1.1
[various headers]
{
Requester : 123,
RFCDescription : test,
_advance = true
}

HTTP/1.1 200 OK
[various headers]
{
data : 1460

CMDBuild – Open Source Configuration and Management Database Page 35

Web Service Manual REST web service

According with the value of the "_advance" attribute, an instance can be advanced or just saved.

Reading of all process instances

GET .../processes/RequestForChange/instances HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
Category : null,
FinalResult : null,
RFCEndDate : null,
ExecutionEndDate : null,
RFCDescription : test,
Requester : 123,
...
_type : RequestForChange,
_name : null,
_id : 1460,
_status : 6
},
...
{
...
}
]
}

Read of the details of an instance

GET .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 36

Web Service Manual REST web service

{
date : {
FinalResult : null,
RFCEndDate : null,
ExecutionEndDate : null,
RFCDescription : test,
Requester : 123,
...
_type : RequestForChange,
_name : null,
_id : 1460,
_status : 6
}
}

Update of an instance
PUT .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]
{
Requester : 123,
RFCDescription : test,
_advance = true
}

HTTP/1.1 204 No Content

According with the value of the "_advance" attribute, an instance can be advanced or just saved.

Deletion of an instance
DELETE .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Menu management
Reading of the menu
GET .../menu HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 37

Web Service Manual REST web service

HTTP/1.1 200 OK
[various headers]
{
date : {
menuType : root,
children : [
{
menuType : folder,
objectId : 0,
children" : [
...
],
...
},
...
{
objectDescription : Employee,
children : [],
objectType : Employee,
objectId : 0,
index : 34,
menuType : class
},
]
}
}

Configuration management
Reading of all attachments categories
GET .../confguration/attachments/categories HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id : Document,
description : Document"
},

CMDBuild – Open Source Configuration and Management Database Page 38

Web Service Manual REST web service

...
{
description : Image,
_id : Image
}
]
}

Read of all attributes of a category

> GET .../confguration/attachments/categories/Document/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
length : null,
index : 0,
editorType : null,
targetClass : null,
inherited : null,
...
},
...
{
...
}
]
}

Read of all process statuses

GET .../confguration/processes/statuses HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {

CMDBuild – Open Source Configuration and Management Database Page 39

Web Service Manual REST web service

total : ...
},
data : [
{
_id : 6,
description : Open,
value : open
},
...
{
...
}
]
}

Privileges management
Reading of all privileges for a role
GET .../roles/Foo/classes_privileges HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
name : UPS,
description : UPS,
mode : w,
_id : UPS
},
...
{
name : License,
_id : License,
description : License,
mode" : r
}
]
}

CMDBuild – Open Source Configuration and Management Database Page 40

Web Service Manual REST web service

Attachments management
It is applied in the same way as reported for process instances. So, by replacing
.../classes/${CLASS_ID}/cards/${CARD_ID}
with
.../processes/${PROCESS_ID}/instances/${PROCESS_ID}
you will have the same capabilities.

Upload of an attachment
POST .../classes/Building/cards/64/attachments HTTP/1.1
[various headers]
Content-Type : multipart/form-data

== Part, name : "attachment", content-type : "application/json" ==

{
_description : this is a test,
_category" : Image,
}
====

== Part, name : "fle", content-type : "/" ==

binary
====

HTTP/1.1 200 OK
[various headers]
{
data : abc123
}

Notes:
• the mehod uses “multipart/form-data” content-type
• uploads file and sets properies

Reading of all attachments

GET .../classes/Building/cards/64/attachments HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{

CMDBuild – Open Source Configuration and Management Database Page 41

Web Service Manual REST web service

meta : {
total : ...
}
data : [
{
_name : test.jpg,
_id" : "abc123,
_version : 1.3,
_description : this is a test,
_modifed" : 2014-12-16T12:35:12,
_category" : Image,
_created" : 2014-11-20T14:20:04,
_author" : admin
},
...
{
...
}
]
}

Reading of the details of an attachment

GET .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_category : Image,
_created : 2014-11-20T14:20:04,
_description : this is a test,
_author : admin,
_id : abc123,
_version : 1.3,
_modifed : 2014-12-16T12:35:12,
_name : test.jpg
}
}

Download of an attachment
GET .../classes/Building/cards/64/attachments/abc123/download.jpg HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 42

Web Service Manual REST web service

HTTP/1.1 200 OK
[various headers]
Content-Type : application/octet-stream

Update of an attachment
PUT .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]
Content-Type : multipart/form-data

== Part, name : "attachment", content-type : "application/json" ==

{
_description : this is a test,
_category" : Image,
}
====

== Part, name : "fle", content-type : "/" ==

binary
====

HTTP/1.1 204 No Content

Notes:
• the mehod uses “multipart/form-data” content-type
• it uploads file and sets properties

Deletion of an attachment
DELETE .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Version 2
Endpoint
http://hostname:port/cmdbuild/services/rest/v2

CMDBuild – Open Source Configuration and Management Database Page 43

Web Service Manual REST web service

Dates format
All dates (time, timestamp and date attributes) uses the format "yyyy-MM-dd'T'HH:mm:ss".

If the resource requires a session and the token is not sent or is not correct then the answer will
be:
HTTP/1.1 401 Unauthorized
[various headers]

Creation of a session
This is the only one method that does not require a session.
POST .../sessions/ HTTP/1.1
[various other headers]
{
username : ...,
password : ...
}

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : ${SESSION}
username : ...
password : null
role : ...
}
}

Reading a session
GET .../sessions/${SESSION}/ HTTP/1.1

CMDBuild – Open Source Configuration and Management Database Page 44

Web Service Manual REST web service

[various other headers]

HTTP/1.1 200 OK
[various headers]
{
username : ...
password : null
role : ...
}

HTTP/1.1 204 No Content

[various headers]

You can change the role associated with a session (thus passing from a session with partial
authorizations to complete and vice versa).

Deletion of a session
DELETE .../sessions/${SESSION}/ HTTP/1.1
[various other headers]

HTTP/1.1 204 OK
[various headers]

Reading of all roles associated to a session

GET /sessions/${SESSION}/roles/ HTTP/1.1
[various other headers]

HTTP/1.1 200 OK
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 45

Web Service Manual REST web service

{
data : [foo, bar]
}

Lookup management
Reading of all types
GET .../lookup_types HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id : ...,
name : ...,
parent : ...
},
...
{
...
},
]
}

Read of the details of a type

GET .../lookup_types HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id : ...,
name : ...,
parent : ...
}
}

CMDBuild – Open Source Configuration and Management Database Page 46

Web Service Manual REST web service

Read of all values of a type

GET .../lookup_types/AlfrescoCategory/values HTTP/1.1
[various headers]

Read of the details of a value

GET .../lookup_types/AlfrescoCategory/values/703 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_type" : AlfrescoCategory,
_id" : 703,
code" : null,
description" : Document,

CMDBuild – Open Source Configuration and Management Database Page 47

Web Service Manual REST web service

parent_type" : null,
active" : true,
number" : 1,
default" : false,
parent_id" : null
}
}

Classes and cards management

Reading of all classes
GET .../classes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_id : Asset,
name : Asset,
description : Asset,
parent : Class,
prototype : true
},
...
{
...
}
]
}

Read of the details of a class

GET .../classes/Asset HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{

CMDBuild – Open Source Configuration and Management Database Page 48

Web Service Manual REST web service

date : {
_id : Asset,
name : Asset,
description : Asset,
description_attribute_name : Description,
parent : Class,
prototype : true
}
}

Read of all attributes of a class

GET .../classes/Asset/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
lookupType : null,
index : 1,
group : General data,
unique : false,
scale : null,
editorType : null,
targetClass : null,
active : true,
description : Code,
type : string,
displayableInList : true,
values : [],
length : 100,
name : Code,
_id : Code,
flter : null,
mandatory : false,
precision : null,
defaultValue" : null,
inherited" : true
},

CMDBuild – Open Source Configuration and Management Database Page 49

Web Service Manual REST web service

...
{
...
}
]
}

Creation of a card
POST .../classes/Building/cards HTTP/1.1
[various headers]
{
Code = test,
...
}

HTTP/1.1 200 OK
[various headers]
{
data : 3217
}

Reading of all cards

GET .../classes/Asset/cards HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 50

Web Service Manual REST web service

Code : MON0001,
TechnicalReference" : null,
FinalCost : null,
AcceptanceDate : null,
Model : AL1716,
_id : 550,
_type : Asset,
Assignee : 134,
Type" : null,
Supplier" : null
},
{
...
}
]
}

Reading of the details of a card

GET .../classes/Asset/cards/550 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
Room : null,
Description : Acer - AL1716,
Notes : null,
Workplace : null,
ScreenSize : null,
Brand : 138,
PurchaseDate : null,
SerialNumber : null,
AcceptanceNotes : null,
Code : MON0001,
TechnicalReference" : null,
FinalCost : null,
AcceptanceDate : null,
Model : AL1716,
_id : 550,
_type : Asset,
Assignee : 134,
Type" : null,

CMDBuild – Open Source Configuration and Management Database Page 51

Web Service Manual REST web service

Supplier" : null
}
}

Update of a card
PUT .../classes/Building/cards/3217 HTTP/1.1
[various headers]
{
Code = test,
...
}

HTTP/1.1 204 No Content

Deletion of a card
DELETE .../classes/Building/cards/3217 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Domains and relations management

Reading of all domains
GET .../domains HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_id : WorkplaceComposition,
name : WorkplaceComposition,
description : Workplace composition
},
...
{
...

CMDBuild – Open Source Configuration and Management Database Page 52

Web Service Manual REST web service

}
]
}

Read of the details of a domain

GET .../domains/WorkplaceComposition HTTP/1.1
[various headers]

Read of all attributes of a domain

GET .../domains/UserRole/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : 1
},
data : [
{
targetClass : null,
editorType : null,
unique : false,
description : Default Group,

CMDBuild – Open Source Configuration and Management Database Page 53

Web Service Manual REST web service

index : 1,
defaultValue : null,
lookupType : null,
active : true,
precision : null,
inherited : false,
displayableInList : true,
name : DefaultGroup,
mandatory : false,
type : boolean,
group : null,
scale : null,
values : [],
_id : DefaultGroup,
flter" : null,
length" : null
}
]
}

Creation of a relation
POST .../domains/UserRole/relations/ HTTP/1.1
[various headers]
{
_sourceType : User,
_sourceId : 123,
_destinationType : Role,
_destinationId : 456,
DefaultGroup : false
}

HTTP/1.1 200 OK
[various headers]
{
data : 789
}

Reading of all relations

GET .../UserRole/relations HTTP/1.1
[various headers]

HTTP/1.1 200 OK

CMDBuild – Open Source Configuration and Management Database Page 54

Web Service Manual REST web service

[various headers]
{
meta : {
total : ...
},
data : [
{
_destinationDescription : Helpdesk,
_sourceDescription : Jones Patricia,
_sourceType : User,
_sourceId : 678,
_destinationType : Role,
_type : UserRole,
_destinationId : 677,
_id : 681
},
...
{
...
}
]
}

Read of the details of a relation

GET .../domains/UserRole/relations/681 HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 55

Web Service Manual REST web service

Update of a relation
POST .../domains/UserRole/relations/123 HTTP/1.1
[various headers]
{
date : {
DefaultGroup : true
}
}

HTTP/1.1 204 No Content

Deletion of a relation
DELETE .../domains/UserRole/relations/123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Processes, instances and activities management

Read of all processes
GET .../processes HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 56

Web Service Manual REST web service

]
}
Read of the details of a process
GET .../processes/RequestForChange HTTP/1.1
[various headers]

Read of all attributes of a process

GET .../processes/RequestForChange/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
name : Dummy,
scale : null,
_id : Dummy,
inherited : false,

CMDBuild – Open Source Configuration and Management Database Page 57

Web Service Manual REST web service

precision" : null,
description : Dummy,
editorType : null,
type : string,
unique : false,
targetClass : null,
defaultValue : null,
values : [],
flter : null,
group : null,
lookupType : null,
length : 100,
mandatory : false,
index : 0,
active : true,
displayableInList : false
},
...
{
...
}
]
}

Read of all starting activities of a process

GET .../processes/RequestForChange/start_activities HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : 1
}
data : [
{
_id : RegisterRFC,
description : Register RFC,
writable : true
}
]
}

CMDBuild – Open Source Configuration and Management Database Page 58

Web Service Manual REST web service

Read of the details of a starting activity

GET .../processes/RequestForChange/start_activities/RegisterRFC HTTP/1.1
[various headers]

Read of all the activities of an instance

GET .../processes/RequestForChange/instances/1460/activities HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
description : Formal evaluation,

CMDBuild – Open Source Configuration and Management Database Page 59

Web Service Manual REST web service

_id : foo,
writable : true
},
...
{
...
}
]
}

Read of the details of an activity

GET .../processes/RequestForChange/instances/1460/activities/foo HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
widgets : [
{
type : .OpenAttachment,
active : true,
_id : widget-57a9a9d9,
required : false,
date : {
...
},
label : Attachments
},
...
{
...
}
],
_id : FormalEvaluation,
attributes : [
{
mandatory : false,
writable : false,
_id : RFCStartDate,
index : 0
},
...

CMDBuild – Open Source Configuration and Management Database Page 60

Web Service Manual REST web service

{
...
}
],
instructions : ...,
description : Formal evaluation
}
}

Creation of a process instance

POST .../processes/RequestForChange/instances HTTP/1.1
[various headers]
{
Requester : 123,
RFCDescription : test,
_advance = true,
_activity = StartActivityName
}

HTTP/1.1 200 OK
[various headers]
{
data : 1460
}

According with the value of the "_advance" attribute, an instance can be advanced or just saved.

Reading of all process instances

GET .../processes/RequestForChange/instances HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
Category : null,
FinalResult : null,

CMDBuild – Open Source Configuration and Management Database Page 61

Web Service Manual REST web service

RFCEndDate : null,
ExecutionEndDate : null,
RFCDescription : test,
Requester : 123,
...
_type : RequestForChange,
_name : null,
_id : 1460,
_status : 6
},
...
{
...
}
]
}

Read of the details of an instance

GET .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
FinalResult : null,
RFCEndDate : null,
ExecutionEndDate : null,
RFCDescription : test,
Requester : 123,
...
_type : RequestForChange,
_name : null,
_id : 1460,
_status : 6
}
}

Update of an instance
PUT .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]
{
Requester : 123,

CMDBuild – Open Source Configuration and Management Database Page 62

Web Service Manual REST web service

RFCDescription : test,
_advance = true
_activity = CurrentActivityName
}

HTTP/1.1 204 No Content

According with the value of the "_advance" attribute, an instance can be advanced or just saved.

Deletion of an instance
DELETE .../processes/RequestForChange/instances/1460 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Menu management
Reading of the menu
GET .../menu HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 63

Web Service Manual REST web service

index : 34,
menuType : class
},
]
}
}

Configuration management
Reading of all attachments categories
GET .../confguration/attachments/categories HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id : Document,
description : Document"
},
...
{
description : Image,
_id : Image
}
]
}

Read of all attributes of a category

> GET .../confguration/attachments/categories/Document/attributes HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},

CMDBuild – Open Source Configuration and Management Database Page 64

Web Service Manual REST web service

data : [
{
length : null,
index : 0,
editorType : null,
targetClass : null,
inherited : null,
...
},
...
{
...
}
]
}

Read of all process statuses

GET .../confguration/processes/statuses HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id : 6,
description : Open,
value : open
},
...
{
...
}
]
}

Privileges management
Reading of all privileges for a role
GET .../roles/Foo/classes_privileges HTTP/1.1

CMDBuild – Open Source Configuration and Management Database Page 65

Web Service Manual REST web service

[various headers]

Upload of an attachment
POST .../classes/Building/cards/64/attachments HTTP/1.1
[various headers]
Content-Type : multipart/form-data

== Part, name : "attachment", content-type : "application/json" ==

{
_description : this is a test,
_category" : Image,
}
====

CMDBuild – Open Source Configuration and Management Database Page 66

Web Service Manual REST web service

== Part, name : "fle", content-type : "/" ==

binary
====

HTTP/1.1 200 OK
[various headers]
{
data : abc123
}

Notes:
• the mehod uses “multipart/form-data” content-type
• uploads file and sets properies

Reading of all attachments

GET .../classes/Building/cards/64/attachments HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [
{
_name : test.jpg,
_id" : "abc123,
_version : 1.3,
_description : this is a test,
_modifed" : 2014-12-16T12:35:12,
_category" : Image,
_created" : 2014-11-20T14:20:04,
_author" : admin
},
...
{
...
}
]
}

CMDBuild – Open Source Configuration and Management Database Page 67

Web Service Manual REST web service

Reading of the details of an attachment

GET .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]

Download of an attachment
GET .../classes/Building/cards/64/attachments/abc123/download.jpg HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
Content-Type : application/octet-stream

Update of an attachment
PUT .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]
Content-Type : multipart/form-data

== Part, name : "attachment", content-type : "application/json" ==

{
_description : this is a test,
_category" : Image,
}
====

== Part, name : "fle", content-type : "/" ==

CMDBuild – Open Source Configuration and Management Database Page 68

Web Service Manual REST web service

binary
====

HTTP/1.1 204 No Content

Notes:
• the mehod uses “multipart/form-data” content-type
• it uploads file and sets properties

Deletion of an attachment
DELETE .../classes/Building/cards/64/attachments/abc123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

CQL query
Query execution
GET .../cql?... HTTP/1.1
[various headers]

Parameters:
• filter: it includes the expression
{
CQL: ...
}
• sort: it includes the organized list of the attributes to execute the order
[
{
property: Description
direction: ASC
},{
property: Code
direction: DESC
}
]
• limit: it includes the number of the returned results
• start: it includes the offset from the beginning of the list

HTTP/1.1 200 OK

CMDBuild – Open Source Configuration and Management Database Page 69

Web Service Manual REST web service

[various headers]
{
meta : {
total : ...
}
data : [
{
_id : Asset,
name : Asset,
description : Asset,
parent : Class,
prototype : true
},
...
{
...
}
]
}

E-mail template management

Reading of all e-mail templates
GET .../email_templates?start=...&limit=... HTTP/1.1
[various headers]
HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [ foo, bar, baz ]
}

Reading of the details of a template

GET .../email_templates/foo HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id: ...

CMDBuild – Open Source Configuration and Management Database Page 70

Web Service Manual REST web service

name: ...
description: ...
from: ...
to: ...
cc: ...
bcc: ...
subject: ...
body: ...
notifyWith: ...
noSubjectPrefx: ...
account: ...
keepSynchronization: ...
promptSynchronization: ...
delay: ...
}
}

E-mail management
It is applied in the same way as reported for process instances. So, by replacing
.../classes/${CLASS_ID}/cards/${CARD_ID}/emails
with
.../processes/${PROCESS_ID}/instances/${PROCESS_ID}/emails
you will have the same capabilities.

Reading of e-mail statuses

GET .../classes/Building/cards/64/emails/statuses HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
}
data : [ received, draft, outgoing, sent ]
}

In order to send an e-mail, it should be set as "outgoing". At that point you cannot change it
anymore.

CMDBuild – Open Source Configuration and Management Database Page 71

Web Service Manual REST web service

Creation of an e-mail
POST .../classes/Building/cards/64/emails HTTP/1.1
[various headers]
{
from: ...
to: ...
cc: ...
bcc: ...
subject: ...
body: ...
status: ...
notifyWith: ...
noSubjectPrefx: ...
account: ...
template: ...
keepSynchronization: ...
promptSynchronization: ...
delay: ...
}

HTTP/1.1 200 OK
[various headers]
{
date : 123
}
E-mails are always created in a “draft” status. In order to send e-mails, you have to update them
after their creation and set the “outgoing” status.

Reading of all e-mails

GET .../classes/Building/cards/64/emails HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
from: ...
to: ...

CMDBuild – Open Source Configuration and Management Database Page 72

Web Service Manual REST web service

cc: ...
bcc: ...
subject: ...
body: ...
status: ...
notifyWith: ...
noSubjectPrefx: ...
account: ...
template: ...
keepSynchronization: ...
promptSynchronization: ...
delay: ...
},
{
...
}
]
}

Reading of the details of an e-mail

GET .../classes/Building/cards/64/emails/123 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
from: ...
to: ...
cc: ...
bcc: ...
subject: ...
body: ...
status: ...
notifyWith: ...
noSubjectPrefx: ...
account: ...
template: ...
keepSynchronization: ...
promptSynchronization: ...
delay: ...
}
}

CMDBuild – Open Source Configuration and Management Database Page 73

Web Service Manual REST web service

E-mail update
PUT .../classes/Building/cards/64/emails/123 HTTP/1.1
[various headers]
{
from: ...
to: ...
cc: ...
bcc: ...
subject: ...
body: ...
status: ...
notifyWith: ...
noSubjectPrefx: ...
account: ...
template: ...
keepSynchronization: ...
promptSynchronization: ...
delay: ...
}

HTTP/1.1 204 No Content

Deletion of an e-mail
DELETE .../classes/Building/cards/64/emails/123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Management of functions
Reading of all functions
GET .../functions?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},

CMDBuild – Open Source Configuration and Management Database Page 74

Web Service Manual REST web service

data : [
{
name: ...
description: ...
},
{
...
}
]
}

Reading of the details of a function

GET .../functions/foo HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
name: ...
description: ...
}
}

Reading of input values/attributes of a function

GET .../functions/foo/parameters?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
type: ...
name: ...
description: ...
...
},
{

CMDBuild – Open Source Configuration and Management Database Page 75

Web Service Manual REST web service

...
}
]
}

Reading of output values/attributes of a function

GET .../functions/foo/attributes?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
type: ...
name: ...
description: ...
...
},
{
...
}
]
}

Execution of a function in order to get its results

GET .../functions/foo/outputs HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
...
},

CMDBuild – Open Source Configuration and Management Database Page 76

Web Service Manual REST web service

{
...
}
]
}

Report management
Reading of all reports
GET .../reports?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id: ...
description: ...
},
{
...
}
]
}

Reading of the details of a report

GET .../reports/123 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id: ...
title: ...
description: ...
}
}

CMDBuild – Open Source Configuration and Management Database Page 77

Web Service Manual REST web service

Reading of input values/attributes of a report

GET .../reports/123/attributes?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
type: ...
name: ...
description: ...
...
},
{
...
}
]
}

Download of a report
GET .../reports/123/somename.someextension?extension=...&parameters={“foo”: “FOO”,
“bar”: “BAR”, ...} HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
Content-Type : application/octet-stream

Management of domain trees

Reading of all trees
GET .../domainTrees?start=...&limit=... HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 78

Web Service Manual REST web service

{
meta : {
total : ...
},
data : [
{
_id: ...
description: ...
},
{
...
}
]
}

Reading of the details of a tree

GET .../domainTrees/123 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id: ...
description: ...
nodes: [
{
_id: ...
parent: ...
metadata: {
...
}
},
...
]
}
}

Management of images
Reading of all folders
GET .../flestores/images/folders HTTP/1.1
[various headers]

CMDBuild – Open Source Configuration and Management Database Page 79

Web Service Manual REST web service

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id: ...
name: ...
parent: ...
},
{
...
}
]
}

Reading of the details of a folder

GET .../flestores/images/folders/foo HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id: ...
name: ...
parent: ...
}
}

Upload of a file into a folder

POST .../flestores/images/folders/foo/fles HTTP/1.1
[various headers]
Content-Type : multipart/form-data

== Part, name : "fle", content-type : "/" ==

binary
====

CMDBuild – Open Source Configuration and Management Database Page 80

Web Service Manual REST web service

HTTP/1.1 200 OK
[various headers]
{
data : bar
}

Reading of all files into a folder

GET .../flestores/images/folders/foo/fles HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [
{
_id: ...
name: ...
parent: ...
},
{
...
}
]
}

Reading of the details of a file

GET .../flestores/images/folders/foo/fles/bar HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
_id: ...
name: ...
parent: ...
}
}

CMDBuild – Open Source Configuration and Management Database Page 81

Web Service Manual REST web service

Download of a file
GET .../flestores/images/folders/foo/fles/bar/download HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
Content-Type : application/octet-stream

Deletion of a file
DELETE .../flestores/images/folders/foo/fles/bar HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

Icons management
JSON model of the icon:
{
_id: ...
type: ...
details: {
...
}
image: {
type: ...
details: {
…
}
}
}

type: it represents the kind of icon to upload. The supported types are
• class
• process
details: according to type
• type: class
id has to include the class name
• type: process
id has to include the process name

CMDBuild – Open Source Configuration and Management Database Page 82

Web Service Manual REST web service

image: it represents the associated image

• type: "filestore"
• details: according to the type, but "filestore" is the only one that is supported, so:
• store: store id (see Methods for the file management)
• folder: folder id (see Methods for the file managemen)
• file: file id (see Methods for the file management)

Creation of an icon
POST .../icons HTTP/1.1
[various headers]
{
type: ...
details: {
...
}
image: {
type: ...
details: {
…
}
}
}

HTTP/1.1 200 OK
[various headers]
{
date : 123
}

Reading of all icons

GET .../icons HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
meta : {
total : ...
},
data : [

CMDBuild – Open Source Configuration and Management Database Page 83

Web Service Manual REST web service

{
_id: ...
...
},
{
...
}
]
}

Reading of the details of an icon

GET .../icons/123 HTTP/1.1
[various headers]

HTTP/1.1 200 OK
[various headers]
{
date : {
...
}
}

Update of an icon
PUT ..../icons/123 HTTP/1.1
[various headers]
{
...
}

HTTP/1.1 204 No Content

Deletion of a file
DELETE .../icons/123 HTTP/1.1
[various headers]

HTTP/1.1 204 No Content

CMDBuild – Open Source Configuration and Management Database Page 84

Web Service Manual APPENDIX: Glossary

APPENDIX: Glossary
ATTACHMENT
An attachment is a file associated to a card.
In order to manage the attachments, CMDBuild uses in embedded mode any document system
which is compatible with the standard protocol CMIS (or the DMS Alfresco until the version 3
through its native webservice).
The management of the attachments supports the versioning of those files that have been uploaded
a few times, with automatic numbering.
WORKFLOW STEP
"Activity" means one of the steps of which the process consists.
An activity has a name, an executor, a type, possible attributes and methods with statements
(CMDBuild API) to be executed.
A process instance is a single process that has been activated automatically by the application or
manually by an operator.
See also: Process
ATTRIBUTE
The term refers to an attribute of a CMDBuild class.
CMDBuild allows you to create new attributes (in classes and domains) or edit existing ones.
For example, in "supplier" class the attributes are: name, address, phone number, etc..
Each attribute corresponds, in the Management Module, to a form field and to a column in the
database.
See also: Class, Domain, Report, Superclass, Attribute Type
BIM
Method with the aim to support the whole life cycle of a building: from its construction, use and
maintenance, to its demolition, if any.
The BIM method (Building Information Modeling) is supported by several IT programs that can
interact through an open format for data exchange, called IFC (Industry Foundation Classes).
See also: GIS
CI
We define CI (Configuration Item) each item that provides IT service to the user and has a
sufficient detail level for its technical management.
CI examples include: server, workstation, software, operating system, printer, etc.
See also: Configuration

CLASS
A Class is a complex data type having a set of attributes that describe that kind of data.

CMDBuild – Open Source Configuration and Management Database Page 85

Web Service Manual APPENDIX: Glossary

A Class models an object that has to be managed in the CMDB, such as a computer, a software, a
service provider, etc.
CMDBuild allows the administrator - with the Administration Module - to define new classes or
delete / edit existing ones.
Classes are represented by cards and, in the database, by tables automatically created at the
definition time.
See also: Card, Attribute
CONFIGURATION
The configuration management process is designed to keep updated and available to other
processes the items (CI) information, their relations and their history.
It is one of the major ITIL processes managed by the application.
See also: CI, ITIL
DASHBOARD
In CMDBuild, a dashboard corresponds to a collection of different charts, in this way you can
immediately hold in evidence some key parameters (KPI) related to a particular management
aspect of the IT service.
See also: Report
DATABASE
The term refers to a structured collection of information, hosted on a server, as well as utility
software that handle this information for tasks such as initialization, allocation, optimization,
backup, etc..
CMDBuild relies on PostgreSQL, the most powerful, reliable, professional and open source
database , and uses its advanced features and object-oriented structure.
DOMAIN
A domain is a relation between two classes.
A domain has a name, two descriptions (direct and inverse), classes codes, cardinality and
attributes.
The system administrator, using the Administration Module, is able to define new domains or
delete / edit existing ones.
It is possible to define custom attributes for each domain.
See also: Class, Relation
DATA FILTER
A data filter is a restriction of the list of those elements contained in a class, obtained by specifying
boolean conditions (equal, not equal, contains, begins with, etc.) on those possible values that can
be accepted by every class attribute.
Data filters can be defined and used exceptionally, otherwise they can be stored by the operator
and then recalled (by the same operator or by operators of other user groups, which get the
permission to use them by the system Administrator)
See also: Class, View

CMDBuild – Open Source Configuration and Management Database Page 86

Web Service Manual APPENDIX: Glossary

GIS
A GIS is a system able to produce, manage and analyse spatial data by associating geographic
elements to one or more alphanumeric descriptions.
GIS functionalities in CMDBuild allow you to create geometric attributes (in addition to standard
attributes) that represent, on plans / maps, markers position (assets), polylines (cable lines) and
polygons (floors, rooms, etc.).
See also: BIM
GUI FRAMEWORK
It is a user interface you can completely customise. It is advised to supply a simplified access to
the application. It can be issued onto any webportals and can be used with CMDBuild through the
standard REST webservice.
See also: Mobile, Webservice
ITIL
"Best practices" system that established a "standard de facto"; it is a nonproprietary system for the
management of IT services, following a process-oriented schema (Information Technology
Infrastructure Library).
ITIL processes include: Service Support, Incident Management, Problem Management, Change
Management, Configuration Management and Release Management.
For each process, ITIL handles description, basic components, criteria and tools for quality
management, roles and responsibilities of the resources involved, integration points with other
processes (to avoid duplications and inefficiencies).
See also: Configuration
LOOKUP
The term "Lookup" refers to a pair of values (Code, Description) set by the administrator in the
Administration Module.
These values are used to bind the user's choice (at the form filling time) to one of the preset
values.
With the Administration Module it is possible to define new "LookUp" tables according to
organization needs.
MOBILE
It is a user interface for mobile tools (smartphones and tablets). It is implemented as multi-platform
app (iOS, Android) and can be used with the CMDB through the REST webservice.
See also: GUI Framework, Webservice
PROCESS
The term "process" (or workflow) refers to a sequence of steps that realize an action.
Each process will take place on specific assets and will be performed by specific users.
A process is activated by starting a new process (filling related form) and ends when the last
workflow step is executed.
See also: Workflow step

CMDBuild – Open Source Configuration and Management Database Page 87

Web Service Manual APPENDIX: Glossary

RELATION
A relation is a link between two CMDBuild cards or, in other words, an instance of a given domain.
A relation is defined by a pair of unique card identifiers, a domain and attributes (if any).
CMDBuild allows users, through the Management Module, to define new relations among the
cards stored in the database.
See also: Class, Domain
REPORT
The term refers to a document (PDF or CSV) containing information extracted from one or more
classes and related domains.
CMDBuild users run reports by using the Management Module; reports definitions are stored in the
database.
See also: Class, Domain, Database
CARD
The term "card" refers to an element stored in a class.
A card is defined by a set of values, i.e. the attributes defined for its class.
CMDBuild users, through the Management Module, are able to store new cards and update /
delete existing ones.
Card information is stored in the database and, more exactly, in the table/columns created for that
class (Administration Module).
See also: Class, Attribute
SUPERCLASS
A superclass is an abstract class used to define attributes shared between classes. From the
abstract class you can derive real classes that contain data and include both shared attributes
(specified in the superclass) and specific subclass attributes.
For example, you can define the superclass "Computer" with some basic attributes (RAM, HD,
etc.) and then define derived subclasses "Desktop", "Notebook", "Server", each one with some
specific attributes.
See also: Class, Attribute
ATTRIBUTE TYPE
Each attribute has a data type that represents attribute information and management.
The attribute type is defined using the Administration Module and can be modified within some
limitations, depending on the data already stored in the system.
CMDBuild manages the following attribute types: "Boolean", "Date", "Decimal", "Double", "Inet" (IP
address), "Integer", "Lookup" (lists set in "Settings" / "LookUp"), "Reference" (foreign key), "String",
"Text", "Timestamp".
See also: Attribute
VIEW
A view not only includes the whole content of a CMDB class, it is a group of cards defined in a
logical way.

CMDBuild – Open Source Configuration and Management Database Page 88

Web Service Manual APPENDIX: Glossary

In particular, a view can be defined in CMDBuild by applying a filter to a class (so it will contain a
reduced set of the same rows) or specifying an SQL function which extracts attributes from one or
more related classes.
The first view type maintains all functionalities available for a class, the second one allows the sole
display and search with fast filter.
See also: Class, Filter
WEBSERVICE
A webservice is an interface that describes a collection of methods, available over a network and
working using XML messages.
With webservices, an application allows other applications to interact with its methods.
CMDBuild includes a SOAP and a REST webservice.
WIDGET
A widget is a component of a GUI that improves user interaction with the application.
CMDBuild uses widgets (presented as "buttons") that can be placed on cards or processes. The
buttons open popup windows that allow you to insert additional information, and then display the
output of the selected function.

CMDBuild – Open Source Configuration and Management Database Page 89

Premium Digital Product Bundle
100% (5)
Premium Digital Product Bundle
22 pages
Introduction to AutoCAD Plant 3D 2021
From Everand
Introduction to AutoCAD Plant 3D 2021
Tutorial Books
4/5 (6)
3D Scroll Saw Patterns & Techniques - Henry Berns, Henry Berro PDF
87% (15)
3D Scroll Saw Patterns & Techniques - Henry Berns, Henry Berro PDF
102 pages
SRS - How to build a Pen Test and Hacking Platform
From Everand
SRS - How to build a Pen Test and Hacking Platform
alasdair gilchrist
2/5 (1)
C# for Beginners: Learn in 24 Hours
From Everand
C# for Beginners: Learn in 24 Hours
Alex Nordeen
No ratings yet
Google Cloud Platform for Data Engineering: From Beginner to Data Engineer using Google Cloud Platform
From Everand
Google Cloud Platform for Data Engineering: From Beginner to Data Engineer using Google Cloud Platform
alasdair gilchrist
5/5 (1)
Mastering Azure Kubernetes Service (AKS): Rapidly Build and Scale Your Containerized Applications with Microsoft Azure Kubernetes Service (English Edition)
From Everand
Mastering Azure Kubernetes Service (AKS): Rapidly Build and Scale Your Containerized Applications with Microsoft Azure Kubernetes Service (English Edition)
Abhishek Mishra
No ratings yet
Web Service Manual: March 2016 Author Tecnoteca SRL
No ratings yet
Web Service Manual: March 2016 Author Tecnoteca SRL
114 pages
Overview Manual in English
No ratings yet
Overview Manual in English
49 pages
Overview Manual in English
No ratings yet
Overview Manual in English
44 pages
CMDBuild UserManual ENG V230 PDF
No ratings yet
CMDBuild UserManual ENG V230 PDF
67 pages
CMDBuild TechnicalManual ENG V220
No ratings yet
CMDBuild TechnicalManual ENG V220
54 pages
User Manual in English
No ratings yet
User Manual in English
169 pages
CMDBuildReady2Use OverviewManual ENG V100
No ratings yet
CMDBuildReady2Use OverviewManual ENG V100
41 pages
Webservice Manual in English
No ratings yet
Webservice Manual in English
81 pages
CMDBuild UserManual ENG V240
No ratings yet
CMDBuild UserManual ENG V240
80 pages
CMDBuilduser Manual in English
No ratings yet
CMDBuilduser Manual in English
108 pages
Webservice Manual
No ratings yet
Webservice Manual
83 pages
Administrator Manual: May 2013 Author Tecnoteca SRL
No ratings yet
Administrator Manual: May 2013 Author Tecnoteca SRL
90 pages
CMDBuild AdministratorManual ENG V250
No ratings yet
CMDBuild AdministratorManual ENG V250
139 pages
CMDBuild AdministratorManual ENG V240
No ratings yet
CMDBuild AdministratorManual ENG V240
134 pages
CMDBuild Presentation
No ratings yet
CMDBuild Presentation
56 pages
Technical Manual: February 2020 Author Tecnoteca SRL
No ratings yet
Technical Manual: February 2020 Author Tecnoteca SRL
52 pages
Technical Manual: January 2012 Author Tecnoteca SRL
No ratings yet
Technical Manual: January 2012 Author Tecnoteca SRL
35 pages
Workflow Manual in English
No ratings yet
Workflow Manual in English
43 pages
IT Governance Management: The Open Source Solution For
No ratings yet
IT Governance Management: The Open Source Solution For
4 pages
Professional Application Lifecycle Management with Visual Studio 2012
From Everand
Professional Application Lifecycle Management with Visual Studio 2012
Mickey Gousset
No ratings yet
Beginning Asp.Net
From Everand
Beginning Asp.Net
Knowledge Flow
No ratings yet
C++ Basics for New Programmers: A Practical Guide with Examples
From Everand
C++ Basics for New Programmers: A Practical Guide with Examples
William E. Clark
No ratings yet
Professional Access 2013 Programming
From Everand
Professional Access 2013 Programming
Ben Clothier
No ratings yet
Slide Cmdbuild Eng
No ratings yet
Slide Cmdbuild Eng
12 pages
Java / J2EE Interview Questions You'll Most Likely Be Asked
From Everand
Java / J2EE Interview Questions You'll Most Likely Be Asked
Vibrant Publishers
No ratings yet
Essays on Infrastructure-as-code
From Everand
Essays on Infrastructure-as-code
Ravi Rajamani
No ratings yet
The Datadog Handbook: A Guide to Monitoring, Metrics, and Tracing
From Everand
The Datadog Handbook: A Guide to Monitoring, Metrics, and Tracing
Robert Johnson
No ratings yet
Google Cloud Run for DevOps: Automating Deployments and Scaling
From Everand
Google Cloud Run for DevOps: Automating Deployments and Scaling
Robert Johnson
No ratings yet
AI-Driven Web Apps: Practical Machine Learning for Software Developers
From Everand
AI-Driven Web Apps: Practical Machine Learning for Software Developers
Sivaramarajalu Ramadurai Venkataraajalu
No ratings yet
CMDBuild WorkflowManual ENG V240
No ratings yet
CMDBuild WorkflowManual ENG V240
70 pages
CMDBuild WorkflowManual ENG V240 PDF
No ratings yet
CMDBuild WorkflowManual ENG V240 PDF
70 pages
Cloud Computing Made Simple: Navigating the Cloud: A Practical Guide to Cloud Computing
From Everand
Cloud Computing Made Simple: Navigating the Cloud: A Practical Guide to Cloud Computing
Poonam Devi
No ratings yet
Mastering Embedded C: The Ultimate Guide to Building Efficient Systems
From Everand
Mastering Embedded C: The Ultimate Guide to Building Efficient Systems
Robert Johnson
No ratings yet
Image Collection Exploration: Unveiling Visual Landscapes in Computer Vision
From Everand
Image Collection Exploration: Unveiling Visual Landscapes in Computer Vision
Fouad Sabry
No ratings yet
Edge Cloud Operations: A Systems Approach
From Everand
Edge Cloud Operations: A Systems Approach
Larry L Peterson
No ratings yet
Transit Quarters
From Everand
Transit Quarters
Shyamala Nemana
4/5 (8)
A Concise Guide to Microservices for Executive (Now for DevOps too!)
From Everand
A Concise Guide to Microservices for Executive (Now for DevOps too!)
alasdair gilchrist
1/5 (1)
Cloud Native Apps on Google Cloud Platform: Use Serverless, Microservices and Containers to Rapidly Build and Deploy Apps on Google Cloud
From Everand
Cloud Native Apps on Google Cloud Platform: Use Serverless, Microservices and Containers to Rapidly Build and Deploy Apps on Google Cloud
alasdair gilchrist
No ratings yet
Embedded Systems Programming with C++: Real-World Techniques
From Everand
Embedded Systems Programming with C++: Real-World Techniques
Robert Johnson
No ratings yet
Computer Integrated Manufature
From Everand
Computer Integrated Manufature
Rahul Basu
No ratings yet
Professional Microsoft SQL Server 2012 Analysis Services with MDX and DAX
From Everand
Professional Microsoft SQL Server 2012 Analysis Services with MDX and DAX
Sivakumar Harinath
No ratings yet
Workfow Manual: November 2017 Author Tecnoteca SRL
No ratings yet
Workfow Manual: November 2017 Author Tecnoteca SRL
73 pages
The Software Programmer: Basis of common protocols and procedures
From Everand
The Software Programmer: Basis of common protocols and procedures
S Mathioudakis
No ratings yet
AWS CDK Essentials: A Beginner's Guide to Infrastructure as Code
From Everand
AWS CDK Essentials: A Beginner's Guide to Infrastructure as Code
Robert Johnson
No ratings yet
Installation and Configuration of IBM Watson Analytics and StoredIQ: Complete Administration Guide of IBM Watson, IBM Cloud, Red Hat OpenShift, Docker, and IBM StoredIQ (English Edition)
From Everand
Installation and Configuration of IBM Watson Analytics and StoredIQ: Complete Administration Guide of IBM Watson, IBM Cloud, Red Hat OpenShift, Docker, and IBM StoredIQ (English Edition)
Alan Bluck
No ratings yet
Consise Cloud Compute: It Professionals’ Handbook
From Everand
Consise Cloud Compute: It Professionals’ Handbook
Vijay
No ratings yet
Cloud Computing Essentials: A Practical Guide with Examples
From Everand
Cloud Computing Essentials: A Practical Guide with Examples
William E. Clark
No ratings yet
Mastering IBM CMOD for RedHat Linux and Windows 11 Servers: Effortlessly Streamline Your Content Management by Deploying IBM CMOD with IBM Content Navigator and Filenet Fixed Content Device for Red Hat Linux and Windows Platforms (English Edition)
From Everand
Mastering IBM CMOD for RedHat Linux and Windows 11 Servers: Effortlessly Streamline Your Content Management by Deploying IBM CMOD with IBM Content Navigator and Filenet Fixed Content Device for Red Hat Linux and Windows Platforms (English Edition)
Alan S. Bluck
No ratings yet
Service Oriented Architecture: An Integration Blueprint
From Everand
Service Oriented Architecture: An Integration Blueprint
Guido Schmutz
No ratings yet
Visual Basic 2010 Coding Briefs Data Access
From Everand
Visual Basic 2010 Coding Briefs Data Access
Kevin Hough
5/5 (1)
Windows Application Development with Visual Studio: from Basics to Advanced
From Everand
Windows Application Development with Visual Studio: from Basics to Advanced
Kiet Huynh
No ratings yet
Software Testing Interview Questions You'll Most Likely Be Asked
From Everand
Software Testing Interview Questions You'll Most Likely Be Asked
Vibrant Publishers
No ratings yet
Cloud Computing For Noobs
From Everand
Cloud Computing For Noobs
Silas Meadowlark
No ratings yet
Geometric Modeling: Exploring Geometric Modeling in Computer Vision
From Everand
Geometric Modeling: Exploring Geometric Modeling in Computer Vision
Fouad Sabry
No ratings yet
Framework for SCADA Cybersecurity
From Everand
Framework for SCADA Cybersecurity
Richard Clark
5/5 (1)
Sage300 DatabaseAndReportChanges
No ratings yet
Sage300 DatabaseAndReportChanges
177 pages
A Developer'S Migration Plan: I D E M P I E R E
No ratings yet
A Developer'S Migration Plan: I D E M P I E R E
23 pages
Perpetual Inventory For: Dolibarr Erp CRM
No ratings yet
Perpetual Inventory For: Dolibarr Erp CRM
4 pages
Sage 300 2018: Upgrade Guide
No ratings yet
Sage 300 2018: Upgrade Guide
27 pages
Sales Process Map
No ratings yet
Sales Process Map
7 pages
A-Download A Language Pack: Instalar Idioma en Suitecrm
No ratings yet
A-Download A Language Pack: Instalar Idioma en Suitecrm
2 pages
A-Download A Language Pack: Instalar Idioma en Suitecrm
No ratings yet
A-Download A Language Pack: Instalar Idioma en Suitecrm
2 pages
Talent Management For Small & Medium-Size Businesses
No ratings yet
Talent Management For Small & Medium-Size Businesses
10 pages
VNX System Operations 300-011-798
No ratings yet
VNX System Operations 300-011-798
146 pages
Tech Developers Hub 2
No ratings yet
Tech Developers Hub 2
6 pages
Abilis CPX Tutorial
No ratings yet
Abilis CPX Tutorial
1,109 pages
Maxatec MT-150 User Manual
No ratings yet
Maxatec MT-150 User Manual
15 pages
BTech 1ITSyllabusFinalYearVer1.1-1
No ratings yet
BTech 1ITSyllabusFinalYearVer1.1-1
76 pages
SAP - Evolution of SAP: SAP at A Glance
No ratings yet
SAP - Evolution of SAP: SAP at A Glance
57 pages
Python Syllabus - 2024 Internships
No ratings yet
Python Syllabus - 2024 Internships
3 pages
SRS Sample Students
No ratings yet
SRS Sample Students
30 pages
Industrial Training Report
No ratings yet
Industrial Training Report
8 pages
QQ-96 English Reference 20070531 PDF
No ratings yet
QQ-96 English Reference 20070531 PDF
55 pages
Professional Cloud Database Engineer Certification - Learn - Google Cloud
No ratings yet
Professional Cloud Database Engineer Certification - Learn - Google Cloud
5 pages
Module 5 - Ten Commandments of Computer Ethics
No ratings yet
Module 5 - Ten Commandments of Computer Ethics
1 page
CSCI 311 Project 1 Ver 05
No ratings yet
CSCI 311 Project 1 Ver 05
5 pages
What Is SAP Data Warehouse Cloud?
No ratings yet
What Is SAP Data Warehouse Cloud?
7 pages
Installing The Sapcrypto Library and Starting The Saprouter
No ratings yet
Installing The Sapcrypto Library and Starting The Saprouter
3 pages
998-19740500 - Gma-Us - A4-Tricon CX
No ratings yet
998-19740500 - Gma-Us - A4-Tricon CX
14 pages
SMS510 Broch 751790 ENc LR
No ratings yet
SMS510 Broch 751790 ENc LR
2 pages
Lab 4 - Threads Creation BY 22BAI1324
No ratings yet
Lab 4 - Threads Creation BY 22BAI1324
8 pages
Updated Practice Questions For MSBTE Class Test - II
No ratings yet
Updated Practice Questions For MSBTE Class Test - II
2 pages
PPS Unit 2 Notes
No ratings yet
PPS Unit 2 Notes
42 pages
Nscib CC 0132539 ST
No ratings yet
Nscib CC 0132539 ST
43 pages
Python Programming For Beginners - 3 Books in 1 - Beginner's Guide, Data Science and Machine Learning
No ratings yet
Python Programming For Beginners - 3 Books in 1 - Beginner's Guide, Data Science and Machine Learning
253 pages
1.5 Angular - Create A Feature Component
No ratings yet
1.5 Angular - Create A Feature Component
7 pages
State Machine Diagram: Eng. Diana Jouhari
No ratings yet
State Machine Diagram: Eng. Diana Jouhari
14 pages
RDBMS MCQS Solved
100% (1)
RDBMS MCQS Solved
144 pages
SOP 009 - Adding Google Analytics To A Site (Using GTM)
No ratings yet
SOP 009 - Adding Google Analytics To A Site (Using GTM)
17 pages
QA4AI Guideline 202201 en
No ratings yet
QA4AI Guideline 202201 en
237 pages
Download full Clean Craftsmanship Disciplines Standards and Ethics 1st Edition Robert C. Martin ebook all chapters
100% (4)
Download full Clean Craftsmanship Disciplines Standards and Ethics 1st Edition Robert C. Martin ebook all chapters
65 pages