Jump to

• Request
• Response
• Examples

Add a social post URL

post

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

Request

Path Parameters

• PostId(required): integer(int64)
  The unique identifier of the social post.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Url: string
  Title: URL

  Maximum Length: 1000

  The actual social post URL.

{
    "type":"object",
    "properties":{
        "Url":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The actual social post URL.",
            "nullable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : socialPosts-socialPostUrls-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Url: string
  Title: URL

  Maximum Length: 1000

  The actual social post URL.
• UrlId: integer
  Title: URL ID

  Read Only: true

  The unique identifier of the social post URL.

{
    "type":"object",
    "properties":{
        "UrlId":{
            "title":"URL ID",
            "type":"integer",
            "description":"The unique identifier of the social post URL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Url":{
            "title":"URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The actual social post URL.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to add a social post URL by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts

Example of Request Body

The following shows an example of the request body in JSON format.

{
      "PostChannelCd": "TWITTER",
      "PostDate": "2019-02-13T05:37:44+00:00",
      "PostMessageTypeCd": "ORA_SVC_POST",
      "PostParentPostId": null,
      "PostPostId": "3215",
      "PostSubChannelName": "PellComputers",
      "PostURL": "http://twitter.com/rnhkmtest/status/1095557614727905281",
      "PostUser": "rnhkmtest",
      "SourceCd": "ORA_SVC_ICS",
      "SourcePostIdPrimary": "475",
      "SourcePostIdSecondary": "9973",
      "SourcePostIdTertiary": "cc4b3254-d487-4cb5-b15a-0434b50d86f8",
      "PostContentString": "@PellComputers  Need urgent help. My laptop is not charging and I have a presentation tomorrow. https://t.co/wBxkFdYiws",
      "SocialUserId": 100100080047819,
      "CanRespondFlag": true,
      "socialPostUrls": [
        {
          "Url": "https://pbs.twimg.com/media/DzQz02KUUAE1J_V.jpg"
        }
      ]
    }

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2020-01-06T08:30:20+00:00",
  "DeletedFlag" : false,
  "LastUpdateDate" : "2020-01-06T08:30:20.848+00:00",
  "LastUpdateLogin" : "99EB552401AB545FE05392BDF20A1B17",
  "LastUpdatedBy" : "SALES_ADMIN",
  "PostChannelCd" : "TWITTER",
  "PostDate" : "2019-02-13T05:37:44+00:00",
  "PostId" : 300100182585563,
  "PostMessageTypeCd" : "ORA_SVC_POST",
  "PostParentPostId" : null,
  "PostPostId" : "3215",
  "PostSubChannelName" : "PellComputers",
  "PostURL" : "http://twitter.com/rnhkmtest/status/1095557614727905281",
  "PostUser" : "rnhkmtest",
  "SourceCd" : "ORA_SVC_ICS",
  "SourcePostIdPrimary" : "475",
  "SourcePostIdSecondary" : "9973",
  "SourcePostIdTertiary" : "cc4b3254-d487-4cb5-b15a-0434b50d86f8",
  "PostContentString" : "@PellComputers  Need urgent help. My laptop is not charging and I have a presentation tomorrow. https://t.co/wBxkFdYiws",
  "ProcessingStatusCd" : null,
  "ProcessingMessage" : null,
  "ObjectId" : null,
  "ObjectTypeCd" : null,
  "SocialUserId" : 100100080047819,
  "CanRespondFlag" : true,
  "socialPostUrls" : [ {
    "UrlId" : 300100182585564,
    "Url" : "https://pbs.twimg.com/media/DzQz02KUUAE1J_V.jpg",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/socialPosts/300100182585563/child/socialPostUrls/300100182585564",
      "name" : "socialPostUrls",
      "kind" : "item"
    }, 
...
  } ]
}

Back to Top