Execute OData service(GET)

Operation name

Function overview

Executes the OData service API of SAP S/4HANA with the HTTP GET method.

Data model

The data model of this component is XML type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name to use on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > SAP S/4HANA ODATA > OData Connection.
Authentication type	Required	Not available	Select the authentication type when executing the OData service. OAuth 2.0 authentication (Default) OAuth 2.0 authentication is used for execution. Basic authentication Basic authentication is used for execution.
OAuth 2.0 authentication settings	Required	Not available	Select a connection resource.	This is displayed when OAuth 2.0 authentication is selected for Authentication type.
Basic authentication settings	Required	Not available	Select a connection resource.	This is displayed when Basic authentication is selected for Authentication type.
EntityType	Required	Available	Select or enter an entity type corresponding to the type of the resource path to be read.
Property List	Required	-	The property list of the entity type specified for EntityType is displayed.
Property List/Key	Required	Not available	Whether the property is a key or not is displayed.
Property List/Name	Required	Not available	The property name is displayed.
Property List/Edm.Type	Required	Not available	The Edm.Type of the property is displayed.
Property List/Nullable	Required	Not available	Whether the property allows Null or not is displayed.
Resource path	Required	Available	Enter the resource path of the OData service API to be executed.
Include entity key in resource path	Optional	Not available	Select whether or not to include the entity key in the resource path. Selected Include the entity key in the resource path. Not selected (Default) Don't include the entity key in the resource path.
Entity key list	Required	-	The entity key list of the entity type specified for EntityType is displayed.	Enabled when Include entity key in resource path is selected.
Entity key list/Name	Required	Not available	The entity key name is displayed.
Entity key list/Edm.Type	Required	Not available	The Edm.Type of the entity key is displayed.
Entity key list/Value specification method	Required	Not available	Select the specification method of the entity key value. Enter directly (Default) A value that is input for Entity key list/Value is referenced as an entity key. Input data The value of the input data is referenced as an entity key.
Entity key list/Value	Optional	Not available	Enter the value of the entity key.	The value that you input will be ignored when Input data is selected for Entity key list/Value specification method.

Property actions

Item name	Description	Remarks
Retrieve entity list	Retrieve metadata from the specified destination OData service and set it for EntityType.	Enabled when all the following property items are set: Destination Basic authentication settings or OAuth 2.0 authentication settings
Retrieve property list from an entity	Retrieve data from the property list of the specified entity type and set the data in Property List and Entity key list.	Enabled when all the following property items are set: Destination Basic authentication settings or OAuth 2.0 authentication settings EntityType

Query options settings

Item name	Required/Optional	Use of variables	Description	Remarks
$filter(Query filter)	Optional	Available	Enter the value of the $filter query parameter.
$select(Select query)	Optional	Available	Enter the value of the $select query parameter.
$top(Record count)	Optional	Available	Enter the value of the $top query parameter.	Enabled when Enable paging isn't selected.
$skip(Skip count)	Optional	Available	Enter the value of the $skip query parameter.	Enabled when Enable paging isn't selected.
Enable paging	Optional	Not available	Select whether or not to enable paging. Selected Enable paging. Not selected (Default) Don't enable paging.
Number of records per page	Optional	Available	Enter the number of entities to be retrieved per page in the paging processing.	Enabled when Enable paging is selected.

Request settings

Item name	Required/Optional	Use of variables	Description	Remarks
Query parameters	Optional	-	Specify query parameters to be included in a request. Each query parameter can be operated with the following buttons: Up Move the selected query parameter upwards by one row. Down Move the selected query parameter downwards by one row. Add Add a query parameter. Delete Delete the query parameter.
Query parameters/Name	Optional	Available	Enter the name of the query parameter.	When omitted, the query parameter isn't included in the request.
Query parameters/Value	Optional	Available	Enter the value of the query parameter.
Request header	Optional	-	Specify HTTP headers to be included in a request. Each request header can be operated with the following buttons: Add Add a request header. Up Move the selected request header upwards by one row. Down Move the selected request header downwards by one row. Delete Delete the request header.
Request header/Name	Optional	Available	Enter the request header name.	When omitted, the request header isn't included in the request.
Request header/Value	Optional	Available	Enter the request header value.

Response settings

Item name	Required/Optional	Use of variables	Description	Remarks
Error when response status code is 4xx or 5xx	Optional	Not available	Select whether or not to make the processing an error when the response status code is "4xx" or "5xx". Selected Processing will end as an error. Not selected (Default) Processing won't end as an error.
Response header	Optional	-	Specify header names to get from HTTP headers included in a response. Each response header can be operated with the following buttons: Add Add a response header. Up Move the selected response header upwards by one row. Down Move the selected response header downwards by one row. Delete Delete the response header.	A response header is defined as a component variable with the name entered in Name.
Response header/Name	Optional	Only environment variables are available	Enter the response header name.	Case-insensitive. When omitted, it's not defined as a component variable. When there's a space/tab/line feed before or after the name, it will be trimmed and defined as a component variable.

Item name

Required/Optional

Use of variables

Description

Remarks

Error when response status code is 4xx or 5xx

Optional

Not available

Select whether or not to make the processing an error when the response status code is "4xx" or "5xx".

Selected

Processing will end as an error.

Not selected

(Default)

Processing won't end as an error.

Response header

Optional

Specify header names to get from HTTP headers included in a response.

Each response header can be operated with the following buttons:

Add: Add a response header.
Up: Move the selected response header upwards by one row.
Down: Move the selected response header downwards by one row.
Delete: Delete the response header.

A response header is defined as a component variable with the name entered in Name.

Response header/Name

Optional

Only environment variables are available

Enter the response header name.

Case-insensitive.
When omitted, it's not defined as a component variable.
When there's a space/tab/line feed before or after the name, it will be trimmed and defined as a component variable.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

OData V2

Input schema

<?xml version="1.0" encoding="utf-8"?> 
<entry xmlns="http://www.w3.org/2005/Atom" 
       xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" 
       xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"> 
    <content> 
        <m:properties> 
            <d:Entity key name /> 
        </m:properties> 
    </content> 
</entry>

Element name	Attribute name	Required/Optional	Description	Remarks
entry	-	Optional		This element is required when Input data is selected for Entity key list/Value specification method.
content	-	Optional		This element is required when Input data is selected for Entity key list/Value specification method.
m:properties	-	Optional		This element is required when Input data is selected for Entity key list/Value specification method.
d:Entity key name	-	Optional	When Input data is selected for Entity key list/Value specification method, enter the value of the entity key.	This element is required when Input data is selected for Entity key list/Value specification method.

Output schema

<?xml version="1.0" encoding="utf-8"?> 
<feed xmlns="http://www.w3.org/2005/Atom" 
      xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" 
      xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"> 
    <entry> 
        <content> 
            <m:properties> 
                <d:Property name m:null="" /> 
            </m:properties> 
        </content> 
    </entry> 
      : 
</feed>

Element name	Attribute name	Description
feed	-
entry	-	Repeated for the number of the entities to be retrieved.
content	-
m:properties	-
d:Property name	-	The property value of the entity that was read is output.
d:Property name	m:null	"true" is output if the property value is null.

OData V4

Input schema

<?xml version="1.0" encoding="utf-8"?> 
<root> 
    <value> 
        <Entity key name /> 
    </value> 
</root>

Element name	Attribute name	Required/Optional	Description	Remarks
root	-	Optional		This element is required when Input data is selected for Entity key list/Value specification method.
value	-	Optional		This element is required when Input data is selected for Entity key list/Value specification method.
Entity key name	-	Optional	When Input data is selected for Entity key list/Value specification method, enter the value of the entity key.	This element is required when Input data is selected for Entity key list/Value specification method.

Output schema

<?xml version="1.0" encoding="utf-8"?> 
<root> 
    <value> 
        <!-- If Edm.Type is a primitive type --> 
        <Property name null="" /> 
        <!-- If Edm.Type is Collection --> 
        <Property name of Collection> 
            <item> 
                <Property name null="" /> 
            </item> 
        </Property name of Collection /> 
    </value> 
      : 
</root>

Element name	Attribute name	Description
root	-
value	-	Repeated for the number of the entities to be retrieved.
Property name	-	The property value of the entity that was read is output.
Property name	null	"true" is output if the property value is null.
item	-	If the Edm.Type is Collection, this represents the collection element.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

You can edit the automatically loaded schema.

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
status_code	The HTTP status code of the response is stored.	The default value is null.
error_response_body	The response body with a response status code "4xx" or "5xx" is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as shown below. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Error message	Limitations
Messages and limitations of the SAP OData connector