Folgende SOAP-Methoden werden speziell für die Interaktion mit Container-Typen bereitgestellt.
create
Container-Typ erstellen
EvalancheResourceInformation create (string name, int category_id)
Details
Parameter
- string name: Name des Container-Typs
- int category_id: ID des Ordners, in welchem der Container-Typ erstellt werden soll
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)
Benötigte Rechte
Container-Typ erzeugen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:create>
<name>CONTAINER_PRESET_NAME</name>
<category_id>FOLDER_ID</category_id>
</con:create>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_PRESET_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CONTAINER_PRESET_ID</id>
<name>CONTAINER_PRESET_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAttributes
Container-Typ-Attribute abfragen
EvalancheResourceInformation getAttributes (int resource_id)
Details
Parameter
- int resource_id: ID des Container-Typs
Rückgabewert
- EvalancheContainertypeAttributes[]: Liste von Objekten mit folgenden Attributen:
- id: ID des Attributs
- name: Name des Attributs
- label: Label des Attributs
- type_id: ID des Attribut-Typs
- group_id: ID der Gruppe des Attributs
- help_text: Hilfetext des Attributs
- input_help_text: Eingabehilfetext des Attributs
- mandatory: Pflichtfeld-Option des Attributs
- visible: Anzeige-Option des Attributs
- replacement_variable: Ersetzungsvariable des Attributs
- allows_options: Options-Anlage Möglichkeit
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:getAttributes>
<resource_id>CONTAINER_PRESET_ID</resource_id>
</con:getAttributes>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:getAttributesResponse>
<getAttributesResult>
<item>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>GROUP_ID</group_id>
<help_text/>
<input_help_text/>
<mandatory>MANDATORY</mandatory>
<visible>VISIBLE</visible>
<replacement_variable>ATTRIBUTE_REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>ALLOW_OPTIONS</allows_options>
</item>
[...]
</getAttributesResult>
</ns1:getAttributesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttribute
Container-Typ-Attribute anlegen
EvalancheResourceInformation addAttribute (int resource_id, string name)
Details
Parameter
- int resource_id: ID des Container-Typs
- string name: Name des neuen Attributs
- string label: Label des neuen Attributs
- string type_id: ID des Attribut-Typs des neuen Attributs
- string group_id: ID der Gruppe des neuen Attributs
Rückgabewert
- EvalancheContainertypeAttributes[]: Liste von Objekten mit folgenden Attributen:
- id: ID des neuen Attributs
- name: Name des neuen Attributs
- label: Label des neuen Attributs
- type_id: ID des Attribut-Typs des neuen Attributs
- group_id: ID der Gruppe des neuen Attributs
- help_text: Hilfetext des neuen Attributs
- input_help_text: Eingabehilfetext des neuen Attributs
- mandatory: Pflichtfeld-Option des neuen Attributs
- visible: Anzeige-Option des neuen Attributs
- replacement_variable: Ersetzungsvariable des neuen Attributs
- allows_options: Options-Anlage Möglichkeit
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:addAttribute>
<resource_id>CONTAINER_TYPE_ID</resource_id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
</con:addAttribute>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:addAttributeResponse>
<addAttributeResult>
<id>ATTRIBTUE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
<help_text/>
<input_help_text/>
<mandatory>MANDATORY</mandatory>
<visible>VISIBLE</visible>
<replacement_variable>ATTRIBUTE_REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>false</allows_options>
</addAttributeResult>
</ns1:addAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
updateAttribute
Container-Typ-Attribute ändern
EvalancheResourceInformation updateAttribute (int resource_id, int attribute_id, EvalancheHashMap data, string name)
Details
Parameter
- int resource_id: ID des Container-Typs
- int attribute_id: ID des zu ändernden Attributs
- EvalancheHashMap data: EvalancheHashMap mit den Daten des Containers
Rückgabewert
- EvalancheContainertypeAttributes[]: Liste von Objekten mit folgenden Attributen:
- id: ID des geänderten Attributs
- name: Name des geänderten Attributs
- label: Label des geänderten Attributs
- type_id: ID des Attribut-Typs des geänderten Attributs
- group_id: ID der Gruppe des geänderten Attributs
- help_text: Hilfetext des geänderten Attributs
- input_help_text: Eingabehilfetext des geänderten Attributs
- mandatory: Pflichtfeld-Option des geänderten Attributs
- visible: Anzeige-Option des geänderten Attributs
- replacement_variable: Ersetzungsvariable des geänderten Attributs
- allows_options: Options-Anlage Möglichkeit
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:updateAttribute>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
</items>
</data>
</con:updateAttribute>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:updateAttributeResponse>
<updateAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
<help_text/>
<input_help_text/>
<mandatory>MANDATORY</mandatory>
<visible>VISIBLE</visible>
<replacement_variable>REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>ALLOW_OPTIONS</allows_options>
</updateAttributeResult>
</ns1:updateAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttribute
Container-Typ-Attribut entfernen
EvalancheResourceInformation removeAttribute (int resource_id, int attribute_id)
Details
Parameter
- int resource_id: ID des Container-Typs aus dem das Attribute entfernt werden soll
- int attribute_id: ID des Attributes, welches entfernt werden soll
Rückgabewert
- removeAttributeResult: True/False ob das Entfernen erfolgreich war
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:removeAttribute>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</con:removeAttribute>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:removeAttributeResponse>
<removeAttributeResult>true/false</removeAttributeResult>
</ns1:removeAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAttributeGroups
Attribut-Gruppe abfragen
EvalancheResourceInformation getAttributeGroups (int resource_id)
Details
Parameter
- int resource_id: ID des Container-Typs
Rückgabewert
- EvalancheContainertypeGroups[]: Liste von Objekten mit folgenden Attributen:
- id: ID der Attribut-Gruppe
- name: Name der Attribut-Gruppe
- sort_order: Position in der Reihenfolge der Attribut-Gruppen
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:getAttributeGroups>
<resource_id>CONTAINER_PRESET_ID</resource_id>
</con:getAttributeGroups>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:getAttributeGroupsResponse>
<getAttributeGroupsResult>
<item>
<id>GROUP_ID</id>
<name>GROUP_NAME</name>
<sort_order>SORT_ORDER</sort_order>
</item>
</getAttributeGroupsResult>
</ns1:getAttributeGroupsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttributeGroup
Attribut-Gruppe anlegen
EvalancheResourceInformation addAttributeGroup (int resource_id, string name)
Details
Parameter
- int resource_id: ID des Container-Typs
- string name: Name der Attribut-Gruppe
Rückgabewert
- EvalancheContainertypeGroups[]: Liste von Objekten mit folgenden Attributen:
- id: ID der neuen Attribut-Gruppe
- name: Name der Attribut-Gruppe
- sort_order: Position in der Reihenfolge der Attribut-Gruppen
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:addAttributeGroup>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<name>GROUP_NAME</name>
</con:addAttributeGroup>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:addAttributeGroupResponse>
<addAttributeGroupResult>
<id>GROUP_ID</id>
<name>GROUP_NAME</name>
<sort_order>SORT_ORDER</sort_order>
</addAttributeGroupResult>
</ns1:addAttributeGroupResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttributeGroup
Attribut-Gruppe entfernen
EvalancheResourceInformation removeAttributeGroup (int resource_id, int attribute_group_id)
Details
Parameter
- int resource_id: ID des Container-Typs
- int attribute_group_id: ID der Attribut-Gruppe
Rückgabewert
- removeAttributeResult: True/False ob das Entfernen erfolgreich war
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:removeAttributeGroup>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_group_id>ATTRIBUTE_GROUP_ID</attribute_group_id>
</con:removeAttributeGroup>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:removeAttributeGroupResponse>
<removeAttributeGroupResult>true/false</removeAttributeGroupResult>
</ns1:removeAttributeGroupResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
getAttributeOptions
Attribute-Optionen abfragen
EvalancheResourceInformation getAttributeOptions (int resource_id, int attribute_id)
Details
Parameter
- int resource_id: ID des Container-Typs, aus dem die Attribut-Optionen geholt werden sollen
- int attribute_id: ID des Attributes, aus welchem die Attribut-Optionen geholt werden sollen
Rückgabewert
- EvalancheContainertypeAttributeOptions[]: Liste von Objekten mit folgenden Attributen:
- id: ID der Attribut-Option
- name: Name der Attribut-Option
- label: Label der Attribut-Option
- order: Position in der Reihenfolge
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:getAttributeOptions>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</con:getAttributeOptions>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:getAttributeOptionsResponse>
<getAttributeOptionsResult>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<name>ATTRIBUTE_OPTION_NAME</name>
<label>ATTRIBUTE_OPTION_LABEL</label>
<order>SORT_ORDER</order>
</item>
[...]
</getAttributeOptionsResult>
</ns1:getAttributeOptionsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createAttributeOption
Attribute-Option erstellen
EvalancheResourceInformation createAttributeOption (int resource_id, int attribute_id, string label)
Details
Parameter
- int resource_id: ID des Container-Typs
- int attribute_id: ID des Attributes
- string label: Label des Attributes
Rückgabewert
- id: ID der neuen Attribute-Option
- name: Name der neuen Attribute-Option
- label: Label der neuen Attribute-Option
- order: Position der neuen Attribute-Option
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:createAttributeOption>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<label>ATTRIBUTE_OPTION_LABEL</label>
</con:createAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:createAttributeOptionResponse>
<createAttributeOptionResult>
<id>ATTRIBUTE_OPTION_ID</id>
<name>ATTRIBUTE_OPTION_NAME</name>
<label>ATTRIBUTE_OPTION_LABEL</label>
<order>SORT_ORDER</order>
</createAttributeOptionResult>
</ns1:createAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttributeOption
Attribute-Optionen entfernen
EvalancheResourceInformation removeAttributeOption (int resource_id, int attribute_id, int option_id)
Details
Parameter
- int resource_id: ID des Container-Typs
- int attribute_id: ID des zu entfernenden Attributes
- int option_id: ID der zu entfernenden Option
Rückgabewert
- removeAttributeResult: True/False ob das Entfernen erfolgreich war
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:removeAttributeOption>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</con:removeAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:removeAttributeOptionResponse>
<removeAttributeOptionResult>true/false</removeAttributeOptionResult>
</ns1:removeAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getTypeIds
Attribute-Typen abfragen
EvalancheResourceInformation getTypeIds ()
Details
Parameter
Rückgabewert
- EvalancheContainertypeAttributeTypes[]: Liste von Objekten mit folgenden Attributen:
- id: ID des Attribut-Types
- description: Beschreibung des Attribut-Types
Benötigte Rechte
Container-Typ anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:getTypeIds/>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:getTypeIdsResponse>
<getTypeIdsResult>
<item>
<id>CONTAINER_PRESET_TYPE_ID</id>
<description>CONTAINER_PRESET_TYPE_DESCRIPTION</description>
</item>
</getTypeIdsResult>
</ns1:getTypeIdsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
changeAttributeType
Attribute-Typen verändern
EvalancheResourceInformation changeAttributeType (int resource_id, int attribute_id, int type_id)
Details
Parameter
- int resource_id: ID des Container-Typs
- int attribute_id: ID des Attributes
- int type_id: ID ???
Rückgabewert
- changeTypeResult: True/False ob das Ändern erfolgreich war
Benötigte Rechte
Container-Typ verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype">
<soapenv:Header/>
<soapenv:Body>
<con:changeAttributeType>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</con:changeAttributeType>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype">
<SOAP-ENV:Body>
<ns1:changeAttributeTypeResponse>
<changeAttributeTypeResult>true/false</changeAttributeTypeResult>
</ns1:changeAttributeTypeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>