Get a social post

get

/crmRestApi/resources/11.13.18.05/socialPosts/{PostId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : socialPosts-item-response
Type: object
Show Source
  • Title: Allows Response
    Maximum Length: 1
    Default Value: true
    Indicates whether other users can respond to a social post.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the social post.
  • Title: Creation Date
    Read Only: true
    The date when the social post was created.
  • Title: Deleted
    Maximum Length: 1
    Default Value: false
    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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the social post was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the social post.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the social post.
  • Links
  • Title: Object ID
    The unique identifier of the business object associated with the social post.
  • Title: Object Type
    Maximum Length: 30
    Indicates the type of business object associated with the social post, such as SVC_SERVICE_REQUESTS or SVC_SR_MESSAGES.
  • Title: Social Post Channel Code
    Maximum Length: 30
    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.
  • Title: Social Post Content
    The content of the social post made by the customer.
  • The content of the social post in string data type.
  • Title: Social Post Date
    The date and time when the customer made the social post on the social network.
  • Title: Social Post ID
    Read Only: true
    The unique identifier of the social post.
  • Title: Social Post Message Type Code
    Maximum Length: 30
    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.
  • Title: Social Post Parent Post ID
    Maximum Length: 255
    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.
  • Title: Social Message Post ID
    Maximum Length: 255
    The unique identifier of the social post's post as provided by the source system.
  • Title: Social Post Subchannel Name
    Maximum Length: 400
    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.
  • Title: Social Post URL
    Maximum Length: 1000
    The URL of the social post on the social network.
  • Title: Social Post User
    Maximum Length: 64
    The social network handle of the author who made the social post.
  • Title: Processing Message
    Maximum Length: 1000
    The processed social post message.
  • Title: Processing Status
    Maximum Length: 30
    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.
  • Social Post Tags
    Title: Social Post Tags
    The social post tags resource is used to view, create, and delete the tags associated with a social post, such as Customer_Churn, Billing Customer Service, etc.
  • Social Post URLs
    Title: Social Post URLs
    The social post URLs resource is used to view, create, and delete the URLs associated with service objects such as social posts or service requests. An example of an URL is the link to a photo sent by a customer along with a social post.
  • Title: Social User ID
    The unique identifier of the user on the social network.
  • Title: Source Code
    Maximum Length: 30
    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.
  • Title: Source Post Primary ID
    Maximum Length: 255
    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.
  • Title: Source Post Secondary ID
    Maximum Length: 255
    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.
  • Title: Source Post Tertiary ID
    Maximum Length: 255
    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.
Nested Schema : Social Post Tags
Type: array
Title: Social Post Tags
The social post tags resource is used to view, create, and delete the tags associated with a social post, such as Customer_Churn, Billing Customer Service, etc.
Show Source
Nested Schema : Social Post URLs
Type: array
Title: Social Post URLs
The social post URLs resource is used to view, create, and delete the URLs associated with service objects such as social posts or service requests. An example of an URL is the link to a photo sent by a customer along with a social post.
Show Source
Nested Schema : socialPosts-SocialPostTags-item-response
Type: object
Show Source
Nested Schema : socialPosts-socialPostUrls-item-response
Type: object
Show Source
  • Links
  • Title: URL
    Maximum Length: 1000
    The actual social post URL.
  • Title: URL ID
    Read Only: true
    The unique identifier of the social post URL.
Back to Top

Examples

Use GET with the following URI syntax to get details for a specific social post:

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/300100094869727

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/socialPosts/300100094869727 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:23: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.

{
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-01-09T03:36:22-08:00",
"DeletedFlag": false,
"LastUpdateDate": "2017-01-09T03:36:22-08:00",
"LastUpdateLogin": "45A687B69853331FE0530E8EF50A5040",
"LastUpdatedBy": "SALES_ADMIN",
"PostChannelCd": "ORA_SVC_FACEBOOK",
"PostDate": "2016-03-18T13:23:22-07:00",
"PostId": 300100094869727,
"PostMessageTypeCd": null,
"PostParentPostId": "A123231",
"PostPostId": "8312",
"PostSubChannelName": "HBOGOT",
"PostURL": null,
"PostUser": "abcdef",
"SourceCd": "ORA_SVC_ICS",
"SourcePostIdPrimary": "A12356",
"SourcePostIdSecondary": null,
"SourcePostIdTertiary": null,
"PostContentString": "Test SR Creation Social Post Creation",
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727",
"name": "socialPosts",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727",
"name": "socialPosts",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727/lov/SourceCdLookup",
"name": "SourceCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727/lov/PostMessageTypeCdLookup",
"name": "PostMessageTypeCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727/lov/PostChannelCdLookup",
"name": "PostChannelCdLookup",
"kind": "collection"
}
,
  
{
"rel": "enclosure",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100094869727/enclosure/PostContent",
"name": "PostContent",
"kind": "other"
}
],
}
Back to Top