Jump to

• Request
• Response
• Examples

Get all child interactions

get

/crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions

Request

Path Parameters

• InteractionId(required): integer(int64)
  The unique identifier of the interaction.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 interactions with the interaction identifier.
    Finder Variables:
    • BindInteractionId; integer; The unique identifier of the interaction.
    • BindStripeCd; string; The stripe code associated to the interaction.
  • InteractionRowFinderByMediaItemId: Finds a child interaction by the associated media item identifier.
    Finder Variables:
    • BindMediaItemId; string; The media item identifier associated to 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; The unique identifier of the account associated with the interaction.
    • BindContactPartyId; integer; The unique identifier of the contact associated with the interaction.
    • BindCreationDate; string; The date and time when the reference was created.
    • BindInteractionId; integer; The unique identifier of the interaction.
    • BindLastUpdateDate; string; The date when the interaction was last updated.
    • BindOwnerResourceId; integer; The unique identifier of the owner of the interaction.
    • BindStatusCd; string; The status code for the child interaction.
  • InteractionRowFinderByOwnerCustomerTimeObject: Finds child interactions with the specified primary key, such as Owner Identifier, Customer Identifier, Time and Object
    Finder Variables:
    • BindAccountPartyId; integer; The unique identifier of the account associated with the child interaction.
    • BindContactPartyId; integer; The unique identifier of the contact associated with the child interaction.
    • BindCreationDate; string; The date and time when the reference was created.
    • BindInteractionId; integer; The unique identifier of the child interaction.
    • BindLastUpdateDate; string; The date when the child interaction was last updated.
    • BindOwnerResourceId; integer; The unique identifier of the owner of the child interaction.
    • BindStatusCd; string; The status code for the child interaction.
    • ObjectId; integer; The unique identifier of the child interaction object.
    • ObjectTypeCd; string; The code indicating the type of the object present in the interaction reference.
  • OpenChildInteractionRowFinderByChannelCustomerOwner: Find open child interactions by channel and customer.
    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 a child interaction with the specified primary key.
    Finder Variables:
    • InteractionId; integer; The unique identifier of the child 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-childInteractions

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-childInteractions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/interactions-childInteractions-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-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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all child 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/300100096307925/child/childInteractions

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" : 300100097737929,
    "ParentInteractionId" : 300100096307925,
    "TopLevelFlag" : "false",
    "Description" : "Sent SrMessage",
    "ChannelId" : 100100052667990,
    "ChannelDisplayName" : "Social (Seeded)",
    "ChannelTypeCd" : "ORA_SVC_SOCIAL",
    "AccountPartyId" : null,
    "AccountPartyUniqueName" : null,
    "ContactPartyId" : null,
    "ContactPartyUniqueName" : null,
    "QueueId" : null,
    "QueueName" : null,
    "OwnerResourceId" : null,
    "OwnerResourcePartyUniqueName" : null,
    "StartTime" : "2017-03-06T01:15:09-08:00",
    "EndTime" : null,
    "StatusCd" : "ORA_SVC_OPEN",
    "OriginalSystemReference" : null,
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2017-03-06T01:15:09-08:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-03-06T01:21:31-08:00",
    "LastUpdateLogin" : "4A0BD041F81345D7E05307B3F20ACD5E",
    "DirectionCd" : "ORA_SVC_INBOUND",
    "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/child/childInteractions/300100097737929",
      "name" : "childInteractions",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929",
      "name" : "childInteractions",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "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/child/childInteractions/300100097737929/lov/DirectionCdLookup",
      "name" : "DirectionCdLookup",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/StatusCdLookup",
      "name" : "StatusCdLookup",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/lov/ChannelIdByChannelType",
      "name" : "ChannelIdByChannelType",
      "kind" : "collection"
    }, {
      "rel" : "enclosure",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/interactions/300100096307925/child/childInteractions/300100097737929/enclosure/Payload",
      "name" : "Payload",
      "kind" : "other"
    } ]
  }, {
    "InteractionId" : 300100097734217,
    "ParentInteractionId" : 300100096307925,
    "TopLevelFlag" : "false",
    "Description" : "Created through Rest from Omnichannel Scrum-11",
    "ChannelId" : 1,
    "ChannelDisplayName" : "Web (Seeded)",
    "ChannelTypeCd" : "ORA_SVC_WEB",
    "AccountPartyId" : 300100097727798,
    "AccountPartyUniqueName" : "Autorun_CreatedNewTestAccount_2017/03/05 05-49-07",
    "ContactPartyId" : 300100097727803,
    "ContactPartyUniqueName" : "InteractionAutorun_CreatedNewTestContact 2017/03/05 05-49-07",
    "QueueId" : null,
    "QueueName" : null,
    "OwnerResourceId" : 300100075378742,
    "OwnerResourcePartyUniqueName" : "autouisvr1 svc",
    "StartTime" : "2017-03-05T22:38:51-08:00",
    "EndTime" : null,
    "StatusCd" : "ORA_SVC_OPEN",
    "OriginalSystemReference" : null,
    "CreatedBy" : "SALES_ADMIN",
    "CreationDate" : "2017-03-05T22:38:51-08:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-03-05T22:38:51-08:00",
    "LastUpdateLogin" : "49EC867130CA77BBE05307B3F20A2170",
    "DirectionCd" : "ORA_SVC_INBOUND",
    "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/child/childInteractions/300100097734217",
      "name" : "childInteractions",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D626
    ...
  }
...
}

Back to Top