Get model data by element ID

Use this resource to retrieve the data of a single diagram element specified by its ID.

Only the following diagram types are supported:

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

Request

To retrieve the element data, send a GET request to the endpoint defined below.

URL: /model/nodeByModel/{modelName}/{nodeId}

Method: GET

Authorization: required

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

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`modelName`	Enter the name of the diagram. Encode whitespaces as `%20`.	yes	Any string
`nodeId`	Enter the ID of the diagram element.	yes	Any positive integer
`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

modelName

Enter the name of the diagram. Encode whitespaces as %20.

yes

Any string

nodeId

Enter the ID of the diagram element.

yes

Any positive integer

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

The response contains the data of the requested diagram element.

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:Node type="bpdTask" id="298" xmlns:ns2="inubit.com/ibis/external/base" xmlns:ns4="inubit.com/ibis/external/model" xmlns:ns3="inubit.com/ibis/external/organigram">
    <ns4:Connection targetId="299" type="SequenceFlow" id="300">
        <ns2:Properties>
            <ns2:Property name="ModuleSpecific" type="Map">
                <ns2:Property name="ConditionType" type="String">None</ns2:Property>
            </ns2:Property>
        </ns2:Properties>
    </ns4:Connection>
    <ns2:Properties>
        <ns2:Property name="ModuleSpecific" type="Map">
            <ns2:Property name="StartQuantity" type="Integer">1</ns2:Property>
            <ns2:Property name="CompletionQuantity" type="Integer">1</ns2:Property>
            <ns2:Property name="LoopType" type="String">None</ns2:Property>
            <ns2:Property name="TaskType" type="String">Receive</ns2:Property>
            <ns2:Property name="GlobalTask" type="Boolean">false</ns2:Property>
            <ns2:Property name="Instantiate" type="Boolean">false</ns2:Property>
        </ns2:Property>
    </ns2:Properties>
</ns4:Node>

Errors

This request might return one of the following error codes:

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

{
    "statusCode": 401,
    "message": "Unauthorized access",
    "path": "/rest/<endpoint>",
    "timestamp": "2025-06-07T14:21:11.781"
}

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.

{
  "statusCode": 500,
  "message": "Internal Server Error",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:55:31.862"
}

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.

{
  "statusCode": 503,
  "message": "Service Unavailable",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:58:06.688"
}