Get user model data by name

This resource provides the diagram data specified by its name.

Only the following diagram types are supported:

Process Maps
Business Process Diagrams
Business Object Diagrams
Organization Diagrams
System Diagram
Technical Workflows

Request

URL: /model/modelByName/{modelName}

Method: GET

Authorization: required

GET /ibis/rest/model/modelByName/TestBPD HTTP/1.1
Accept: application/xml
Host: localhost:8080

Request Path Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`modelName`	Name of the diagram	yes	Any string

modelName

Name of the diagram

yes

Any string

Request Query Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`views`	Output information about elements view position (x and y coordinates)	no (default: false)	`true` or `false`
`deep`	Verbose model data output	no (default: false)	`true` or `false`
`version`	Specify the version number to retrieve the information from	no (default: HEAD version)	Any positive integer
`tag`	Specify the tag name to retrieve the information from	no	Any string

views

Output information about elements view position (x and y coordinates)

no (default: false)

true or false

deep

Verbose model data output

no (default: false)

true or false

version

Specify the version number to retrieve the information from

no (default: HEAD version)

Any positive integer

tag

Specify the tag name to retrieve the information from

Any string

Response

HTTP/1.1 200 OK
Content-Tye: application/xml;charset=UTF-8

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:Model name="TestBPD" type="bpd" ns2:version="head" group="Visions_Demo" xmlns:ns2="inubit.com/ibis/external/base" xmlns:ns4="inubit.com/ibis/external/model" xmlns:ns3="inubit.com/ibis/external/organigram">
    <ns4:Node type="bpdTask" id="298"/>
    <ns4:Node type="bpdGateway" id="299"/>
    <ns4:Node type="bpdTask" id="301"/>
    <ns4:Node type="bpdTextAnnotation" id="303"/>
    <ns4:Node type="bpdStopEvent" id="305"/>
    <ns4:Node type="bpdSubProcess" id="317"/>
</ns4:Model>

Errors

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>401</statusCode>
    <message>Unauthorized access</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-06-07T14:21:11.781</timestamp>
</ApiError>

Resource Not Found (404): The 404 (Not Found) status code indicates that the requested endpoint or resource is unavailable or does not exist on the server.
Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>500</statusCode>
    <message>Internal Server Error</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-08-06T12:55:31.862</timestamp>
</ApiError>

Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>503</statusCode>
    <message>Service Unavailable</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-08-06T12:58:06.688</timestamp>
</ApiError>