Get diagram metadata

Use this resource to retrieve metadata information for a specific diagram.

Request

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

URL: /process/metadata/{diagramName}

Method: GET

Authorization: required

GET /ibis/rest/process/metadata/TargetTWF_CL
Accept: application/xml, application/json
Host: localhost:8000

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`diagramName`	The name of the diagram. Encode whitespaces as `%20`.	yes	Any valid diagram name

diagramName

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

yes

Any valid diagram name

Response

Depending on the Accept header, the response contains the metadata in XML format or a JSON object containing the metadata.

HTTP/1.1 200 OK
Content-Type: application/xml

<IBISWorkflow version="5.3">
    <Workflows>
        <WorkflowGroup workflowType="technical">
            <WorkflowGroupName>ProcessDocumentation</WorkflowGroupName>
            <Workflow version="head" workflowType="technical">
                <WorkflowName>TargetTWF_CL</WorkflowName>
                <UserOrUserGroupName>TestGroup</UserOrUserGroupName>
                <WorkflowUId>7ff886c6:19d2a5334ea:-7ffb</WorkflowUId>
                <IsActive>false</IsActive>
                <PortalProcessRoles>
                    <RoleName>admin</RoleName>
                    <RoleName> bpcadmin</RoleName>
                </PortalProcessRoles>
                <XPathVersion>3.1</XPathVersion>
                <Variables xmlns:xs="http://www.w3.org/2001/XMLSchema" requireVariableFiltering="true"></Variables>
                <WorkflowModule moduleType="endLoop">
                    <ModuleId>11</ModuleId>
                    <Connection moduleOutId="12">
                        <ConnectionId>14</ConnectionId>
                        <StyleSheet labelPosition="50.0"/>
                    </Connection>
                </WorkflowModule>
                <WorkflowModule moduleType="WhileLoop">
                    <ModuleId>12</ModuleId>
                    <ModuleName>While</ModuleName>
                    <EndLoopId>13</EndLoopId>
                    <StyleSheet xPos="640" yPos="535"/>
                </WorkflowModule>
                <WorkflowModule moduleType="endLoop">
                    <ModuleId>13</ModuleId>
                </WorkflowModule>
                <WorkflowModule moduleType="If">
                    <ModuleId>10</ModuleId>
                    <ModuleName>If</ModuleName>
                    <EndLoopId>11</EndLoopId>
                    <StyleSheet xPos="550" yPos="325"/>
                </WorkflowModule>
            </Workflow>
        </WorkflowGroup>
    </Workflows>
</IBISWorkflow>

HTTP/1.1 200 OK
Content-Type: application/json

{
  "format": "xml",
  "data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<IBISWorkflow version=\"5.3\">\n    <Workflows>\n        <WorkflowGroup workflowType=\"technical\">\n            <WorkflowGroupName>ProcessDocumentation</WorkflowGroupName>\n            <Workflow version=\"head\" workflowType=\"technical\">\n                <WorkflowName>TargetTWF_CL</WorkflowName>\n                <UserOrUserGroupName>TestGroup</UserOrUserGroupName>\n                <WorkflowUId>7ff886c6:19d2a5334ea:-7ffb</WorkflowUId>\n                <IsActive>false</IsActive>\n                <PortalProcessRoles>\n                    <RoleName>admin</RoleName>\n                    <RoleName> bpcadmin</RoleName>\n                </PortalProcessRoles>\n                <XPathVersion>3.1</XPathVersion>\n                <Variables xmlns:xs=\"http://www.w3.org/2001/XMLSchema\" requireVariableFiltering=\"true\"></Variables>\n                <WorkflowModule moduleType=\"endLoop\">\n                    <ModuleId>11</ModuleId>\n                    <Connection moduleOutId=\"12\">\n                        <ConnectionId>14</ConnectionId>\n                        <StyleSheet labelPosition=\"50.0\"/>\n                    </Connection>\n                </WorkflowModule>\n                <WorkflowModule moduleType=\"WhileLoop\">\n                    <ModuleId>12</ModuleId>\n                    <ModuleName>While</ModuleName>\n                    <EndLoopId>13</EndLoopId>\n                    <StyleSheet xPos=\"640\" yPos=\"535\"/>\n                </WorkflowModule>\n                <WorkflowModule moduleType=\"endLoop\">\n                    <ModuleId>13</ModuleId>\n                </WorkflowModule>\n                <WorkflowModule moduleType=\"If\">\n                    <ModuleId>10</ModuleId>\n                    <ModuleName>If</ModuleName>\n                    <EndLoopId>11</EndLoopId>\n                    <StyleSheet xPos=\"550\" yPos=\"325\"/>\n                </WorkflowModule>\n            </Workflow>\n        </WorkflowGroup>\n    </Workflows>\n</IBISWorkflow>"
}

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"
}