Jump to

• Request
• Response

Get all service request interactions

get

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences

Request

Path Parameters

• SrId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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:
  
  

  • PrimaryKey :Finds a service request interaction with the specified primary key.
    Finder Variables:
    • ReferenceId :The unique identifier of the interaction reference.
• 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.
  • AccountPartyUniqueName; string; The account name associated with the interaction.
  • ChannelDisplayName; string; The display name of the channel that's populated in the interaction.
  • ChannelId; integer; The unique identifier of the interaction channel.
  • ChannelTypeCd; string; The channel type of the interaction.
  • ContactPartyId; integer; The unique identifier of the contact person with whom the agent is interacting.
  • ContactPartyUniqueName; string; The name of the customer contact for 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 interaction.
  • DirectionCd; string; The direction of the interaction.
  • EndTime; string; The time when the interaction ended.
  • InteractionId; integer; The unique identifier of the interaction.
  • LastUpdateDate; string; The date and time when the interaction was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the interaction.
  • LastUpdatedBy; string; The user who last updated the interaction.
  • OriginalSystemReference; string; The original system reference for the interaction.
  • OwnerResourceId; integer; The unique identifier of the agent who owns the interaction.
  • OwnerResourcePartyUniqueName; string; The resource, which is an internal interaction owner such as a service agent, associated with the interaction.
  • ParentInteractionId; integer; The unique identifier of the parent interaction.
  • QueueId; integer; The unique identifier of the interaction queue.
  • QueueName; string; The name of the queue in the interaction.
  • ReferenceId; integer; The unique identifier of the reference relationship.
  • StartTime; string; The start time of the interaction.
  • StatusCd; string; The interaction status.
  • StripeCd; string; The application stripe of the interaction.
• 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: string
  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: string
  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 : internalServiceRequests-srInteractionReferences

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-srInteractionReferences-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object internalServiceRequests-srInteractionReferences-item-response

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

Type: object

Show Source

• AccountPartyId: integer (int64)
  Title: Account ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 900

  The account name associated with the interaction.
• ChannelDisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 400

  The display name of the channel that's populated in the interaction.
• ChannelId: integer (int64)
  Title: Channel ID

  Read Only: true

  The unique identifier of the interaction channel.
• ChannelTypeCd: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The unique identifier of the contact person with whom the agent is interacting.
• ContactPartyUniqueName: string
  Title: Contact

  Read Only: true

  Maximum Length: 900

  The name of the customer contact for 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
  Title: Can Delete

  Read Only: true

  Indicates whether the record can be deleted.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_INBOUND

  The direction of the interaction.
• EndTime: string (date-time)
  Title: End Time

  Read Only: true

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

  Read Only: true

  The unique identifier of the interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time 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 login of the user who last updated the interaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalSystemReference: string
  Title: Original System

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The unique identifier of the agent who owns the interaction.
• OwnerResourcePartyUniqueName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 900

  The resource, which is an internal interaction owner such as a service agent, associated with the interaction.
• ParentInteractionId: integer (int64)
  Title: Parent Interaction ID

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 400

  The name of the queue in the interaction.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the reference relationship.
• StartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The start time of the interaction.
• StatusCd: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_OPEN

  The interaction status.
• StripeCd: string
  Title: Stripe Code

  Read Only: true

  Maximum Length: 30

  The application stripe of the interaction.
• TopLevelFlag: boolean
  Title: Top Level

  Read Only: true

  Indicates whether the interaction is a top level interaction.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyUniqueName":{
            "title":"Account",
            "maxLength":900,
            "type":"string",
            "description":"The account name associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel that's populated in the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the interaction channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact person with whom the agent is interacting.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyUniqueName":{
            "title":"Contact",
            "maxLength":900,
            "type":"string",
            "description":"The name of the customer contact for the interaction.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The direction of the interaction.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_INBOUND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the interaction ended.",
            "format":"date-time",
            "nullable":true,
            "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time 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 login of the user who last updated the interaction.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The original system reference for the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the agent who owns the interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerResourcePartyUniqueName":{
            "title":"Resource Name",
            "maxLength":900,
            "type":"string",
            "description":"The resource, which is an internal interaction owner such as a service agent, associated with the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentInteractionId":{
            "title":"Parent Interaction ID",
            "type":"integer",
            "description":"The unique identifier of the parent interaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Payload":{
            "title":"Payload",
            "type":"string",
            "description":"The payload of the interaction.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the interaction queue.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QueueName":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the queue in the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the reference relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The start time of the interaction.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The interaction status.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OPEN",
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application stripe of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TopLevelFlag":{
            "title":"Top Level",
            "type":"boolean",
            "description":"Indicates whether the interaction is a top level interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "ExtnMassUpdateable":"false"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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