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 HTTP/1.1
Accept: application/xml
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

The response contains the metadata in XML format.

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

<IBISWorkflow version="5.3">
    <Workflows>
        <WorkflowGroup workflowType="technical">
            <WorkflowGroupName>ProcessDocumentation</WorkflowGroupName>
            <WorkflowGroupNames version="4.1">
                <Property name="de">ProcessDocumentation_DE</Property>
            </WorkflowGroupNames>
            <Workflow version="head" workflowType="technical">
                <WorkflowName>TargetTWF_CL</WorkflowName>
                <UserOrUserGroupName>TestGroup</UserOrUserGroupName>
                <WorkflowUId>-d14a12f:1768918f1a8:-7f64</WorkflowUId>
                <WorkflowNames version="4.1">
                    <Property name="de">TargetTWF_CL_DE</Property>
                </WorkflowNames>
                <CheckinComment>DefaultCommitCommentImport###DefaultRenameWorkflowCheckinComment@@@TargetTWF_CL/TargetTWF_CL@@@###@@@Deploying User: root@@@Server</CheckinComment>
                <IsActive>true</IsActive>
                <PortalProcessRoles>
                    <RoleName>admin</RoleName>
                </PortalProcessRoles>
                <XPathVersion>3.1</XPathVersion>
                <WorkflowModule moduleType="technical" version="head" technicalModuleType="Empty">
                    <ModuleId>110</ModuleId>
                    <ModuleName>TargetEmpty</ModuleName>
                    <OriginalModuleName>TargetEmpty</OriginalModuleName>
                    <StyleSheet xPos="520" yPos="580"/>
                </WorkflowModule>
                <WorkflowModule moduleType="Image" version="head">
                    <ModuleId>1</ModuleId>
                </WorkflowModule>
                <WorkflowModule moduleType="technical" version="head" technicalModuleType="Assign">
                    <ModuleId>107</ModuleId>
                    <ModuleName>TargetAssign</ModuleName>
                    <OriginalModuleName>TargetAssign</OriginalModuleName>
                    <StyleSheet xPos="180" yPos="280"/>
                </WorkflowModule>
                <WorkflowModule moduleType="technical" version="head" technicalModuleType="Workflow Starter">
                    <ModuleId>109</ModuleId>
                    <ModuleName>TargetWFStarter</ModuleName>
                    <OriginalModuleName>TargetWFStarter</OriginalModuleName>
                    <StyleSheet xPos="240" yPos="580"/>
                    <Connection moduleOutId="110">
                        <ConnectionId>113</ConnectionId>
                    </Connection>
                </WorkflowModule>
                <Variables xmlns:xs="http://www.w3.org/2001/XMLSchema" requireVariableFiltering="true"></Variables>
                <ConnectionLineLink isBacklink="true">
                    <WorkflowName>BPD_CL1</WorkflowName>
                    <WorkflowGroup en="ProcessDocumentation">ProcessDocumentation</WorkflowGroup>
                    <WorkflowLinkId>1</WorkflowLinkId>
                    <WorkflowType>bpd</WorkflowType>
                    <TargetModuleId>49</TargetModuleId>
                    <WorkflowUserGroups>TestGroup</WorkflowUserGroups>
                    <ToModule id="110">
                        <StyleSheet xPos="520.0" yPos="580.0"/>
                    </ToModule>
                    <FromModule id="109">
                        <StyleSheet xPos="240.0" yPos="580.0"/>
                    </FromModule>
                </ConnectionLineLink>
            </Workflow>
        </WorkflowGroup>
    </Workflows>
</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.

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