X4 Produktdokumentation

Operation: Get Project Parameter Structure

The Get Project Parameter Structure operation expects a UUID as input and returns the XML structure of the project parameters with project parameter groups.

Example

Input

The adapter expects an XML document as input:

XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Id>efb66be5-9ff3-4c1a-9879-9f46854694c0</Id>


Output

The adapter generates an XML document as output:

XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Parameters xmlns:ns2="http://softproject.de/parameter/1.0"
	id="efb66be5-9ff3-4c1a-9879-9f46854694c0" projectName="WebAppProject_2"
	workspace="1">
    <Enums/>
    <Group name="MyGroup">
        <Group name="MySubGroup">
            <VariableParameter name="subgroup" type="String">
                <Description>variable in subgroup</Description>
                <Value>b</Value>
            </VariableParameter>
        </Group>
        <VariableParameter name="test" type="String">
            <Description>variable in group</Description>
            <Value>a</Value>
        </VariableParameter>
    </Group>
    <VariableParameter name="test" type="String">
        <Description>variable on root level</Description>
        <Value>test</Value>
    </VariableParameter>
</Parameters>


The following elements can be included in the output: 


Element

Attribute

Description

Parameters


Parameters of a project with ID, name and workspace of the project


Id

UUID of the project in which a Project Parameter Configuration file .param is contained.


ProjectName

Name of the project in the X4 repository


Workspace

Name of the workspace in which the project is stored.

Enums



Group name


Name of the project parameter group

Variable parameter


Project parameter (variable)

Constant parameter


Projekt parameters (constant)


completeName

Name of the parameter with parameter group


name

Name of the parameter


type

Data type of project parameter

Description


Description of the project parameter

Value


Default value of the project parameter