Create a channel resource member
post
/crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers
Request
Path Parameters
-
ChannelId(required): integer(int64)
The unique identifier of the channel.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountCredentials: string
Title:
Account Credentials
Maximum Length:400
The account credentials of the channel resource. -
AccountToken: string
Title:
Account Token
Maximum Length:400
The account token associated with the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelResourceId: integer
(int64)
Title:
Channel Resource ID
The unique identifier of the resource associated with the channel. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party of the resource associated with the channel. -
PartyName: string
Maximum Length:
360
The name of the party of the resource associated with the channel.
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.
Root Schema : channels-resourceMembers-item-response
Type:
Show Source
object
-
AccountCredentials: string
Title:
Account Credentials
Maximum Length:400
The account credentials of the channel resource. -
AccountToken: string
Title:
Account Token
Maximum Length:400
The account token associated with the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelResourceId: integer
(int64)
Title:
Channel Resource ID
The unique identifier of the resource associated with the channel. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the channel resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the channel resource was added. -
EmailAddress: string
Read Only:
true
Maximum Length:320
The email address of the resource associated with the channel. -
FormattedPhoneNumber: string
Read Only:
true
The phone number of the resource associated with the channel. -
LastUpdateDate: string
(date-time)
Title:
Last Update
Read Only:true
The user who last updated the channel resource. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the channel resource. -
LastUpdateLogin: string
Title:
Update Login
Read Only:true
Maximum Length:32
The date when the channel resource was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party of the resource associated with the channel. -
PartyIdFK: integer
(int64)
Read Only:
true
The foreign key identifier of the party of the resource associated with the channel. -
PartyName: string
Maximum Length:
360
The name of the party of the resource associated with the channel.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
The following example shows how to create a channel resource member by submitting a POST request on the REST resource.
Example of Request Header
The following shows an example of the request header.
POST /crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Request Body
The following shows an example of the request body.
{"PartyId": "3158", "AccountToken": "RESTACC"}
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 201 CREATED 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.
{ "ChannelResourceId": 300100107975012, "ChannelId": 1, "PartyId": 3158, "PartyIdFK": 3158, "PartyName": "Merced Khayer", "EmailAddress": "sendmail-test-discard@oracle.com", "FormattedPhoneNumber": "+1 ", "AccountToken": "RESTACC", "AccountCredentials": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-04-14T08:12:51+00:00", "LastUpdateDate": "2017-04-14T08:12:51.045+00:00", "LastUpdateLogin": "4D1C610A4B51165AE05356C0F20AB312", "LastUpdatedBy": "SALES_ADMIN", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012", "name": "resourceMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012", "name": "resourceMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1", "name": "channels", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012/lov/ResourceLOV", "name": "ResourceLOV", "kind": "collection" } ] }