The following SOAP methods are provided specifically for interacting with article types.
create
Create article type
EvalancheResourceInformation create (string name, int category_id)
Parameters
- string name: Name of the article type
- int category_id: ID of the folder, in which the article type shall be created
Return value
- EvalancheResourceInformation: Object analog to the method getById (Request information about an object via object ID)
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:create>
<name>ARTICLE_PRESET_NAME</name>
<category_id>FOLDER_ID</category_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>ARTICLE_PRESET_URL</url>
<type_id>OBJECT_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>ARTICLE_PRESET_ID</id>
<name>ARTICLE_PRESET_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAttributes
Request article type attributes
EvalancheResourceInformation getAttributes (int resource_id)
Parameters
- int resource_id: ID of the article type
Return value
- EvalancheArticletypeAttributes[]: List of objects with following attributes:
- id: ID of the attribute
- name: Name of the attribute
- label: Label of the attribute
- type_id: ID of the attribute type
- group_id: ID of the attribute's group
- help_text: Help text of the attribute
- input_help_text: Input help text of the attribute
- mandatory: Mandatory option of the attribute
- visible: Visibility of the attribute
- replacement_variable: Replacement variable of the attribute
- allows_options: Possibility to create options
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:getAttributes>
<resource_id>ARTICLE_PRESET_ID</resource_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:getAttributesResponse>
<getAttributesResult>
<item>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_NAME</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>GROUP_ID</group_id>
<help_text>HELP_TEXT</help_text>
<input_help_text/>
<mandatory>MANDATORY</mandatory>
<visible>VISIBLE</visible>
<replacement_variable>REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>ALLOW_OPTIONS</allows_options>
</item>
[...]
</getAttributesResult>
</ns1:getAttributesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttribute
Create article type attributes
EvalancheResourceInformation addAttribute (int resource_id, string name, string label, string type_id, string group_id)
Parameters
- int resource_id: ID of the article type
- string name: Name of the article type
- string label: Label of the article type
- string type_id: ID of the new attribute's article type
- string group_id: ID of the new attribute's group
Return value
- EvalancheArticletypeAttributes[]: List of objects with following attributes:
- id: ID of the new attribute
- name: Name of the new attribute
- label: Label of the new attribute
- type_id: ID of the new attribute's attribute type
- group_id: ID of the new attribute's group
- help_text: Help text of the new attribute
- input_help_text: Input help text of the new attribute
- mandatory: Mandatory option of the new attribute
- visible: Visibility of the new attribute
- replacement_variable: Replacement variable of the new attribute
- allows_options: Possibility to create options
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:addAttribute>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABLE</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>GROUP_ID</group_i d>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:addAttributeResponse>
<addAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_ID</type_id>
<group_id>GROUP_ID</group_id>
<help_text/>
<input_help_text/>
<mandatory>false</mandatory>
<visible>true</visible>
<replacement_variable>REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>ALLOW_OPTIONS</allows_options>
</addAttributeResult>
</ns1:addAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
updateAttribute
Change article type attributes
EvalancheResourceInformation updateAttribute (int resource_id, int attribute_id, EvalancheHashMap data, string name)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the article type
- EvalancheHashMap data: EvalancheHashMap with the article's data
Return values
- EvalancheArticletypeAttributes[]: List of object with following attributes:
- id: ID of the changed attribute
- name: Name of the changed attribute
- label: Label of the changed attribute
- type_id: ID of the changed attribute's attribute type
- group_id: ID of the changed attribute's group
- help_text: Help text of the changed attribute
- input_help_text: Inout help text of the changed attribute
- mandatory: Mandatory option of the changed attribute
- visible: Visibility of the changed attribute
- replacement_variable: Replacement variable of the changed attribute
- allows_options: Possibility to create options
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:updateAttribute>
<resource_id>ARTICLE_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>KEY (e.g. visible)</key>
<value>VALUE (e.g. 0)</value>
</item>
</items>
</data>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:updateAttributeResponse>
<updateAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABLE</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>GROUP_ID</group_id>
<help_text/>
<input_help_text/>
<mandatory>true/false</mandatory>
<visible>true/false</visible>
<replacement_variable>REPLACEMENT_VARIABLE</replacement_variable>
<allows_options>true/false</allows_options>
</updateAttributeResult>
</ns1:updateAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttribute
Remove article type attribute
EvalancheResourceInformation removeAttribute (int resource_id, int attribute_id)
Parameters
- int resource_id: ID of the article type from which the attribute shall be removed
- int attribute_id: ID of the attribute to remove
Return value
- removeAttributeResult: True/False whether the removal was successful
Required privileges
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:removeAttribute>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:removeAttributeResponse>
<removeAttributeResult>true/false</removeAttributeResult>
</ns1:removeAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAttributeGroups
Request attribute group
EvalancheResourceInformation getAttributeGroups (int resource_id)
Parameters
- int resource_id: ID of the article type
Return value
- EvalancheArticletypeGroups[]: List of objects with following attributes:
- id: ID of the attribute group
- name: Name of the attribute group
- sort_order: Position in the sort order of the attribute groups
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:getAttributeGroups>
<resource_id>ARTICLE_PRESET_ID</resource_id>
</art: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/articletype">
<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
Create attribute group
EvalancheResourceInformation addAttributeGroup (int resource_id, string name)
Parameters
- int resource_id: IDof the article type
- name: Name of the attribute group
Return value
- EvalancheArticletypeGroups[]: List of objects with following attributes:
- id: ID of the new attribute group
- name: Name of the attribute group
- sort_order: Position in the sort order of the attribute groups
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:addAttributeGroup>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<name>TestGroup</name>
</art: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/articletype">
<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
Remove attribute group
EvalancheResourceInformation removeAttributeGroup (int resource_id, int attribute_group_id)
Parameters
- int resource_id: ID of the article type
- attribute_group_id: ID of the attribute group
Return value
- removeAttributeResult: True/False if the removal was successful
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:removeAttributeGroup>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_group_id>GROUP_ID</attribute_group_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:removeAttributeGroupResponse>
<removeAttributeGroupResult>true/false</removeAttributeGroupResult>
</ns1:removeAttributeGroupResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAttributeOptions
Request attribute options
EvalancheResourceInformation getAttributeOptions (int resource_id, int attribute_id)
Parameters
- int resource_id: ID of the article type, from which the attribute options are requested
- int attribute_id: ID of the attribute, from which the options are requested
Return value
- EvalancheArticletypeAttributeOptions[]: List of object with following attributes:
- id: ID of the attribute option
- name: Name of the attribute option
- label: Label of the attribute option
- order: Position in the order
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:getAttributeOptions>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:getAttributeOptionsResponse>
<getAttributeOptionsResult>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<name>ATTRIBUTE_OPTION_NAME</name>
<label>LABEL</label>
<order>ORDER</order>
</item>
[...]
</getAttributeOptionsResult>
</ns1:getAttributeOptionsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createAttributeOption
Create attribute option
EvalancheResourceInformation createAttributeOption (int resource_id, int attribute_id, string label)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the article type
- string label: Label of the article type
Return value
- id: ID of the new attribute option
- name: Name of the new attribute option
- label: Label of the new attribute option
- order: Position of the new attribute option
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:createAttributeOption>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<label>LABEL</label>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:createAttributeOptionResponse>
<createAttributeOptionResult>
<id>ATTRIBUTE_OPTION_ID</id>
<name>ATTRIBUTE_OPTION_NAME</name>
<label>LABEL</label>
<order>ORDER</order>
</createAttributeOptionResult>
</ns1:createAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttributeOption
Remove attribut eoption
EvalancheResourceInformation removeAttributeOption (int resource_id, int attribute_id, int option_id)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the attribute from which an option shall be removed
- int option_id: ID of the option to be removed
Return value
- removeAttributeResult: True/False if the removal was successful
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:removeAttributeOption>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:removeAttributeOptionResponse>
<removeAttributeOptionResult>true/false</removeAttributeOptionResult>
</ns1:removeAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getTypeIds
Request attribute types
EvalancheResourceInformation getTypeIds ()
Parameters
Return value
- EvalancheArticletypeTypes[]: List of objects with following attributes:
- id: ID of the object type
- description: Description of the object type
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art: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/articletype">
<SOAP-ENV:Body>
<ns1:getTypeIdsResponse>
<getTypeIdsResult>
<item>
<id>20</id>
<description>articletype</description>
</item>
</getTypeIdsResult>
</ns1:getTypeIdsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
changeAttributeType
Change attribute type
EvalancheResourceInformation changeAttributeType (int resource_id, int attribute_id, int type_id)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the attribute
- int type_id: ID of the attribute type
Rückgabewert
- changeTypeResult: True/False if the change was successful
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:changeAttributeType>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</art: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/articletype">
<SOAP-ENV:Body>
<ns1:changeAttributeTypeResponse>
<changeAttributeTypeResult>true/false</changeAttributeTypeResult>
</ns1:changeAttributeTypeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getApplicableRoleTypes
Request applicable article type attribute roles
EvalancheResourceInformation getApplicableRoleTypes (int resource_id, int attribute_id)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the article type attribute
Return value
- EvalancheApplicableRoleTypes[]: List of objects with following attributes:
- id: ID of the role
- name: Name of the role
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:getApplicableRoleTypes>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</art:getApplicableRoleTypes>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/articletype">
<SOAP-ENV:Body>
<ns1:getApplicableRoleTypesResponse>
<getApplicableRoleTypesResult>
<item>
<id>ROLE_ID</id>
<name>ROLE_NAME</name>
</item>
[...]
</getApplicableRoleTypesResult>
</ns1:getApplicableRoleTypesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAssignedRoleTypes
Request assigned article type attribute roles
EvalancheResourceInformation getAssignedRoleTypes (int resource_id, int attribute_id)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the article type attribute
Rückgabewert
- EvalancheAssignedRoleTypes[]: List of objects with following attributes:
- id: ID of the role
- name: Name of the role
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:getAssignedRoleTypes>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</art:getAssignedRoleTypes>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/articletype">
<SOAP-ENV:Body>
<ns1:getAssignedRoleTypesResponse>
<getAssignedRoleTypesResult>
<item>
<id>ROLE_ID</id>
<name>ROLE_NAME</name>
</item>
</getAssignedRoleTypesResult>
</ns1:getAssignedRoleTypesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
assignRoleToAttribute
Assign a role to an article type attribute
EvalancheResourceInformation assignRoleToAttribute (int resource_id, int attribute_id, int role_type_id)
Parameters
- int resource_id: ID of the article type
- int attribute_id: ID of the article type attribute
- int role_type_id: ID of the role type
Return value
- changeTypeResult: True/False if the change was successful
Required rights
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/articletype">
<soapenv:Header/>
<soapenv:Body>
<art:assignRoleToAttribute>
<resource_id>ARTICLE_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<role_type_id>ROLE_TYPE_ID</role_type_id>
</art:assignRoleToAttribute>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/articletype">
<SOAP-ENV:Body>
<ns1:assignRoleToAttributeResponse>
<assignRoleToAttributeResult>true/false</assignRoleToAttributeResult>
</ns1:assignRoleToAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>