1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. HR Helpdesk Service Requests

Get a service request

get

/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : hrHelpDeskRequests-item-response
Type: object
Show Source
Nested Schema : Activities
Type: array
Title: Activities
The activities resource is used to view, create, update, and delete an activity.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Message Communications
Type: array
Title: Service Request Message Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Contact Members
Type: array
Title: Contact Members
The list of contacts associated to the serivce request.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The list of service request messages.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
The list of resources associated to the service request.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : Interaction References
Type: array
Title: Interaction References
Indicates the list of interaction references for a service request.
Show Source
Nested Schema : Milestones
Type: array
Title: Milestones
Indicates the milestone associated with the service request.
Show Source
Nested Schema : References
Type: array
Title: References
The list of other objects associated to the service request. E.g. Knowledge articles.
Show Source
Nested Schema : Tags
Type: array
Title: Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.
Show Source
Nested Schema : hrHelpDeskRequests-activities-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-Attachment-item-response
Type: object
Show Source
Nested Schema : AttachmentsDFFVL
Type: array
Show Source
Nested Schema : Attachments Preview
Type: array
Title: Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : hrHelpDeskRequests-Attachment-AttachmentsDFFVL-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-channelCommunication-item-response
Type: object
Show Source
  • Title: Account Name
    Read Only: true
    Maximum Length: 400
    The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
  • Title: Display Name
    Maximum Length: 400
    The display name of the channel.
  • Title: Channel ID
    The unique identifier of the channel.
  • Title: Channel Short Name
    Maximum Length: 450
    The public unique identifier of the channel.
  • Title: Channel Type
    Read Only: true
    Maximum Length: 30
    The code indicating the channel type. For example, email or phone. A list of accepted values are defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
  • Title: Collaboration ID
    Read Only: true
    Maximum Length: 255
    The unique identifier of the collaboration network user in the corresponding network, such as Slack Id.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 400
    The user name of the external user on the collaboration network.
  • Title: Collaboration Resource Identifier
    The unique identifier of the collaboration network user that the internal users are communicating with.
  • Title: Contact Point ID
    The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the communication channel.
  • Title: Creation Date
    Read Only: true
    The date and time when the communication channel was created.
  • Title: Can Delete
    Read Only: true
    Indicates whether the channel communication has been deleted.
  • Title: Inbound Message Object Identifier
    The unique identifier of the inbound object that resulted in the creation of the service request.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the communication channel was last updated.
  • Title: Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the communication channel.
  • Title: Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the communication channel.
  • Links
  • Title: Network
    Read Only: true
    Maximum Length: 30
    The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
  • Title: Object ID
    The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: SVC_SERVICE_REQUESTS
    The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
  • Title: Party ID
    The unique party identifier of the person who's being communicated with.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the person who's being communicated with.
  • Title: Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the contact associated with the service request communication.
  • Title: Party Endpoint
    Maximum Length: 1000
    The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
  • Title: Person ID
    The unique person ID of the contact.
  • Title: Post Identifier
    Maximum Length: 1000
    The unique identifier of the social media post record that was used to create the service request or the service request message.
  • Title: Resource ID
    Read Only: true
    The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
  • Title: Resource Type
    Read Only: true
    Maximum Length: 30
    The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
  • Title: Routing Code
    Maximum Length: 30
    The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
  • Title: Can Update
    Read Only: true
    Indicates whether the channel communication has been updated.
  • Title: ID
    Read Only: true
    The unique identifier of the service request channel communication record.
Nested Schema : hrHelpDeskRequests-contacts-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-messages-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Service Request Message Communications
    Title: Service Request Message Communications
    The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
  • Title: Channel
    The unique identifier of the channel.
  • Title: Channel Type
    Maximum Length: 30
    The channel type, such a email, phone, social, and so on.
  • Title: Collaboration Resource
    The unique identifier of the collaboration network user that the internal users are communicating with.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the message.
  • Title: Created by Email ID
    Read Only: true
    Maximum Length: 320
    The email Id of the person who created the service request message.
  • Title: Created by Party ID
    Read Only: true
    Maximum Length: 80
    The unique party identifier of the person who created the service request message.
  • Title: Creation Date
    Read Only: true
    The date and time when the message was created.
  • Title: Can Delete
    Read Only: true
    Indicates whether the user has access to delete the record.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the message was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the message.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the message.
  • Links
  • Title: Message Content
    The content of the service request message.
  • Title: Created By
    Maximum Length: 64
    The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Message Expand State
    The message expanding state.
  • Title: Message ID
    The unique identifier of the service request message.
  • Title: Last Updated Date
    The date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Last Updated By
    Maximum Length: 64
    The user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Last Update Login
    Maximum Length: 32
    The login of the user who last updated the message in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Message Number
    Maximum Length: 30
    The public unique identifier of the service request message.
  • Title: Message Subtype
    Maximum Length: 30
    The service request message subtype.
  • Title: Message Type Code
    Maximum Length: 30
    The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note.
  • Title: Network
    Read Only: true
    Maximum Length: 30
    The type of social network.
  • Title: Notification Processing Status Code
    Maximum Length: 30
    The notification processing status code.
  • Title: Notification Retry Count
    The notification retry count.
  • Title: Object ID
    The unique identifier of the object.
  • Title: Object Type Code
    Maximum Length: 30
    Default Value: SVC_SR_MESSAGES
    The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
  • Title: Original System
    Maximum Length: 255
    The unique identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.
  • Title: Origination Date
    The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
  • Title: Parent Message ID
    The unique identifier of the parent message.
  • Title: Posted By
    Read Only: true
    Maximum Length: 360
    The party name of the user who posted the message. The user can be an internal resource or a customer contact.
  • Title: Posted by ID
    The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.
  • Title: Posted by Party Number
    Read Only: true
    Maximum Length: 30
    The alternative key for the party identifier of the person posting the service request message.
  • Title: Contains PII Data
    Maximum Length: 1
    Indicates whether the message contains personally identifiable information.
  • Title: Processing ID
    Read Only: true
    The unique identifier of the processing.
  • Title: Processing Status
    Maximum Length: 30
    Default Value: ORA_SVC_READY
    The processing status of the message. The accepted values are Ready, Processing, Error, and Success.
  • Title: Reply to Message ID
    Read Only: true
    The unique identifier of the customer message to which the agent is replying to.
  • Title: Rich Text
    Maximum Length: 1
    Default Value: true
    Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.
  • Title: Root Message Identifier
    Read Only: true
    The identifier of the root message in the message hierarchy.
  • Title: Root Message Thread Count
    Read Only: true
    The number of messages under a root message in a service request.
  • Title: Root Message Thread Last Updated Date
    Read Only: true
    The last updated date for all messages under the root message in a service request.
  • Title: Root Thread Message Last Updated Date
    Read Only: true
    The date when all messages under the root message in a service request were last updated.
  • Title: Sent Date
    The date and time when the message was sent.
  • Title: Private Message
    Maximum Length: 1
    Indicates whether the service request was created from a private social post.
  • Title: Source Code
    Maximum Length: 30
    The source of the message.
  • Title: Service Request Business Unit
    Read Only: true
    The identifier of the business unit associated with the service request.
  • Title: Service Request ID
    The unique identifier of the service request to which the message is associated.
  • Title: Inline Attachment Identifiers
    Maximum Length: 1000
    The list of inline attachment identifiers associated with the service request
  • Title: Service Request Number
    Maximum Length: 30
    The alternative key for the service request number.
  • Title: Service Request Application Stripe
    Read Only: true
    Maximum Length: 30
    The application stripe of the service request.
  • Title: Status Code
    Maximum Length: 30
    The status of the message. The accepted values are Draft, Committed, and Corrected.
  • Title: Subject
    Maximum Length: 1000
    The subject of the service request message.
  • Title: Template Name
    Maximum Length: 240
    The name of the template that's used for outbound communication of the message.
  • Title: Thread Count
    Read Only: true
    The number of threads in a service request message.
  • Title: Thread Hierarchy Level
    Read Only: true
    The thread hierarchy level.
  • Title: Thread Identifier
    Read Only: true
    The unique identifier of the service request message thread.
  • Title: Thread Last Updated Date
    Read Only: true
    The date when the thread was last updated.
  • Title: Thread Message Last Updated Date
    Read Only: true
    The date when the thread message was last updated.
  • Title: Can Update
    Read Only: true
    Indicates whether the user has access to update the record.
  • Title: Visibility Code
    Maximum Length: 30
    The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Message Communications
Type: array
Title: Service Request Message Communications
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : hrHelpDeskRequests-messages-Attachment-item-response
Type: object
Show Source
Nested Schema : AttachmentsDFFVL
Type: array
Show Source
Nested Schema : Attachments Preview
Type: array
Title: Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-messages-channelCommunication-item-response
Type: object
Show Source
  • Title: Account Name
    Read Only: true
    Maximum Length: 400
    The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
  • Title: Display Name
    Maximum Length: 400
    The display name of the channel.
  • Title: Channel ID
    The unique identifier of the channel.
  • Title: Channel Short Name
    Maximum Length: 450
    The public unique identifier of the channel.
  • Title: Channel Type
    Read Only: true
    Maximum Length: 30
    The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
  • Title: Collaboration ID
    Read Only: true
    Maximum Length: 255
    The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id of a user.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 400
    The user name of the external user on the collaboration network.
  • Title: Collaboration Resource Identifier
    The unique identifier of the collaboration network user that the internal users are communicating with.
  • Title: Contact Point ID
    The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address while the contact point of a person for twitter would be the twitter handle.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the communication channel.
  • Title: Creation Date
    Read Only: true
    The date and time when the communication channel was created.
  • Title: Inbound Message Object Identifier
    The unique identifier of the inbound object that resulted in the creation of the service request.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the communication channel was last updated.
  • Title: Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the communication channel.
  • Title: Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the communication channel.
  • Links
  • Title: Message Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the service request message.
  • Title: Network
    Read Only: true
    Maximum Length: 30
    The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
  • Title: Object ID
    The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: SVC_SR_MESSAGES
    The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
  • Title: Party ID
    The unique party identifier of the person who's being communicated with.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the person who's being communicated with.
  • Title: Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the contact associated with the service request message.
  • Title: Party Endpoint
    Maximum Length: 1000
    The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
  • Title: Person ID
    The unique person ID of the contact.
  • Title: Post Identifier
    Maximum Length: 1000
    The unique identifier of the social media post record that was used to create the service request or the service request message.
  • Title: Resource ID
    Read Only: true
    The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
  • Title: Resource Type
    Read Only: true
    Maximum Length: 30
    The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
  • Title: Routing Code
    Maximum Length: 30
    The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
  • Title: ID
    Read Only: true
    The unique identifier of the service request channel communication record.
Nested Schema : hrHelpDeskRequests-resourceMembers-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who added the service request resource member.
  • Title: Creation Date
    Read Only: true
    The date and time when the service request resource member was created.
  • Title: Can Delete
    Read Only: true
    Indicates whether the user has access to delete the record.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the service request resource member record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the service request resource member record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the service request resource member.
  • Links
  • Title: Member ID
    A unique identifier of the service request resource member.
  • Title: Service Request Team Member Resource ID
    The unique identifier of the service request resource member.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_SVC_RESOURCE
    Indicates whether the resource is an individual or a team.
  • Title: Assigned To
    Indicates whether the service request is assigned to the resource member. If yes, the value is True, else the value is False.
  • Title: Unique Party Name
    Read Only: true
    Maximum Length: 900
    The unique name of the service request resource member.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the resource member.
  • Title: Resource Formatted Address
    Read Only: true
    The formatted address of the SR resource member.
  • Title: Phone
    Read Only: true
    The formatted phone number of the resource member.
  • Title: Name
    Maximum Length: 360
    The name of the service request resource member.
  • Title: Resource Number
    Read Only: true
    Maximum Length: 30
    The alternative key for the service request resource.
  • Title: Service Request ID
    The unique identifier of the service request.
  • Title: Service Request Number
    Maximum Length: 30
    The alternative key for the service request number.
  • Title: Can Update
    Read Only: true
    Indicates whether the user has access to update the record.
  • Title: User GUID
    Read Only: true
    Maximum Length: 64
    The global unique identifier of the service request resource member.
  • Title: User ID
    Read Only: true
    The unique user identifier of the service request resource member.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    The user name of the resource member.
Nested Schema : hrHelpDeskRequests-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : hrHelpDeskRequests-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : hrHelpDeskRequests-srInteractionReferences-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-srMilestone-item-response
Type: object
Show Source
Nested Schema : Milestones History
Type: array
Title: Milestones History
The list of changes in the service request milestone status.
Show Source
Nested Schema : hrHelpDeskRequests-srMilestone-SrMilestoneHistory-item-response
Type: object
Show Source
Nested Schema : hrHelpDeskRequests-srReferences-item-response
Type: object
Show Source
  • Title: Article ID
    Maximum Length: 64
    The unique identifier of the referenced article.
  • Title: Article Locale
    Maximum Length: 10
    The locale of the knowledge management article.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who added the reference to the service request.
  • Title: Creation Date
    Read Only: true
    The date and time when the service request reference was created.
  • Title: Can Delete
    Read Only: true
    Indicates whether the user has access to delete the record.
  • Title: Document ID
    Read Only: true
    Maximum Length: 50
    The unique document identifier associated with the referenced article.
  • Title: Helpful
    Maximum Length: 1
    Indicates whether the service request reference was helpful.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the service request reference.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login ID of the user who last updated the service request reference.
  • Title: Linked
    Maximum Length: 1
    Indicates whether the reference is linked with the service request.
  • Links
  • Title: Object ID
    Indicates whether the object is referenced to the service request.
  • Title: Object Type
    Maximum Length: 30
    The object type of the reference object.
  • Title: Reference ID
    Read Only: true
    The unique identifier of the current reference record.
  • Title: Relation Type
    Maximum Length: 30
    The relationship type between the service request and the referenced object.
  • Title: Resolution Code
    Maximum Length: 30
    Indicates whether the referenced object helps in resolving the service request.
  • Title: Shared
    Maximum Length: 1
    Indicates whether the service request reference is shared with the customer.
  • Title: Service Request ID
    The unique identifier of the service request.
  • Title: Service Request Number
    Maximum Length: 30
    The alternative key for the service request number.
  • Title: Title
    Maximum Length: 1000
    The title of the referenced object.
  • Title: Can Update
    Read Only: true
    Indicates whether the user has access to update the record
Nested Schema : hrHelpDeskRequests-srTags-item-response
Type: object
Show Source
Links
Attachment
Parameters:
  • SrId: $request.path.SrId
The attachments resource is used to view, create, and update attachments.
BusinessUnitsLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: BUOrgId; Target Attribute: BusinessUnitId
  • Display Attribute: Name
ChannelLOV
Parameters:
  • finder: EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{StripeCd}%2CBUOrgId%3D{BUOrgId}
The following properties are defined on the LOV link relation:
  • Source Attribute: ChannelId; Target Attribute: ChannelId
  • Display Attribute: DisplayName, ChannelTypeCd, BusinessUnitName, StripeCd
ChannelTypeCdLookup
Parameters:
  • finder: IsActiveIsEnabledFinder
The following properties are defined on the LOV link relation:
  • Source Attribute: ChannelTypeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
GeographyLovPVO
The following properties are defined on the LOV link relation:
  • Source Attribute: ServiceZoneId; Target Attribute: GeographyId
  • Display Attribute: GeographyId
InternalPriorityLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_INT_PRIORITY_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: InternalPriorityCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
LanguageCdLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: LanguageCd; Target Attribute: LanguageCode
  • Display Attribute: LanguageCode, Description
NetworkTypeCdLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: NetworkTypeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
OwnerTypeCdLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_OWNER_TYPE_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: OwnerTypeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
ProblemCdLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_PROBLEM_TYPE_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: ProblemCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
ProductGroupLOV_HCM
The following properties are defined on the LOV link relation:
  • Source Attribute: ProdGroupName; Target Attribute: ProdGroupName
  • Display Attribute: ProdGroupName, ProdGroupDescTxt, UsageName
ProductInventoryItemLOV_HCM
The following properties are defined on the LOV link relation:
  • Source Attribute: ProductItemDescription; Target Attribute: Description
  • Display Attribute: Description, ItemNumber, ProdGroupName, UsageName
QueueVO
Parameters:
  • finder: QueueEnabledFinder
The following properties are defined on the LOV link relation:
  • Source Attribute: QueueName; Target Attribute: QueueName
  • Display Attribute: QueueName
ResolutionCdLookupHRHD
Parameters:
  • finder: SrResolutionCdFinderHRHD%3BBindChildLookupType%3DORA_SVC_HRHD_RESOLUTION_CD%2CBindParentLookupType%3DORA_SVC_HRHD_RESOLVE_OUTCOME%2CBindParentLookupCode%3D{ResolveOutcomeCd}
The following properties are defined on the LOV link relation:
  • Source Attribute: ResolutionCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
ResolveOutcomeCdLookupHRHD
The following properties are defined on the LOV link relation:
  • Source Attribute: ResolveOutcomeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
ResourcePickerLOV
The following properties are defined on the LOV link relation:
  • Source Attribute: AssigneePersonName; Target Attribute: PartyName
  • Display Attribute: PartyName, EmailAddress
SearchFilterLookupPVO
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_SEARCH_REC_SET_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: RecordSet; Target Attribute: LookupCode
  • Display Attribute: Meaning
SeverityCdLookupHRHD
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_HRHD_SEVERITY_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: SeverityCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
SourceCdLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: SourceCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
SrCategoryLOV
Parameters:
  • finder: CategoryEnabledFinder
The following properties are defined on the LOV link relation:
  • Source Attribute: CategoryId; Target Attribute: CategoryId
  • Display Attribute: CategoryName, CategoryShortName, BusinessUnitName, StripeCd
SrStatusCdLookupHRHD
Parameters:
  • finder: IsEnabledFinder%3BBindChildLookupType%3DORA_SVC_HRHD_STATUS_CD%2CBindParentLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
StatusTypeLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_STATUS_TYPE_CD
The following properties are defined on the LOV link relation:
  • Source Attribute: StatusTypeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
TimezoneVO
Parameters:
  • finder: EnabledFinder
The following properties are defined on the LOV link relation:
  • Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
  • Display Attribute: TimezoneCode
TransferReasonCdLookupHRHD
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_HRHD_TRANSFER_REASON
The following properties are defined on the LOV link relation:
  • Source Attribute: TransferReasonCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
YesNoLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:
  • Source Attribute: CriticalFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
activities
Parameters:
  • SrId: $request.path.SrId
The activities resource is used to view, create, update, and delete an activity.
channelCommunication
Parameters:
  • SrId: $request.path.SrId
The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
contacts
Parameters:
  • SrId: $request.path.SrId
The list of contacts associated to the serivce request.
getSrMilestoneDiagnostics
Parameters:
  • SrId: $request.path.SrId
Evaluates service request and applies any required changes to its milestones.
messages
Parameters:
  • SrId: $request.path.SrId
The list of service request messages.
processSrMilestones
Parameters:
  • SrId: $request.path.SrId
Returns the service request milestone diagnostics report results for the specified service request.
resourceMembers
Parameters:
  • SrId: $request.path.SrId
The list of resources associated to the service request.
sendEmailForSrMessage
Parameters:
  • SrId: $request.path.SrId
This method lets you send an email to the recipients of the service request message for the specified message identifier.
smartActions
Parameters:
  • SrId: $request.path.SrId
This VO stores the endpoint and security details for every user action.
srInteractionReferences
Parameters:
  • SrId: $request.path.SrId
Indicates the list of interaction references for a service request.
srMilestone
Parameters:
  • SrId: $request.path.SrId
Indicates the milestone associated with the service request.
srReferences
Parameters:
  • SrId: $request.path.SrId
The list of other objects associated to the service request. E.g. Knowledge articles.
srTags
Parameters:
  • SrId: $request.path.SrId
The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.
Back to Top