Get a case with resources using advanced query
post
/api/boss/data/objects/ora/cxServiceCore/case/v1:1072/$en/cases/$views/resources/$query
Case resources are individuals assigned to or associated with the case who participate in managing, reviewing, investigating, or resolving the case.
Request
Query Parameters
-
$effectiveDate: string(date)
Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object-
accessors: object
accessors
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
-
fields: array
fields
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
-
subTypes: object
subTypes
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : type
Type:
Show Source
object-
collection: object
collection
Defines query criteria that can be applied on a resource collection.
Nested Schema : type
Type:
Show Source
object-
parameters: object
parameters
Values to be applied in a parameterized filter specific to the view.
Nested Schema : accessors
Type:
objectMaps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type:
arrayRestricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type:
objectMaps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : collection
Type:
objectDefines query criteria that can be applied on a resource collection.
Show Source
-
filter: string
The resource collection will be queried using the specified filter condition.
-
includeTotalItems: boolean
Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
-
limit: integer
Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
-
offset: integer
Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
-
privilege: string
Represents the privilege or action required to check for while serving a request to access a resource.
-
sortBy: array
sortBy
Orders a resource collection based on the specified fields.
Nested Schema : sortBy
Type:
arrayOrders a resource collection based on the specified fields.
Show Source
Nested Schema : type
Type:
objectObject with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.
Nested Schema : parameters
Type:
objectValues to be applied in a parameterized filter specific to the view.
Response
Default Response
Successful response of retrieving view resources for resource Cases
Root Schema : cases_view-resources
Match All
Case resources are individuals assigned to or associated with the case who participate in managing, reviewing, investigating, or resolving the case.
Show Source
-
object
__collection_context
-
object
cases_view-resources-allOf[1]
Case resources are individuals assigned to or associated with the case who participate in managing, reviewing, investigating, or resolving the case.
Nested Schema : cases_view-resources-allOf[1]
Type:
objectCase resources are individuals assigned to or associated with the case who participate in managing, reviewing, investigating, or resolving the case.
Show Source
Nested Schema : totalItems
Type:
Show Source
object-
qualifier: string
Allowed Values:
[ "eq", "gt", "est", "err" ] -
value: integer
Nested Schema : items-allOf[1]
Type:
Show Source
object-
caseId: string
(big-integer)
Title:
Case IDRead Only:trueThe unique identifier of the case. -
caseNumber: string
Title:
Case NumberRead Only:trueMaximum Length:30The unique number that's used to identify a case. You can edit the case number to a format that's best suitable to your requirements. -
closedDate: string
(date-time)
Title:
Closed DateRead Only:trueThe date and time when the case was closed, if it was closed. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the case. -
description: string
Title:
DescriptionMaximum Length:1000The description or statement of the case. -
lastClosedDate: string
(date-time)
Title:
Last Closed DateRead Only:trueThe last closed date for case, if the case was closed and then reopened. -
lastReopenDate: string
(date-time)
Title:
Last Reopen DateRead Only:trueThe date and time when the case was last reopened. -
lastResolvedDate: string
(date-time)
Title:
Last Resolved DateRead Only:trueThe date and time when the case was resolved. -
openDate: string
(date-time)
Title:
Open DateThe date and time the case was opened, if it was approved. -
parentCaseNumber: string
Title:
Parent Case NumberRead Only:trueMaximum Length:30Indicates the parent case number of the case. -
resolvedBy: string
Title:
Resolved ByRead Only:trueMaximum Length:64The user who resolved the case. -
resolveDescription: string
Title:
Resolution DescriptionRead Only:trueMaximum Length:3000The description of how a case was resolved. -
resources:
resources
-
statusTypeCd:
statusTypeCd
-
stripeCd:
stripeCd
-
timeCreated: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the case was created. -
timeUpdated: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the case was last updated. -
title: string
Title:
TitleMaximum Length:400A brief title of the case. -
updatedBy: string
Title:
Last Updated ByRead Only:trueThe user who last updated the case.
Nested Schema : items-allOf[1]
Type:
Show Source
object-
caseResourceId: string
(big-integer)
Title:
Resource IDRead Only:trueThe unique identifier of the case resource. -
corporateCurrencyCode: string
Title:
Corporate Currency CodeRead Only:trueMaximum Length:15The public unique identifier of the corporate currency code associated with the case. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource for the case. -
currencyCode: string
Title:
Currency CodeRead Only:trueMaximum Length:15The public unique identifier of the currency code associated with the case. -
currencyConversionRateType: string
Title:
Currency Conversion Rate TypeRead Only:trueMaximum Length:30The corporate currency conversion rate type of the case. -
party:
party
-
timeCreated: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time of the creation of the resource for the case. -
timeUpdated: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the resource for the case was last updated. -
updatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource for the case.
Nested Schema : party-allOf[1]
Type:
Show Source
object-
emailAddress: string
(email)
Title:
EmailRead Only:trueThe email address. -
id: string
(big-integer)
Title:
Resource Profile IDRead Only:trueThe unique identifier of the resource profile. -
name: string
Title:
Person NameRead Only:trueThe combination of title, first, middle, last, and suffix names of the resource. -
partyId: string
(big-integer)
Title:
Party IDRead Only:trueThe unique identifier of the party associated to the resource profile. -
phoneNumber: string
Title:
PhoneRead Only:trueThe phone number. -
registryId: string
Title:
Registry IDRead Only:trueThe alternate unique identifier of the party.