Get user model data with a specific name

This resource provides the diagram data by specifying the diagram name.

Only the following diagram types are supported:

Process Maps
Business Process Diagrams
Business Object Diagrams
Organization Diagrams
SOA Maps
System Diagram

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 Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`modelName`	Name of the diagram	yes	Any string
`user`	Specifies the user or user group (this is relevant when getting the information via the technical user)	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 integer
`tag`	Specify the tag name to retrieve the information from	no	Any string

modelName

Name of the diagram

yes

Any string

user

Specifies the user or user group (this is relevant when getting the information via the technical user)

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 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.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

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.