SAP Query

This API allows to retrieve the data returned by a specific query in SAP. #### Request URI

Copy

Request and the response support both json and xml formats, you can set the desired format by changing the value of the respective headers: * to set the request format you can set the "Content-Type" header with value "application/json" or "application/xml". * to set the response format you can set the "Accept" header with value "application/json" or "application/xml". #### Request Structure

Field	Type	Description	Mandatory
user Group	String	userGroup	Y
query	String	query name	Y
variant	String	variant	N
selectionTable
item (0..∞)
selName	String	selection Name	N
kind	String	kind	N
sign	String	sign	N
option	String	option	N
low	String	low	N
high	String	high	N

#### Request Example (json) { "userGroup": "ZESB", "query": "ZMMD_COMM_CODE", "variant": "", "selectionTable": { "item": [{ "selName": "SP$00001", "kind": "S", "sign": "I", "option": "EQ", "low": "000000000000715830", "high": "" } ] } } Copy

 

#### Request Example (xml) <?xml version="1.0" encoding="UTF-8"?> <sapQueryRequest xmlns="http://campari.com/xmlns/sapquery/v1"> <userGroup>ZESB</userGroup> <query>ZMMD_COMM_CODE</query> <variant></variant> <selectionTable> <item> <selName>SP$00001</selName> <kind>S</kind> <sign>I</sign> <option>EQ</option> <low>000000000000715830</low> <high></high> </item> </selectionTable> </sapQueryRequest> Copy

 

#### Response Structure

Field	Type	Description
query
header
columnNames
value (0..∞)	String	columnNames values
columnDescriptions
value (0..∞)	String	columnDescriptions values
columnTypes
value (0..∞)	String	columnTypes values
values
row (0..∞)
value (0..∞)	String	row values

#### Response Example (json) { "query": { "header": { "columnNames": { "value": [ "/SAPSLL/MARITC-MATNR", "/SAPSLL/MARITC-STCTS", "/SAPSLL/MARITC-DATAB", "/SAPSLL/MARITC-DATBI", "/SAPSLL/MARITC-CCNGN" ] }, "columnDescriptions": { "value": [ "Material Number", "Trade Classification Numbering Scheme", "Valid From", "Valid To", "Number" ] }, "columnTypes": { "value": [ "Character", "Character", "Date", "Date", "Character" ] } }, "values": { "row": [ { "value": [ "test", "test", "01.01.2022", "01.01.2023", "test" ] } ] } } } Copy

 

#### Response Example (xml) <tns1:sapQueryResponse xmlns:tns1="http://campari.com/xmlns/sapquery/v1"> <tns1:query> <tns5:header xmlns:tns5="http://campari.com/xmlns/sapquery/v1" xmlns="http://campari.com/xmlns/sapquery/v1"> <columnNames> <value>/SAPSLL/MARITC-MATNR</value> <value>/SAPSLL/MARITC-STCTS</value> <value>/SAPSLL/MARITC-DATAB</value> <value>/SAPSLL/MARITC-DATBI</value> <value>/SAPSLL/MARITC-CCNGN</value> </columnNames> <columnDescriptions> <value>Material Number</value> <value>Trade Classification Numbering Scheme</value> <value>Valid From</value> <value>Valid To</value> <value>Number</value> </columnDescriptions> <columnTypes> <value>Character</value> <value>Character</value> <value>Date</value> <value>Date</value> <value>Character</value> </columnTypes> </tns5:header> <tns5:values xmlns:tns5="http://campari.com/xmlns/sapquery/v1" xmlns="http://campari.com/xmlns/sapquery/v1"> <row> <value>test</value> <value>test</value> <value>01.01.2022</value> <value>01.01.2023</value> <value>test</value> </row> </tns5:values> </tns1:query> </tns1:sapQueryResponse> Copy