public interface SegmentService extends BatchService<SegmentServiceBatch>
The service enables you to retrieve segments and their names in the respective language..
Reference: SAP API Business Hub
OData Service: | API_SEGMENT_SRV |
API Version: | 1 |
Communication Scenario: | SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241) |
Scope Items: | Import Connection setup with SAP Analytics Cloud (1YB), Group Reporting - Data from SAP Group Reporting Data Collection (287) |
Authentication Methods: | Basic, x509 |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
Modifier and Type | Method and Description |
---|---|
SegmentFluentHelper |
getAllSegment()
Fetch multiple
Segment entities. |
SegmentTextFluentHelper |
getAllSegmentText()
Fetch multiple
SegmentText
entities. |
SegmentByKeyFluentHelper |
getSegmentByKey(String segment)
Fetch a single
Segment entity using
key fields. |
SegmentTextByKeyFluentHelper |
getSegmentTextByKey(String language,
String segment)
Fetch a single
SegmentText entity
using key fields. |
SegmentService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull SegmentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull SegmentFluentHelper getAllSegment()
Segment
entities.@Nonnull SegmentByKeyFluentHelper getSegmentByKey(String segment)
Segment
entity using
key fields.segment
- Segment for Segmental Reporting
Constraints: Not nullable, Maximum length: 10
Segment
entity using key
fields. This fluent helper allows methods which modify the underlying query to be called before executing
the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SegmentTextFluentHelper getAllSegmentText()
SegmentText
entities.SegmentText
entities.
This fluent helper allows methods which modify the underlying query to be called before executing the
query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SegmentTextByKeyFluentHelper getSegmentTextByKey(String language, String segment)
SegmentText
entity
using key fields.segment
- Segment for Segmental Reporting
Constraints: Not nullable, Maximum length: 10
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
SegmentText
entity using
key fields. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.