| Description | Query Social Media Activity |
| Name | QuerySocialMediaActivityIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Activity Management |
| Process Component Name | ActivityManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/Activity/Global |
| Deploymnent Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to query social media activities created based on messages originating in an external social media channel
The web service interface Query Social Media Activitiy In is used by external systems to query social media activities imported from social media sites like Facebook and Twitter.
This web service interface includes the following operation: Find By Elements.
This web service is synchronous and mass enabled. Requesting large amounts of data can cause communication timeout. The web service consumer is responsible for ensuring requests are of a reasonable size for mass operations.
The structure of the request message consists of the following:
The following selection parameters of the web service are mainly exposed as select options or ranges:
InclusionExclusionCode
The inclusion/exclusion code specifies the inclusion or exclusion of a set into a result set.
| Code | Description |
|---|---|
| E | Excluding |
| I | Including |
IntervalBoundaryTypeCode
The interval boundary type code is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Code | Name | Description | Values |
|---|---|---|---|
| 1 | Equal to | Single value | = X |
| 2 | Between (excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less than or equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater than or equal to | Interval with closed lower and unlimited upper boundary | >= X |
The processing conditions specify how to process the web service query, specifically, the maximum number of hits to be returned.
This web service supports the following process condition elements for request messages:
| Element | Description |
|---|---|
| QueryHitsMaximumNumberValue | Maximum number of hits to be returned by an inquiry |
| QueryHitsUnlimitedIndicator | Indicates that the maximum number of hits to be returned by an inquiry is unlimited |
| LastReturnedObjectID | Identifies the last object returned by a previous inquiry |
| If QueryHitsUnlimitedIndicator = true, then QueryHitsMaximumNumberValue must not be filled. |
Requested elements enable the web service consumer, an external system, to reduce the size of query response messages and thereby reduce transmission and response times and avoid timeouts.
Requested elements can contain optional transmission request codes for controlling the transmission of corresponding query response node elements.
The transmission request codes are modeled as .xml attributes following the syntax: <element name>TransmissionRequestCode.
The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.
| Transmission Request Code | Name | Description |
|---|---|---|
| 1 | Complete Structure | The node element and all its elements, its child node elements and all their elements will be returned |
| 2 | Complete Node | The node element and all its elements will be returned |
| 3 | Node with Key Elements | The node element and its key elements will be returned (not supported by all web service interfaces) |
| 4 | Excluded Node | The node element and its child node elements will not be returned |
As the transmission request code is optional, if no transmission request code is modeled or provided by the web service consumer, then the following rules apply:
The structure of the query response message consists of three parts:
Process Conditions
This web service contains the following process condition elements for response messages:
| Element | Description |
|---|---|
| ReturnedQueryHitsNumberValue | The number of hits returned by an inquiry |
| MoreHitsAvailableIndicator | Indicates that there are more than _ReturnedQueryHitsNumberValue_ hits matching the selection criteria |
| LastReturnedObjectID | Identifies the last object returned by this inquiry |
| Processing conditions can be used for pagination of query results. However, it is crucial not to change the query selection parameters from request to request, as otherwise the query result might change. |
| Description | Find social media activities |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Deprecated |
To find social media activities by element.
The operation Find By Elements processes the requests from external systems and returns the social media activities matching the given query criteria.
It includes the following nodes:
The request message of the operation contains the node, SocialMediaActivitySelectionByElements, which groups all possible selection parameters.
Social Media Activity Selection By Elements
| Selection Parameter | Description |
|---|---|
| SelectionByID | Selection by Social Media Activity internal identifier |
| SelectionBySocialMediaMessageID | Selection by identifier from social media channel |
| SelectionByCategoryCode | Selection by Coded representation of the category of a social media activity |
| SelectionBySocialMediaChannelCode | Selection by Social Media channel type |
| SelectionBySocialMediaMessageCreationDateTime | Selection by point in time at which social media message was created in the social media channel |
The response contains the list of social media activities, log items, and processing conditions.
Social Media Activity
This node contains the following elements and two SubNodes (Interaction Content and Attachment Folder).
| Element Name | Description |
|---|---|
| ChangeStateID | An identifier for a change state |
| UUID | Universally unique identifier of the Social Media Activity |
| ID | Internal Identifier of Social Media Activity |
| SocialMediaMessageID | Identifier from social media channel |
| ParentSocialMediaMessageID | Identifier of Parent Social Media Activity from social media channel |
| RootSocialMediaMessageID | Identifier of Root Social Media Activity from social media channel |
| SocialmediaUserProfileID | Identifier of the Social Media User Profile |
| SocialMediaActivityProviderID | Identifier of Social Media Activity Provider |
| SocialMediaMessageCreationDateTime | Point in time at which social media message was created in the social media channel |
| SocialMediaMessageURI | Social Media Message URL |
| PrivateSocialMediaMessageIndicator | Indicator that social media activity is posted privately |
| CategoryCode | A coded representation of the category of Social Media Activity |
| SocialMediaChannelCode | Coded representation of social media channel type |
Interaction Content
This node contains the following elements
| Element Name | Description |
|---|---|
| Text | Social Media message text |
Attachment Folder
It contains all the attached documents to a social media activity.
Show full documentation
Show full documentation