Get all social posts
get
/crmRestApi/resources/11.13.18.05/socialPosts
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a social post with the specified primary key.
Finder Variables:- PostId; integer; The unique identifier of the social post.
- PrimaryKey: Finds a social post with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CanRespondFlag; boolean; Indicates whether other users can respond to a social post.
- CreatedBy; string; The user who created the social post.
- CreationDate; string; The date when the social post was created.
- DeletedFlag; boolean; Indicates whether the social post can be deleted. If the value is Y, then the social post can be deleted. The default value is N.
- LastUpdateDate; string; The date and time when the social post was last updated.
- LastUpdateLogin; string; The login of the user who last updated the social post.
- LastUpdatedBy; string; The user who last updated the social post.
- ObjectId; integer; The unique identifier of the business object associated with the social post.
- ObjectTypeCd; string; Indicates the type of business object associated with the social post, such as SVC_SERVICE_REQUESTS or SVC_SR_MESSAGES.
- PostChannelCd; string; The code indicating the social network on which the social post was made. The accepted values are defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
- PostContentString; string; The content of the social post in string data type.
- PostDate; string; The date and time when the customer made the social post on the social network.
- PostId; integer; The unique identifier of the social post.
- PostMessageTypeCd; string; The code indicating if the social post is public or private. The accepted values are defined in the lookup type ORA_SVC_SOC_POST_MSG_TYPE_CD.
- PostParentPostId; string; The unique identifier of the social post's parent as provided by the source system. If this field is null, a service request is created for the social post. If this field is not null, the social post content of this record will be added to the service request corresponding to the social post record of this field.
- PostPostId; string; The unique identifier of the social post's post as provided by the source system.
- PostSubChannelName; string; The name of the channel on which the social post was made, such as the Facebook fan page or the twitter handle of the brand company.
- PostURL; string; The URL of the social post on the social network.
- PostUser; string; The social network handle of the author who made the social post.
- ProcessingMessage; string; The processed social post message.
- ProcessingStatusCd; string; The code indicating whether the social post has been processed successfully. For example, Error, Processed. A list of accepted values is defined in the lookup ORA_SVC_SOCIAL_PROC_STATUS_CD.
- SocialUserId; integer; The unique identifier of the user on the social network.
- SourceCd; string; The code indicating the source system which sent the social post to CX Sales and B2B Service, for example, SRM. The accepted values are defined in the lookup type ORA_SVC_SOC_POST_SOURCE_CD.
- SourcePostIdPrimary; string; Reserved for integration. This field can be used by the integrators when calling back the source system or when sending a response to the source system.
- SourcePostIdSecondary; string; Reserved for integration. This field can be used by the integrators when calling back the source system or when sending a response to the source system.
- SourcePostIdTertiary; string; Reserved for integration. This field can be used by the integrators when calling back the source system or when sending a response to the source system.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Use GET with the following URI syntax to get details of all the social posts:
Example of Request URI
The following shows an example of the request header.
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/socialPosts/ HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 09 Jan 2017 13:26:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "CreatedBy": "autoapicsm2", "CreationDate": "2016-09-27T12:47:02-07:00", "DeletedFlag": false, "LastUpdateDate": "2016-11-08T13:50:47-08:00", "LastUpdateLogin": "40CBE73A45914FBBE0530E8EF50A5A19", "LastUpdatedBy": "SALES_ADMIN", "PostChannelCd": "ORA_SVC_FACEBOOK", "PostDate": "2016-09-27T13:23:22-07:00", "PostId": 300100090027888, "PostMessageTypeCd": null, "PostParentPostId": null, "PostPostId": "8391", "PostSubChannelName": null, "PostURL": null, "PostUser": "me@me.com", "SourceCd": "ORA_SVC_ICS", "SourcePostIdPrimary": "9281", "SourcePostIdSecondary": null, "SourcePostIdTertiary": null, "PostContentString": "Test Test", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888", "name": "socialPosts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888", "name": "socialPosts", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/PostMessageTypeCdLookup", "name": "PostMessageTypeCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/lov/PostChannelCdLookup", "name": "PostChannelCdLookup", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100090027888/enclosure/PostContent", "name": "PostContent", "kind": "other" } ], }, { "CreatedBy": "autoapicsm2", "CreationDate": "2016-10-13T21:17:43-07:00", "DeletedFlag": false, "LastUpdateDate": "2016-10-13T21:17:43-07:00", "LastUpdateLogin": "3ECC4811802C501FE0530E8EF50ACE3A", "LastUpdatedBy": "autoapicsm2", "PostChannelCd": "ORA_SVC_TWITTER", "PostDate": "2016-10-13T13:23:22-07:00", "PostId": 300100091600174, "PostMessageTypeCd": null, "PostParentPostId": null, "PostPostId": "2332", "PostSubChannelName": null, "PostURL": null, "PostUser": "me@me.com", "SourceCd": "ORA_SVC_ICS", "SourcePostIdPrimary": "1483", "SourcePostIdSecondary": null, "SourcePostIdTertiary": null, "PostContentString": "Test Test", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174", "name": "socialPosts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174", "name": "socialPosts", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/PostMessageTypeCdLookup", "name": "PostMessageTypeCdLookup", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/lov/PostChannelCdLookup", "name": "PostChannelCdLookup", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100091600174/enclosure/PostContent", "name": "PostContent", "kind": "other" } ], }, . . . } }