im_ModifyBinaryProperties_Ad [dstore]

Inhaltsverzeichnis

im_ModifyBinaryProperties_Ad

im_ModifyBinaryProperties_Ad

Ändert, setzt bzw. löscht die Eigenschaft eines Binärobjekts zu einem Merkmal.

Anmerkungen :
1. Änderungen von Eigenschaften zu einem Binärobjekt sind nur erlaubt, falls für das Merkmal „Modify“ (siehe Rückgabe von im_GetBinaryCharacteristics_Ad) der Wert „1“ hinterlegt ist.
2. Besitzt das Merkmal nur vordefinierte Werte („PredefinedValues = 1“, siehe Rückgabe von im_GetBinaryCharacteristics_Ad), darf „NewValue“ sowohl ein Wert als auch eine ID sein.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[im, Modify, Binary, Properties, Ad]
Engine-Kategorie	item management
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
BinaryCodeID		ID des Binärobjekts, zu dem die Eigenschaft „NewValue“ (zum Merkmal „BinaryCharacteristicID“) geändert bzw. gesetzt werden soll bzw. zu dem eine vorhandene Eigenschaft gelöscht werden soll	integer	3.5.0
BinaryCharacteristicID		ID des Merkmals, zu dem die Eigenschaft „NewValue“ gehört bzw. zu dem eine evtl. vorhandene Eigenschaft gelöscht werden soll	smallint	3.5.0
NewValue		Eigenschaft (zum Merkmal „BinaryCharacteristicID“), das dem Binärobjekt „BinaryCodeID“ zugewiesen werden soll	varchar(100)	3.5.0
Delete	0	„0“ : Dem Binärobjekt „BinaryCodeID“ soll die Eigenschaft „NewValue“ zugewiesen werden „1“ : Eine evtl. vorhandene Eigenschaft des Binärobjektes „BinaryCodeID“ zum Merkmal „BinaryCharacteristicID“ soll gelöscht werden	bit	3.5.18

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-569	Der Benutzer hat kein Ausführungsrecht für die Prozedur	nur indirekt
-567	Die Prozedur darf z. Zt. nicht ausgeführt werden	nur indirekt
-566	Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden	nur indirekt
-535	Das Datum liegt nicht in der Vergangenheit	nur indirekt
-530	Der Wert ist nicht konvertierbar	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-504	Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.13	2004-05-18	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.19	2002-06-17
3.5.18	2002-05-15
3.5.13	2001-12-06
3.5.0	2000-11-23	Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

im_ModifyBinaryProperties_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/im_ModifyBinaryProperties_Ad?BinaryCodeID=<value>&BinaryCharacteristicID=<value>&NewValue=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/im_ModifyBinaryProperties_Ad?BinaryCodeID=<value>&BinaryCharacteristicID=<value>&NewValue=<value>' | xmllint --format -

dStore_php

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'im_ModifyBinaryProperties_Ad',
		array(
			'BinaryCodeID' => <value>,
			'BinaryCharacteristicID' => <value>,
			'NewValue' => '<value>',
			// 'Delete' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="im_ModifyBinaryProperties_Ad">
			<Parameters>
				<Parameter Name="BinaryCodeID"><!-- integer value --></Parameter>
				<Parameter Name="BinaryCharacteristicID"><!-- smallint value --></Parameter>
				<Parameter Name="NewValue"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Delete">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾

siehe Datentypen im Bereich "engine"

⁴⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁵⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis