Get internal service request details

get

/api/boss/data/objects/ora/cxServiceCore/helpdesk/v1/$en/internalServiceRequests/$views/requestDetails

Get internal service request details

Request

Query Parameters
  • 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.
  • Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • The resource collection will be queried using the specified filter condition.
  • Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
  • 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.
    Default Value: 25
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
    Default Value: 0
  • Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

Successful response of retrieving view requestDetails for resource Internal Service Requests
Body ()
Root Schema : internalServiceRequests_view-requestDetails
Match All
Get internal service request details
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : internalServiceRequests_view-requestDetails-allOf[1]
Type: object
Get internal service request details
Show Source
Nested Schema : totalItems
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items-allOf[0]
Match All
Show Source
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : items-allOf[0]-allOf[1]
Type: object
Show Source
Nested Schema : items-allOf[1]
Type: object
Nested Schema : $context
Type: object
Show Source
Nested Schema : assigneeResource
Match All
Show Source
Nested Schema : businessUnit
Match All
Show Source
Nested Schema : category
Match All
Show Source
Nested Schema : channelType
Match All
Show Source
Nested Schema : closedDate
Match All
Show Source
Nested Schema : createdBy
Match All
Show Source
  • Read Only: true
    Maximum Length: 64
  • Title: Source System Help Desk Request Created By
    The Help Desk user who created the record.
Nested Schema : createdByParty
Match All
Show Source
Nested Schema : criticalFlag
Match All
Show Source
  • Default Value: false
  • Title: Critical
    Indicates whether the help desk request is critical. If critical, the value is Y, else the value is N.
Nested Schema : firstTransferDate
Match All
Show Source
Nested Schema : installedBaseAsset
Match All
Show Source
Nested Schema : internalPriority
Match All
Show Source
Nested Schema : item
Match All
Show Source
Nested Schema : itemCategory
Match All
Show Source
Nested Schema : lastReopenDate
Match All
Show Source
Nested Schema : lastResolvedDate
Match All
Show Source
Nested Schema : lastTransferDate
Match All
Show Source
Nested Schema : lastTransferredBy
Match All
Show Source
  • Maximum Length: 64
  • Title: Last Transferred By
    The user who last transferred the help desk request.
Nested Schema : lastUpdatedByParty
Match All
Show Source
Nested Schema : openDate
Match All
Show Source
Nested Schema : originalSystemReference
Match All
Show Source
  • Maximum Length: 255
  • Title: Original System
    The reference to the help desk request record in the original system from which service request was imported.
Nested Schema : ownerTypeCd
Match All
Show Source
Nested Schema : primaryContactPerson
Match All
Show Source
Nested Schema : problemDescription
Match All
Show Source
  • Maximum Length: 1000
  • Title: Problem Description
    The help desk request's problem description or statement and the steps to reproduce the issue.
Nested Schema : productGroup
Match All
Show Source
Nested Schema : productItem
Match All
Show Source
Nested Schema : queue
Match All
Show Source
Nested Schema : reportedByParty
Match All
Show Source
Nested Schema : resolution
Match All
Show Source
Nested Schema : resolvedBy
Match All
Show Source
  • Maximum Length: 64
  • Title: Resolved By
    The user who resolved the help desk request.
Nested Schema : resolvedByParty
Match All
Show Source
Nested Schema : resolveDescription
Match All
Show Source
Nested Schema : resolveOutcome
Match All
Show Source
Nested Schema : severity
Match All
Show Source
Nested Schema : srId
Match All
Show Source
Nested Schema : status
Match All
Show Source
Nested Schema : statusTypeCd
Match All
Show Source
Nested Schema : timeCreated
Match All
Show Source
Nested Schema : timeUpdated
Match All
Show Source
  • Read Only: true
  • Title: Last Updated Date
    The date and time when the help desk request was last updated.
Nested Schema : title
Match All
Show Source
  • Maximum Length: 400
  • Title: Title
    The brief title of the help desk request.
Nested Schema : transferCount
Match All
Show Source
Nested Schema : transferNote
Match All
Show Source
  • Maximum Length: 1500
  • Title: Transfer Note
    This field contains information about transfer note.
Nested Schema : transferReason
Match All
Show Source
Nested Schema : updatedBy
Match All
Show Source
Nested Schema : assigneeResource-allOf[1]
Type: object
Show Source
Nested Schema : businessUnit-allOf[1]
Type: object
Show Source
Nested Schema : category-allOf[1]
Type: object
Show Source
Nested Schema : channelType-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : createdByParty-allOf[1]
Type: object
Show Source
Nested Schema : id
Match All
Show Source
Nested Schema : name
Match All
Show Source
  • Read Only: true
  • Title: Party Name
    The name of the party.
Nested Schema : registryId
Match All
Show Source
  • Read Only: true
  • Title: Registry ID
    The public key generated or user-entered for a given party.
Nested Schema : installedBaseAsset-allOf[1]
Type: object
Show Source
  • Title: Asset ID
    Read Only: true
    Unique identifier for an asset, serving as its primary key. It's generated by the system using the Global Unique Identifier generator.
  • Title: Asset Number
    Read Only: true
    Unique number that identifies an asset. An engine pump or a mobile phone may be good examples of assets.
Nested Schema : internalPriority-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : item-allOf[1]
Type: object
Show Source
Nested Schema : description
Match All
Show Source
  • Read Only: true
  • Title: Description
    Description of the part, item, product, or service.
Nested Schema : itemId
Match All
Show Source
  • Read Only: true
  • Title: Item
    Value that uniquely identifies the part, material, product, or service that's unique as compared with other items by the nature of its attributes.
Nested Schema : itemNumber
Match All
Show Source
  • Read Only: true
  • Title: Item Number
    Value that uniquely identifies the part, material, product, or service that's unique when compared with other items by the nature of its attributes.
Nested Schema : organizationId
Match All
Show Source
  • Read Only: true
  • Title: Organization
    Value that uniquely identifies the organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
Nested Schema : itemCategory-allOf[1]
Type: object
Show Source
  • Title: Category Code
    Read Only: true
    Abbreviation that identifies the item category in user interface.
  • Title: Description
    Read Only: true
    Description of the category.
  • Title: Item Category
    Read Only: true
    Value that uniquely identifies the item category. This value should not be used in service calls to create categories in catalogs.
  • Title: Category Name
    Read Only: true
    Name of the category.
Nested Schema : lastUpdatedByParty-allOf[1]
Type: object
Show Source
Nested Schema : id
Match All
Show Source
Nested Schema : name
Match All
Show Source
  • Read Only: true
  • Title: Party Name
    The name of the party.
Nested Schema : registryId
Match All
Show Source
  • Read Only: true
  • Title: Registry ID
    The public key generated or user-entered for a given party.
Nested Schema : ownerTypeCd
Match All
Show Source
Nested Schema : primaryContactPerson-allOf[1]
Type: object
Show Source
Nested Schema : effectiveEndDate
Match All
Show Source
  • Read Only: true
  • Title: Effective End Date
    Effective end date of person detail.
Nested Schema : effectiveStartDate
Match All
Show Source
  • Read Only: true
  • Title: Effective Start Date
    Effective start date of person detail.
Nested Schema : id
Match All
Show Source
Nested Schema : personNumber
Match All
Show Source
  • Read Only: true
  • Title: Person Number
    Person number accessor for person detail.
Nested Schema : productGroup-allOf[1]
Type: object
Show Source
Nested Schema : productItem-allOf[1]
Type: object
Show Source
Nested Schema : queue-allOf[1]
Type: object
Show Source
Nested Schema : reportedByParty-allOf[1]
Type: object
Show Source
Nested Schema : id
Match All
Show Source
Nested Schema : name
Match All
Show Source
  • Read Only: true
  • Title: Party Name
    The name of the party.
Nested Schema : registryId
Match All
Show Source
  • Read Only: true
  • Title: Registry ID
    The public key generated or user-entered for a given party.
Nested Schema : resolution-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : resolvedByParty-allOf[1]
Type: object
Show Source
Nested Schema : id
Match All
Show Source
Nested Schema : name
Match All
Show Source
  • Read Only: true
  • Title: Party Name
    The name of the party.
Nested Schema : registryId
Match All
Show Source
  • Read Only: true
  • Title: Registry ID
    The public key generated or user-entered for a given party.
Nested Schema : resolveOutcome-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : severity-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : status-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Nested Schema : statusTypeCd
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "ORA_SVC_NEW", "ORA_SVC_INPROGRESS", "ORA_SVC_WAITING", "ORA_SVC_RESOLVED", "ORA_SVC_CLOSED" ]
Nested Schema : transferReason-allOf[1]
Type: object
Show Source
Nested Schema : lookupCode
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code ID
    The unique identifier of the Lookup Code.
Nested Schema : lookupType
Match All
Show Source
  • Read Only: true
  • Title: Lookup Type ID
    The unique identifier of the Lookup Type.
Nested Schema : meaning
Match All
Show Source
  • Read Only: true
  • Title: Lookup Code Meaning
    The translated meaning of the Lookup Code.
Back to Top