Jump to

• Request
• Response
• Examples

Get all interactions

get

/crmRestApi/resources/11.13.18.05/interactions

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:
  
  

  • InteractionRowFinderById: Finds an interactions with the interaction identifier.
    Finder Variables:
    • BindInteractionId; integer; The unique interaction identifier.
    • BindStripeCd; string; The interactions stripe code.
  • InteractionRowFinderByMediaItemId: Finds an interaction by the media item identifier
    Finder Variables:
    • BindMediaItemId; string; The media item identifier of the interaction.
  • InteractionRowFinderByObject: Finds interactions associated with an object.
    Finder Variables:
    • ObjectId; integer; The unique identifier of the object.
    • ObjectTypeCd; string; The code indicating the type of the object.
  • InteractionRowFinderByOwnerCustomerTime: Finds interactions by Owner Identifier, Customer Identifier and Time.
    Finder Variables:
    • BindAccountPartyId; integer.
    • BindContactPartyId; integer.
    • BindCreationDate; string.
    • BindInteractionId; integer.
    • BindLastUpdateDate; string.
    • BindOwnerResourceId; integer.
    • BindStatusCd; string.
  • InteractionRowFinderByOwnerCustomerTimeObject: Finds child interactions with the specified primary key, such as Owner Identifier, Customer Identifier, Time and Object
    Finder Variables:
    • BindAccountPartyId; integer.
    • BindContactPartyId; integer.
    • BindCreationDate; string.
    • BindInteractionId; integer.
    • BindLastUpdateDate; string.
    • BindOwnerResourceId; integer.
    • BindStatusCd; string.
    • ObjectId; integer.
    • ObjectTypeCd; string.
  • OpenChildInteractionRowFinderByChannelCustomerOwner: Finds interactions by Channel and Customers.
    Finder Variables:
    • BindAccountPartyId; integer; The unique identifier of the account associated with the interaction.
    • BindChannelId; integer; The unique identifier of the interaction channel.
    • BindContactPartyId; integer; The unique identifier of the contact associated with the interaction.
    • BindOwnerResourceId; integer; The unique identifier of the owner of the interaction.
    • BindParentInteractionId; integer; The unique identifier of the parent interaction.
  • PrimaryKey: Finds an interaction with the specified primary key.
    Finder Variables:
    • InteractionId; integer; The unique identifier of the interaction.
• 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:
  

  • AccountPartyId; integer; The unique identifier of the account associated with the interaction.
  • AccountPartyNumber; string; The alternate key for the account identifier.
  • AccountPartyUniqueName; string; The unique account name of the account associated with the interaction.
  • AgentHTTPSessionId; string; The unique identifier for the http session.
  • ChannelDisplayName; string; The name of the interaction channel.
  • ChannelId; integer; The unique identifier of the interaction channel.
  • ChannelShortName; string; The interaction channel short name.
  • ChannelTypeCd; string; The code indicating the type of the interaction channel.
  • ContactPartyId; integer; The unique identifier of the contact associated with the interaction.
  • ContactPartyNumber; string; The alternate key identifier for the contact party.
  • ContactPartyUniqueName; string; The unique contact name of the contact associated with the interaction.
  • CreatedBy; string; The user who created the interaction.
  • CreationDate; string; The date and time when the interaction was created.
  • Description; string; The description of the child interaction.
  • DirectionCd; string; The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.
  • EndTime; string; The time when the interaction ended.
  • InteractionId; integer; The unique identifier of the interaction.
  • InteractionNumber; string; The alternate key identifier for the interaction.
  • LastUpdateDate; string; The date when the interaction was last updated.
  • LastUpdateLogin; string; The session login of the user who last updated the interaction.
  • LastUpdatedBy; string; The user who last updated the interaction.
  • ManuallyLoggedFlag; boolean; Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.
  • MarketingReferenceId; integer; A unique identifier used to store a reference to a marketing system deployment number.
  • MediaItemId; string; The unique identifier for the media item.
  • OriginalSystemReference; string; The system reference used by the interaction.
  • OwnerResourceId; integer; The unique identifier of the owner of the interaction.
  • OwnerResourcePartyNumber; string; The alternate key identifier of the owner of the interaction.
  • OwnerResourcePartyUniqueName; string; The unique name of the owner of the interaction.
  • ParentInteractionId; integer; The unique identifier of the parent interaction.
  • ParentInteractionNumber; string; The alternate key identifier of the parent interaction.
  • QueueId; integer; The unique identifier of the interaction queue.
  • QueueName; string; The name of the interaction queue.
  • QueueNumber; string; The alternate key identifier for the queue.
  • SourceCd; string; A unique identifier used to store a source code reference within the child interaction object.
  • StartTime; string; The time when the interaction started.
  • StatusCd; string; The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.
  • StripeCd; string; The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.
  • SubstatusCd; string; The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.
  • TopLevelFlag; boolean; Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.
• 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 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 : interactions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/interactions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object interactions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/interactions-item-response"
    }
}

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 : interactions-item-response

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  The unique identifier of the account associated with the interaction.
• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The alternate key for the account identifier.
• AccountPartyUniqueName: string
  Title: Account

  Read Only: true

  Maximum Length: 900

  The unique account name of the account associated with the interaction.
• AgentHTTPSessionId: string
  Title: Session ID

  Maximum Length: 100

  The unique identifier for the http session.
• ChannelDisplayName: string
  Title: Channel Display Name

  Read Only: true

  Maximum Length: 400

  The name of the interaction channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the interaction channel.
• ChannelShortName: string
  Title: Channel Code

  Read Only: true

  Maximum Length: 450

  The interaction channel short name.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The code indicating the type of the interaction channel.
• childInteractions: array Child Interactions
  Title: Child Interactions

  The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
• ContactPartyId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the interaction.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier for the contact party.
• ContactPartyUniqueName: string
  Title: Contact

  Read Only: true

  Maximum Length: 900

  The unique contact name of the contact associated with the interaction.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the interaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the interaction was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the interaction can be deleted by the current user. The default value is false.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the child interaction.
• DirectionCd: string
  Title: Direction

  Maximum Length: 30

  Default Value: ORA_SVC_INBOUND

  The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.
• EndInteractionFlag: boolean
  Title: End Interaction

  This will set the Endtime attribute ( to the current time) without changing the interaction status to closed. The default value is false.
• EndTime: string (date-time)
  Title: End Time

  The time when the interaction ended.
• InteractionId: integer (int64)
  Title: Interaction ID

  Read Only: true

  The unique identifier of the interaction.
• InteractionNumber: string
  Title: Interaction Number

  Maximum Length: 30

  The alternate key identifier for the interaction.
• InteractionParticipants: array Interaction Participants
  Title: Interaction Participants

  The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.
• interactionReferences: array Interaction References
  Title: Interaction References

  The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the interaction was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the interaction.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the interaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManuallyLoggedFlag: boolean
  Maximum Length: 1

  Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.
• MarketingReferenceId: integer (int64)
  Title: Marketing Reference ID

  A unique identifier used to store a reference to a marketing system deployment number.
• MediaItemId: string
  Title: Media Item ID

  Maximum Length: 255

  The unique identifier for the media item.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The system reference used by the interaction.
• OwnerResourceId: integer (int64)
  Title: Owner Resource ID

  The unique identifier of the owner of the interaction.
• OwnerResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the owner of the interaction.
• OwnerResourcePartyUniqueName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 900

  The unique name of the owner of the interaction.
• ParentInteractionId: integer (int64)
  Title: Parent Interaction ID

  The unique identifier of the parent interaction.
• ParentInteractionNumber: string
  Title: Interaction Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the parent interaction.
• Payload: string (byte)
  Title: Payload

  The payload associated with the interaction.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the interaction queue.
• QueueName: string
  Title: Queue Name

  Read Only: true

  Maximum Length: 400

  The name of the interaction queue.
• QueueNumber: string
  Title: Queue Number

  Maximum Length: 30

  The alternate key identifier for the queue.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SourceCd: string
  Title: Source CD

  Maximum Length: 30

  A unique identifier used to store a source code reference within the child interaction object.
• StartInteractionFlag: boolean
  Title: Start Interaction

  Default Value: true

  Indicates if the interaction should be started if it hasn???t already been started. The default value is True.
• StartTime: string (date-time)
  Title: Start Time

  The time when the interaction started.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_SVC_OPEN

  The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.
• SubstatusCd: string
  Title: Substatus Code

  Maximum Length: 30

  The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.
• TopLevelFlag: boolean
  Title: Top Level

  Read Only: true

  Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.",
            "nullable":false,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the owner of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source CD",
            "maxLength":"30",
            "type":"string",
            "description":"A unique identifier used to store a source code reference within the child interaction object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "interactionReferences":{
            "title":"Interaction References",
            "type":"array",
            "description":"The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).",
            "items":{
                "$ref":"#/components/schemas/interactions-interactionReferences-item-response"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/interactions-smartActions-item-response"
            }
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstatusCd":{
            "title":"Substatus Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the owner of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the interaction started.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartInteractionFlag"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndInteractionFlag":{
            "title":"End Interaction",
            "type":"boolean",
            "description":"This will set the Endtime attribute  ( to the current time) without changing the interaction status to closed. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":"900",
            "type":"string",
            "description":"The unique contact name of the contact associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "childInteractions":{
            "title":"Child Interactions",
            "type":"array",
            "description":"The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.",
            "items":{
                "$ref":"#/components/schemas/interactions-childInteractions-item-response"
            }
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":"450",
            "type":"string",
            "description":"The interaction channel short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MarketingReferenceId":{
            "title":"Marketing Reference ID",
            "type":"integer",
            "description":"A unique identifier used to store a reference to a marketing system deployment number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the interaction channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the child interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionParticipants":{
            "title":"Interaction Participants",
            "type":"array",
            "description":"The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.",
            "items":{
                "$ref":"#/components/schemas/interactions-InteractionParticipants-item-response"
            }
        },
        "ChannelDisplayName":{
            "title":"Channel Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the interaction channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaItemId":{
            "title":"Media Item ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for the media item.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique account name of the account associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartInteractionFlag":{
            "title":"Start Interaction",
            "type":"boolean",
            "description":"Indicates if the interaction should be started if it hasn???t already been started. The default value is True.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key for the account identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the interaction queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyLoggedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AgentHTTPSessionId":{
            "title":"Session ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier for the http session.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "default":"ORA_SVC_OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The system reference used by the interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentInteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the parent interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the queue.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Child Interactions

Type: array

Title: Child Interactions

The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.

Show Source

• Array of: object interactions-childInteractions-item-response

{
    "title":"Child Interactions",
    "type":"array",
    "description":"The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.",
    "items":{
        "$ref":"#/components/schemas/interactions-childInteractions-item-response"
    }
}

Nested Schema : Interaction Participants

Type: array

Title: Interaction Participants

The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.

Show Source

• Array of: object interactions-InteractionParticipants-item-response

{
    "title":"Interaction Participants",
    "type":"array",
    "description":"The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.",
    "items":{
        "$ref":"#/components/schemas/interactions-InteractionParticipants-item-response"
    }
}

Nested Schema : Interaction References

Type: array

Title: Interaction References

The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).

Show Source

• Array of: object interactions-interactionReferences-item-response

{
    "title":"Interaction References",
    "type":"array",
    "description":"The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).",
    "items":{
        "$ref":"#/components/schemas/interactions-interactionReferences-item-response"
    }
}

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 : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object interactions-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/interactions-smartActions-item-response"
    }
}

Nested Schema : interactions-childInteractions-item-response

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  The unique identifier of the account associated with the interaction.
• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The alternate key for the account identifier.
• AccountPartyUniqueName: string
  Title: Account

  Read Only: true

  Maximum Length: 900

  The unique account name of the account associated with the interaction.
• AgentHTTPSessionId: string
  Title: Session ID

  Maximum Length: 100

  The unique identifier for the http session.
• ChannelDisplayName: string
  Title: Channel Display Name

  Read Only: true

  Maximum Length: 400

  The name of the interaction channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the interaction channel.
• ChannelShortName: string
  Title: Channel Code

  Read Only: true

  Maximum Length: 450

  The interaction channel short name.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The code indicating the type of the interaction channel.
• ContactPartyId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the interaction.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier for the contact party.
• ContactPartyUniqueName: string
  Title: Contact

  Read Only: true

  Maximum Length: 900

  The unique contact name of the contact associated with the interaction.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the interaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the interaction was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the interaction can be deleted by the current user. The default value is false.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the child interaction.
• DirectionCd: string
  Title: Direction

  Maximum Length: 30

  Default Value: ORA_SVC_INBOUND

  The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.
• EndInteractionFlag: boolean
  Title: End Interaction

  This will set the Endtime attribute ( to the current time) without changing the interaction status to closed. The default value is false.
• EndTime: string (date-time)
  Title: End Time

  The time when the interaction ended.
• InteractionId: integer (int64)
  Title: Interaction ID

  Read Only: true

  The unique identifier of the interaction.
• InteractionNumber: string
  Title: Interaction Number

  Maximum Length: 30

  The alternate key identifier for the interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the interaction was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the interaction.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the interaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManuallyLoggedFlag: boolean
  Maximum Length: 1

  Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.
• MarketingReferenceId: integer (int64)
  Title: Marketing Reference ID

  A unique identifier used to store a reference to a marketing system deployment number.
• MediaItemId: string
  Title: Media Item ID

  Maximum Length: 255

  The unique identifier for the media item.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The system reference used by the interaction.
• OwnerResourceId: integer (int64)
  Title: Owner Resource ID

  The unique identifier of the owner of the interaction.
• OwnerResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the owner of the interaction.
• OwnerResourcePartyUniqueName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 900

  The unique name of the owner of the interaction.
• ParentInteractionId: integer (int64)
  Title: Parent Interaction ID

  The unique identifier of the parent interaction.
• ParentInteractionNumber: string
  Title: Interaction Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the parent interaction.
• Payload: string (byte)
  Title: Payload

  The payload associated with the interaction.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the interaction queue.
• QueueName: string
  Title: Queue Name

  Read Only: true

  Maximum Length: 400

  The name of the interaction queue.
• QueueNumber: string
  Title: Queue Number

  Maximum Length: 30

  The alternate key identifier for the queue.
• SourceCd: string
  Title: Source CD

  Maximum Length: 30

  A unique identifier used to store a source code reference within the child interaction object.
• StartInteractionFlag: boolean
  Title: Start Interaction

  Default Value: true

  Indicates if the interaction should be started if it hasn???t already been started. The default value is True.
• StartTime: string (date-time)
  Title: Start Time

  The time when the interaction started.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_SVC_OPEN

  The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.
• SubstatusCd: string
  Title: Substatus Code

  Maximum Length: 30

  The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.
• TopLevelFlag: boolean
  Title: Top Level

  Read Only: true

  Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the child interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the interaction is inbound or outbound. The default value is ORA_SVC_INBOUND, indicating inbound interactions. The value is ORA_SVC_OUTBOUND for outbound interactions.",
            "nullable":false,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Channel Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the interaction channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaItemId":{
            "title":"Media Item ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for the media item.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique account name of the account associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartInteractionFlag":{
            "title":"Start Interaction",
            "type":"boolean",
            "description":"Indicates if the interaction should be started if it hasn???t already been started. The default value is True.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ChannelTypeCd"
                ]
            },
            "x-queryable":true
        },
        "OwnerResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the owner of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source CD",
            "maxLength":"30",
            "type":"string",
            "description":"A unique identifier used to store a source code reference within the child interaction object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key for the account identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstatusCd":{
            "title":"Substatus Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the sub-status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_CLOSED_SUBSTATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether an interaction is top level or not. An interaction is top level if the parent interaction identifier is the same as the interaction identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be updated by the current user. The default value is true if the user has access to update the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the owner of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the interaction queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyLoggedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the interaction was manually created. If manually created, the value is Y, else the value is N.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgentHTTPSessionId":{
            "title":"Session ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier for the http session.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the current status of the interaction. A list of valid values is defined in the lookup ORA_SVC_IM_STATUS_CD.",
            "nullable":false,
            "default":"ORA_SVC_OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The system reference used by the interaction.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the interaction started.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StartInteractionFlag"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentInteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the parent interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndInteractionFlag":{
            "title":"End Interaction",
            "type":"boolean",
            "description":"This will set the Endtime attribute  ( to the current time) without changing the interaction status to closed. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":"900",
            "type":"string",
            "description":"The unique contact name of the contact associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the queue.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the stripe of the interaction. A list of valid values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload associated with the interaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":"450",
            "type":"string",
            "description":"The interaction channel short name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MarketingReferenceId":{
            "title":"Marketing Reference ID",
            "type":"integer",
            "description":"A unique identifier used to store a reference to a marketing system deployment number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the interaction channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the interaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the interaction.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Nested Schema : interactions-InteractionParticipants-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the participant was added.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"128",
            "type":"string",
            "description":"The email of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "InteractionParticipantId":{
            "title":"Participant ID",
            "type":"integer",
            "description":"The auto-generated number and primary key for this participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the participant left the interaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":"128",
            "type":"string",
            "description":"The name from the web conference. Does not necessarily tie to Fusion data.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantTypeCd":{
            "title":"Participant Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of participant. The value is sourced from the lookup ORA_SVC_PARTICIPANT_TYPE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InteractionParticipantNumber":{
            "title":"Participant Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier for the Interaction Participant.",
            "nullable":false,
            "x-queryable":true
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version of the participant record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":"128",
            "type":"string",
            "description":"The phone number of the participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the resource if the participant was a resource.",
            "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"
            }
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The PartyId of the contact if the participant is a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The interaction id of the interaction to which the participant belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DurationMinutes":{
            "title":"Minutes",
            "type":"integer",
            "description":"The number of minutes the participant was on the conference. You can join, drop, and rejoin the conference.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System Reference",
            "maxLength":"255",
            "type":"string",
            "description":"Specifies the original system reference if record was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the participant joined the interaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Json":{
            "title":"JSON",
            "type":"string",
            "description":"The JSON String used for customization.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyUniqueName":{
            "title":"Contact Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the contact if the participant was a contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the contact if the participant was a contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyUniqueName":{
            "title":"Resource Unique Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the resource if the participant was a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The party Id of the resource if the participant is a resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the participant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The system login reference of the last user to update the participant.",
            "nullable":true,
            "readOnly":true,
            "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 : interactions-interactionReferences-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the reference.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the reference was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the interaction reference can be deleted by the current user. The default value is false.
• InteractionId: integer (int64)
  Title: Interaction ID

  The unique identifier of the interaction reference.
• InteractionNumber: string
  Title: Interaction Number

  Maximum Length: 30

  The alternate key identifier for the interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the reference was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the reference.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the reference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object associated with the interaction reference.
• ObjectNumber: string
  Title: Reference Number

  Read Only: true

  Maximum Length: 255

  The alternate key identifier of the object associated with the interaction reference.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier used for integration with external systems.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Reference Number",
            "maxLength":"255",
            "type":"string",
            "description":"The alternate key identifier of the object associated with the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the interaction reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be deleted by the current user. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionNumber":{
            "title":"Interaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the interaction.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the interaction reference can be updated by the current user. The default value is true if the user has access to update the interaction reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier used for integration with external systems.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the object present in the interaction reference. A list of valid values is defined in the lookup ORA_SVC_IM_REF_OBJECT_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the reference.",
            "nullable":true,
            "readOnly":true,
            "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 : interactions-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/interactions-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/interactions-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/interactions-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object interactions-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/interactions-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object interactions-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/interactions-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object interactions-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/interactions-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : interactions-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"Application usage.",
            "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 : interactions-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "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 : interactions-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "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"
    }
}

Back to Top

Examples

The following example shows how to get all interactions by submitting a GET request on the REST resource.

Request Header Example

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/interactions

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200: OK
Date: Fri, 03 Mar 2017 07:54:53 GMT
Server : Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourcecollection+json
Content-Language: en

Response Body Example

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

{
  "items": [
    {
      "InteractionId": 300100096307925,
      "ParentInteractionId": 300100096307925,
      "TopLevelFlag": "true",
      "Description": "Sent SrMessage 300100096307628",
      "ChannelId": 300100092273686,
      "ChannelDisplayName": "ditdevacisvcfib_qa.extservice.incoming",
      "ChannelTypeCd": "ORA_SVC_EMAIL",
      "AccountPartyId": null,
      "AccountPartyUniqueName": null,
      "ContactPartyId": null,
      "ContactPartyUniqueName": null,
      "QueueId": null,
      "QueueName": null,
      "OwnerResourceId": null,
      "OwnerResourcePartyUniqueName": null,
      "StartTime": "2017-02-20T04:09:17-08:00",
      "EndTime": "2017-02-20T04:09:17-08:00",
      "StatusCd": "ORA_SVC_CLOSED",
      "OriginalSystemReference": null,
      "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "CreationDate": "2017-02-20T04:09:17-08:00",
      "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
      "LastUpdateDate": "2017-02-20T04:09:17-08:00",
      "LastUpdateLogin": "48F584F941357435E05307B3F20AB8E8",
      "DirectionCd": "ORA_SVC_OUTBOUND",
      "StripeCd": "ORA_SVC_CRM",
      "MediaItemId": null,
      "SubstatusCd": null,
      "NotifyFlag": null,
      "UpdateFlag": "true",
      "DeleteFlag": "true",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
          "name": "interactions",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925",
          "name": "interactions",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/DirectionCdLookup",
          "name": "DirectionCdLookup",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/StatusCdLookup",
          "name": "StatusCdLookup",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/lov/ChannelIdByChannelType",
          "name": "ChannelIdByChannelType",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions",
          "name": "childInteractions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/interactionReferences",
          "name": "interactionReferences",
          "kind": "collection"
        },
        {
          "rel": "enclosure",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/enclosure/Payload",
          "name": "Payload",
          "kind": "other"
        }
      ]
    }
...
}

Back to Top