Create an interaction participant
post
/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants
Request
Path Parameters
-
InteractionId(required): integer(int64)
The unique identifier of the interaction.
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
-
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The PartyId of the contact if the participant is a contact. -
DurationMinutes: integer
(int32)
Title:
Minutes
The number of minutes the participant was on the conference. You can join, drop, and rejoin the conference. -
Email: string
Title:
Email
Maximum Length:128
The email of the participant. -
EndTime: string
(date-time)
Title:
End Time
The time when the participant left the interaction. -
InteractionId: integer
(int64)
Title:
Interaction ID
The interaction id of the interaction to which the participant belongs. -
InteractionParticipantNumber: string
Title:
Participant Number
Maximum Length:30
The public unique identifier for the Interaction Participant. -
Json: string
(byte)
Title:
JSON
The JSON String used for customization. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version of the participant record. -
OriginalSystemReference: string
Title:
Original System Reference
Maximum Length:255
Specifies the original system reference if record was imported. -
ParticipantName: string
Title:
Name
Maximum Length:128
The name from the web conference. Does not necessarily tie to Fusion data. -
ParticipantTypeCd: string
Title:
Participant Type Code
Maximum Length:30
The type of participant. The value is sourced from the lookup ORA_SVC_PARTICIPANT_TYPE_CD. -
Phone: string
Title:
Phone
Maximum Length:128
The phone number of the participant. -
ResourcePartyId: integer
(int64)
Title:
Resource Party ID
The party Id of the resource if the participant is a resource. -
StartTime: string
(date-time)
Title:
Start Time
The time when the participant joined the interaction.
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 : interactions-InteractionParticipants-item-response
Type:
Show Source
object
-
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The PartyId of the contact if the participant is a contact. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The party number of the contact if the participant was a contact. -
ContactPartyUniqueName: string
Title:
Contact Unique Name
Read Only:true
Maximum Length:900
The unique name of the contact if the participant was a contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the participant. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the participant was added. -
DurationMinutes: integer
(int32)
Title:
Minutes
The number of minutes the participant was on the conference. You can join, drop, and rejoin the conference. -
Email: string
Title:
Email
Maximum Length:128
The email of the participant. -
EndTime: string
(date-time)
Title:
End Time
The time when the participant left the interaction. -
InteractionId: integer
(int64)
Title:
Interaction ID
The interaction id of the interaction to which the participant belongs. -
InteractionNumber: string
Title:
Interaction Number
Read Only:true
Maximum Length:30
-
InteractionParticipantId: integer
(int64)
Title:
Participant ID
Read Only:true
The auto-generated number and primary key for this participant. -
InteractionParticipantNumber: string
Title:
Participant Number
Maximum Length:30
The public unique identifier for the Interaction Participant. -
Json: string
(byte)
Title:
JSON
The JSON String used for customization. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the participant was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the participant. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The system login reference of the last user to update the participant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version of the participant record. -
OriginalSystemReference: string
Title:
Original System Reference
Maximum Length:255
Specifies the original system reference if record was imported. -
ParticipantName: string
Title:
Name
Maximum Length:128
The name from the web conference. Does not necessarily tie to Fusion data. -
ParticipantTypeCd: string
Title:
Participant Type Code
Maximum Length:30
The type of participant. The value is sourced from the lookup ORA_SVC_PARTICIPANT_TYPE_CD. -
Phone: string
Title:
Phone
Maximum Length:128
The phone number of the participant. -
ResourcePartyId: integer
(int64)
Title:
Resource Party ID
The party Id of the resource if the participant is a resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The party number of the resource if the participant was a resource. -
ResourcePartyUniqueName: string
Title:
Resource Unique Name
Read Only:true
Maximum Length:900
The unique name of the resource if the participant was a resource. -
StartTime: string
(date-time)
Title:
Start Time
The time when the participant joined the interaction.
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.
Links
- ParticipantTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_PARTICIPANT_TYPE_CD
The list of values indicating the participant types.
The following properties are defined on the LOV link relation:- Source Attribute: ParticipantTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: