kustomer-client
Preparing search index...
KustomerApi
getKlassesByNameAndExternalId
Function getKlassesByNameAndExternalId
getKlassesByNameAndExternalId
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
GetKlassesByNameAndExternalIdData
,
ThrowOnError
>
,
)
:
RequestResult
<
{
data
:
{
attributes
:
{
assignedUser
?:
string
;
createdAt
:
string
;
custom
:
{
billingStatusStr
:
string
;
orderDescriptionStr
:
string
;
orderNumberNum
:
number
;
orderStatusStr
:
string
;
orderUpdatedAt
:
string
;
shippingStatusStr
:
string
;
specialInstructionsStr
:
string
;
totalPriceNum
:
number
;
}
;
doneCount
?:
number
;
firstDone
?:
{
assignedTeam
?:
string
;
assignedUser
?:
string
;
businessTime
?:
number
;
commentCount
?:
number
;
createdAt
?:
string
;
createdBy
?:
string
;
createdByTeam
?:
string
;
time
?:
number
;
}
;
icon
:
string
;
images
:
string
[]
;
lastDone
?:
{
assignedTeam
?:
string
;
assignedUser
?:
string
;
businessTime
?:
number
;
commentCount
?:
number
;
createdAt
?:
string
;
createdBy
?:
string
;
createdByTeam
?:
string
;
time
?:
number
;
}
;
queue
?:
string
;
reopenCount
?:
number
;
reopenFromDoneCount
?:
number
;
rev
:
number
;
status
?:
"open"
|
"done"
;
tags
:
unknown
[]
;
title
:
string
;
updatedAt
:
string
;
}
;
id
:
string
;
links
:
{
self
:
string
}
;
relationships
:
{
klass
:
{
data
:
{
id
:
string
;
type
:
string
}
;
link
:
{
self
:
string
}
}
;
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Get KObject by external ID Retrieve KObject by name and unique external ID.
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
GetKlassesByNameAndExternalIdData
,
ThrowOnError
>
Returns
RequestResult
<
{
data
:
{
attributes
:
{
assignedUser
?:
string
;
createdAt
:
string
;
custom
:
{
billingStatusStr
:
string
;
orderDescriptionStr
:
string
;
orderNumberNum
:
number
;
orderStatusStr
:
string
;
orderUpdatedAt
:
string
;
shippingStatusStr
:
string
;
specialInstructionsStr
:
string
;
totalPriceNum
:
number
;
}
;
doneCount
?:
number
;
firstDone
?:
{
assignedTeam
?:
string
;
assignedUser
?:
string
;
businessTime
?:
number
;
commentCount
?:
number
;
createdAt
?:
string
;
createdBy
?:
string
;
createdByTeam
?:
string
;
time
?:
number
;
}
;
icon
:
string
;
images
:
string
[]
;
lastDone
?:
{
assignedTeam
?:
string
;
assignedUser
?:
string
;
businessTime
?:
number
;
commentCount
?:
number
;
createdAt
?:
string
;
createdBy
?:
string
;
createdByTeam
?:
string
;
time
?:
number
;
}
;
queue
?:
string
;
reopenCount
?:
number
;
reopenFromDoneCount
?:
number
;
rev
:
number
;
status
?:
"open"
|
"done"
;
tags
:
unknown
[]
;
title
:
string
;
updatedAt
:
string
;
}
;
id
:
string
;
links
:
{
self
:
string
}
;
relationships
:
{
klass
:
{
data
:
{
id
:
string
;
type
:
string
}
;
link
:
{
self
:
string
}
}
;
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
kustomer-client
Loading...
Get KObject by external ID Retrieve KObject by name and unique external ID.