Get a service request

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}

Request

Path Parameters
  • The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
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 : serviceRequests-item-response
Type: object
Show Source
  • Title: Account Party Email Address
    Read Only: true
    Maximum Length: 320
    The e-mail address of the account on the service request.
  • Title: Account Party Formatted Phone Number
    Read Only: true
    The formatted phone number of the account on the service request.
  • Title: Account ID
    The unique identifier of the account party associated with the service request.
  • Title: Account Name
    Read Only: true
    Maximum Length: 360
    The name of the account party.
  • Title: Account Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the account associated with the service request.
  • Title: Account Party Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred contact method of the account on the service request.
  • Title: Account
    Maximum Length: 900
    The unique name to identify the account.
  • Activities
    Title: Activities
    The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
  • Service Addresses
    Title: Service Addresses
    A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.
  • Title: Affected Party Person Assignment Number
    Maximum Length: 50
    The unique assignment number of the affected party person for the service request.
  • Title: Affected Party
    The unique identifier of the affected person on the service request. This field is only applicable for the human resource help desk application.
  • Title: Affected Party Person Name
    Read Only: true
    The display name of the affected party person in the service request.
  • Title: Asset
    The unique identifier of the asset associated with the service request.
  • Title: Asset Number
    Maximum Length: 100
    The asset number associated with the service request.
  • Title: Asset Serial Number
    Read Only: true
    Maximum Length: 100
    The serial number of the asset that is associated with the service request.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the assignee.
  • Title: Assignee Formatted Address
    Read Only: true
    The formatted address of the service request assignee.
  • Title: Assignee Phone
    Read Only: true
    The phone number of the resource to whom the service request is assigned.
  • Title: Assigned to Party ID
    Read Only: true
    The unique identifier of the party object associated with the service request assignee.
  • Title: Assigned To
    Maximum Length: 360
    The name of the assignee.
  • Title: Assigned to Resource ID
    The foreign key of the party object associated with the service request assignee.
  • Title: Assigned to Resource Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the assignee of the service request.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
  • Title: Bill-To Customer Account Description
    Read Only: true
    Maximum Length: 240
    The description of the customer account to be billed for work performed on the service request.
  • Title: Bill to Customer Account ID
    The customer account to be billed for work performed on the service request.
  • Title: Bill-To Customer Account Number
    Read Only: true
    Maximum Length: 30
    The PUID for the customer account to be billed for work performed on the service request.
  • Title: Bill to Customer Account Site ID
    The customer account site to be billed for work performed on the service request.
  • Title: Bill-To Customer Account Site Usage Number
    Maximum Length: 255
    The PUID for the customer account site bill-to usage.
  • Title: Bill to Customer ID
    The customer to be billed for work performed on the service request.
  • Title: Bill-To Customer Name
    Read Only: true
    Maximum Length: 360
    The name of the customer to be billed for work performed on the service request.
  • Title: Bill-To Customer Number
    Read Only: true
    Maximum Length: 30
    The PUID for the customer to be billed for work performed on the service request.
  • Title: Bill-To Party Site Formatted Address
    Maximum Length: 5000
    The formatted address for the customer site to be billed for work performed on the service request.
  • Title: Bill-To Party Site ID
    The address of the customer site to be billed for work performed on the service request.
  • Title: Bill-To Party Site Location ID
    Read Only: true
    The location of the customer site to be billed for work performed on the service request.
  • Title: Bill-To Party Site Name
    Read Only: true
    Maximum Length: 240
    The name of the customer site to be billed for work performed on the service request.
  • Title: Bill-To Party Site Number
    Read Only: true
    Maximum Length: 30
    The PUID for the customer site to be billed for work performed on the service request.
  • Title: Business Unit
    The unique identifier of the business unit associated with the service request.
  • Title: Business Unit Name
    Read Only: true
    Maximum Length: 255
    The name of the business unit associated with the service request.
  • Title: Case ID
    The unique identifier of the case associated with the service request.
  • Title: Case Number
    Maximum Length: 255
    The public unique identifier of the case associated with the service request.
  • Title: Category Code
    Read Only: true
    Maximum Length: 290
    Indicates the alternate key of the category associated to the service request.
  • Title: Category
    The unique identifier of the service request category.
  • Title: Category Name
    Read Only: true
    Maximum Length: 400
    The name of the category associated with the service request.
  • Channel Communications
    Title: Channel Communications
    The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
  • Title: Channel
    The unique identifier of the service request channel.
  • Title: Channel Type
    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: Channel Type Value
    Read Only: true
    Maximum Length: 255
    The display value of the channel type lookup code for the service request, such as Chat, Phone, or Email.
  • Title: Date Closed
    The date when the service request was closed (if closed).
  • Title: Compliance
    Read Only: true
    Maximum Length: 1
    Indicates whether the milestone is compliant or not. The default value is true.
  • Contact Members
    Title: Contact Members
    The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the service request.
  • Title: Creation Date
    Read Only: true
    The date and time when the service request was created.
  • Title: Critical
    Maximum Length: 1
    Default Value: false
    Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the service request. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA.
  • Title: Can Delete
    Read Only: true
    Indicates whether a service request is deleted and not to be displayed in the UI. The default value is false.
  • Title: Due Date
    Read Only: true
    The date when the milestone is due.
  • Title: First Transfer Date
    The date when the service request was first transferred.
  • Title: Header
    Read Only: true
    Maximum Length: 1
    Indicates whether the milestone is a service request header milestone or not.
  • Title: Installed Base Asset Description
    Read Only: true
    Maximum Length: 240
    The description of the installed base asset associated with the service request.
  • Title: Installed Base Asset ID
    The unique identifier of the install base asset associated with the service request.
  • Title: Installed Base Asset Location
    Maximum Length: 5000
    The location address of the installed base asset associated with the service request.
  • Title: Installed Base Asset Location Type
    Read Only: true
    Maximum Length: 80
    The location type of the installed base asset associated with the service request.
  • Title: Installed Base Asset Number
    Read Only: true
    Maximum Length: 80
    The installed base asset number associated with the service request.
  • Title: Installed Base Asset Serial Number
    Read Only: true
    Maximum Length: 80
    The serial number of the install base asset associated with the service request.
  • Title: Internal Priority Code
    Maximum Length: 30
    The code indicating the internal priority of the service request. For example, High, Normal, Low, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_INT_PRIORITY_CD.
  • Title: Inventory Item ID
    The unique identifier of the product associated with the service request.
  • Title: Inventory Organization ID
    The unique identifier of the organization of the product that is associated with the service request.
  • Title: Language Code
    Maximum Length: 30
    The code indicating the customer's preferred language for the service request. For example, en, fr, and so on.
  • Title: Date Reopened
    The date and time when the service request was last reopened.
  • Title: Resolution Date
    The date and time when the service request was last resolved.
  • Title: Last Transfer Date
    Indicates the date and time of the last transfer of the service request.
  • Title: Last Transferred By
    Maximum Length: 64
    The user who last transferred the service request.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the service request was last updated.
  • Title: Last Updated by Login ID
    Read Only: true
    Maximum Length: 64
    The user who last updated the service request.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 3600
    The display name of the user who last update the service request.
  • Title: Last Updated by Email Address
    Read Only: true
    Maximum Length: 255
    The e-mail address of the person who last updated the service request.
  • Title: Last Updated by Party ID
    The unique identifier of the party of the user who last updated the service request.
  • Title: Last Updated by Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the person who last updated the service request.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The application login id of the user who last updated the service request.
  • Links
  • Title: Loyalty Member
    The unique identifier of the loyalty member associated with the customer contact.
  • Title: Loyalty Member
    Maximum Length: 100
    The name of the loyalty member associated with the customer contact.
  • Title: Loyalty Member Number
    Read Only: true
    Maximum Length: 30
    The public unique loyalty member identifier of the service request primary contact.
  • Messages
    Title: Messages
    The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
  • Title: Configuration ID
    Read Only: true
    The unique identifier of the milestone configuration.
  • Title: Milestone Name
    Read Only: true
    Maximum Length: 255
    The display name of the milestone.
  • Title: Milestone Status
    Read Only: true
    Maximum Length: 255
    The code indicating the status of the milestone. For example, In Progress, Complete. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.
  • 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: Date Reported
    The date when the service request was reported by the customer. Typically, the value is the same as Creation Date. However, if the service request was migrated from another system then the Creation Date is the date the SR was created and Date Reported is the date the customer reported the service request.
  • Title: Original System
    Maximum Length: 255
    The reference to the service request record in the original system from which service request was imported (if imported).
  • Title: Owner Type
    Maximum Length: 30
    The code indicating the type of the service request owner. For example, a customer or a partner.
  • Title: Partner Account Party ID
    The unique identifier of the partner account party.
  • Title: Partner Account
    Maximum Length: 360
    The name of the partner account party. Two accounts can have the same party name but not the same unique name.
  • Title: Partner Account Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the partner account associated with the service request.
  • Title: Partner Account
    Maximum Length: 900
    The unique name to identify the partner account.
  • Title: Primary Contact Person Assignment Number
    Maximum Length: 50
    The unique assignment number of the primary contact of the service request.
  • Title: Primary Contact Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates that the primary contact of the service request does not want to be contacted. The default value is false.
  • Title: Primary Contact Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the primary contact associated with the service request.
  • Title: Primary Contact Formatted Address
    Read Only: true
    The formatted address of the primary contact of the service request.
  • Title: Primary Contact Phone
    Read Only: true
    The phone number of the primary contact.
  • Title: Primary Contact ID
    The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.
  • Title: Primary Contact
    Maximum Length: 360
    The name of the service request primary contact.
  • Title: Primary Contact Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the primary contact associated of the service request.
  • Title: Primary Contact Unique Name
    Maximum Length: 900
    The unique party name associated with the primary contact.
  • Title: Primary Contact Person ID
    The identifier of the primary contact person of the service request. This field is only applicable for the human resource help desk application.
  • Title: Primary Contact Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred contact method of the primary contact of the service request.
  • Title: Problem Type Code
    Maximum Length: 30
    The code indicating the problem with a service request. A list of accepted values is defined in the lookup: ORA_SVC_SR_PROBLEM_TYPE_CD. For example, ORA_SVC_DOCS, ORA_SVC_PRODUCT.
  • Title: Problem Description
    Maximum Length: 1000
    The service request's problem description/statement and the steps to reproduce the issue.
  • Title: Product Group ID
    The unique identifier of the product group associated with the service request.
  • Title: Product Group
    Maximum Length: 255
    The name of the product group associated with the service request.
  • Title: Product Group Reference Number
    The public unique identifier of the product associated with the service request.
  • Title: Product Description
    Maximum Length: 255
    The description of the product associated with the service request.
  • Title: Product Number
    Read Only: true
    Maximum Length: 255
    The alternate key identifier of the product associated with the service request.
  • Title: Product Organization
    Read Only: true
    The unique identifier of the organization of the product that is associated with the service request.
  • Title: Purchase Order
    Maximum Length: 50
    The purchase order associated with the service request.
  • Title: Assigned Queue ID
    The unique identifier of the queue to which the service request is assigned.
  • Title: Queue
    Maximum Length: 400
    The name of the queue associated with the service request.
  • Title: Queue Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the service request queue.
  • Title: Search Filter
    Read Only: true
    The record set selected by the user. The selected record set is used to filter the search results.
  • Title: Reported by Email ID
    Read Only: true
    Maximum Length: 320
    The e-mail address of the person who reported the service request.
  • Title: Reported by Phone Number
    Read Only: true
    The formatted phone number of the person who reported the service request.
  • Title: Reported by Party ID
    The user who created the service request in the system.
  • Title: Reported By
    Read Only: true
    Maximum Length: 360
    The person who reported the service request.
  • Title: Reported by Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the person who reported the service request.
  • Title: Reported by Unique Name
    Read Only: true
    Maximum Length: 900
    The unique name of the user who created the service request.
  • Title: Resolution Code
    Maximum Length: 30
    The code indicating the type of resolution of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
  • Title: Resolution Value
    Read Only: true
    The display value of the resolution lookup code for the service request, such as Satisfied.
  • Title: Resolved By
    Maximum Length: 64
    The name of the person who initiated the resolution process.
  • Title: Solution Description
    Maximum Length: 1000
    A brief description of how the problem was resolved.
  • Title: Outcome
    Maximum Length: 30
    The code indicating the type of resolution that was achieved for the Service Request.
  • Title: Outcome Value
    Read Only: true
    The display value of the resolution outcome lookup code for the service request, such as Solution Provided.
  • Resources
    Title: Resources
    Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
  • Title: Service Profile ID
    The service profile associated with the service request.
  • Title: Service Profile Name
    Read Only: true
    Maximum Length: 400
    The name of the service profile associated with the service request.
  • Title: Service Profile Number
    Read Only: true
    Maximum Length: 30
    The PUID for the service profile associated with the service request.
  • Title: Service Profile Site ID
    Read Only: true
    The address of the service profile associated with the service request.
  • Title: Service Profile Site Location ID
    Read Only: true
    The location of the service profile associated with the service request.
  • Title: Service Profile Site Party Name
    Read Only: true
    Maximum Length: 240
    The name of the address of the service profile associated with the service request.
  • Title: Service Profile Site Party Number
    Read Only: true
    Maximum Length: 30
    The PUID of the address of the service profile associated with the service request.
  • Title: Service Profile Formatted Address
    Maximum Length: 5000
    The formatted address of the service profile associated with the service request.
  • Title: Region Identifier
    The unique identifier of the service request region.
  • Title: Service Region
    Read Only: true
    Maximum Length: 360
    The name of the service request region.
  • Title: Severity
    Maximum Length: 30
    The code indicating the severity of the service request. For example, Sev1, Sev2, Sev3, and Sev4.
  • Title: Severity Value
    Read Only: true
    The display value of the severity lookup code for the service request, such as High.
  • Title: Severity Color Code
    Read Only: true
    The code indicating the color code for the service request severity.
  • Title: Severity Rank
    Read Only: true
    The code indicating the severity of the service request.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Private Social Post
    Maximum Length: 1
    Default Value: false
    Indicates if the service request was created from a private social post. The default value is false.
  • Title: Source Code
    Maximum Length: 30
    The code indicating how the service request was created in the application. For example, Agent_UI, Customer_UI, API, and so on. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD .
  • Title: Source System SR Created By
    Maximum Length: 64
    The user who created the service request.
  • Title: Service Request ID
    Read Only: true
    The unique identifier of the service request record.
  • Interaction References
    Title: Interaction References
    The interaction references resource is used to view the relationship between an interaction and a service request.
  • Title: Last Update Date in Source System
    The date and time when the service request was last updated.
  • Title: Source System SR Last Updated By
    Maximum Length: 64
    The user who last updated the service request. It defaults to LAST_UPDATED_BY if null, or for migration, set to the user who last updated the row.
  • Title: Source System SR Last Updated by User Login ID
    Maximum Length: 32
    The application login id of the user who last updated the service request.
  • Milestones
    Title: Milestones
    The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
  • Title: Milestone ID
    Read Only: true
    The unique identifier of the milestone associated with the service request.
  • Title: Reference Number
    Maximum Length: 30
    The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
  • Service Request References
    Title: Service Request References
    The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
  • Tags
    Title: Tags
    The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the service request. For example, New, InProgress, Waiting, Resolved, Closed, and so on.
  • Title: Status Value
    Read Only: true
    The display value of the status lookup code for the service request, such as New, or In-Progress.
  • Title: Status Type
    Read Only: true
    Maximum Length: 30
    The code indicating the status type of the service request. The possible values are, New, In Progress, Waiting, Resolved, and Closed.
  • Title: Status Type Value
    Read Only: true
    The display value of the status type lookup code for the service request, such as New, or Resolved.
  • Title: Stripe Code
    Maximum Length: 30
    The application stripe of the service request.
  • Title: Survey Response Date
    Read Only: true
    The date and time when the response to this survey was submitted to the survey vendor.
  • Title: Survey Sent Date
    Read Only: true
    The date and time when survey was last sent for this service request.
  • Title: Time Remaining
    Read Only: true
    The time remaining in the milestone.
  • Title: Time Zone Code
    Maximum Length: 50
    The service request time zone optionally used for computing the milestone due date.
  • Title: Title
    Maximum Length: 400
    A brief title of the service request.
  • Title: Transfer Count
    The count showing how many times a service request has been transferred.
  • Title: Transfer Note
    Maximum Length: 1500
    This field contains information about transfer note.
  • Title: Transfer Reason
    Maximum Length: 30
    The lookup code that indicates the transfer reason.
  • Title: Unique External System Reference Number
    Maximum Length: 255
    The unique alternative identifier of the service request in the original reference system. You can this column to store the identifier of the service request in the external application you're integrating with.
  • Title: Can Update
    Read Only: true
    Indicates if the service request has been updated.
  • Title: Warned
    Read Only: true
    Maximum Length: 1
    Indicates that the milestone passed the warning threshold.
Nested Schema : Activities
Type: array
Title: Activities
The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
Show Source
Nested Schema : Service Addresses
Type: array
Title: Service Addresses
A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
Show Source
Nested Schema : Channel Communications
Type: array
Title: Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Contact Members
Type: array
Title: Contact Members
The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
Show Source
Nested Schema : Resources
Type: array
Title: Resources
Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Interaction References
Type: array
Title: Interaction References
The interaction references resource is used to view the relationship between an interaction and a service request.
Show Source
Nested Schema : Milestones
Type: array
Title: Milestones
The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
Show Source
Nested Schema : Service Request References
Type: array
Title: Service Request References
The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
Show Source
Nested Schema : Tags
Type: array
Title: Tags
The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.
Show Source
Nested Schema : serviceRequests-activities-item-response
Type: object
Show Source
Nested Schema : serviceRequests-addresses-item-response
Type: object
Show Source
Nested Schema : serviceRequests-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 : serviceRequests-Attachment-AttachmentsDFFVL-item-response
Type: object
Show Source
Nested Schema : serviceRequests-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : serviceRequests-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, an account name would be the inbound mailbox for support like support@abc.com.
  • 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 is 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 and 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: Can Delete
    Read Only: true
    Indicates if the channel communication has been updated.
  • Title: Inbound Message Object Identifier
    The unique identifier of the inbound object that resulted in the creation of the service request message.
  • 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 is being communicated with.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.
  • 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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
  • Title: Person ID
    The unique identifier of the person who is a contact on the service request.
  • 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
  • Title: Can Update
    Read Only: true
    Indicates if the channel communication has been deleted.
  • Title: ID
    Read Only: true
    The unique identifier of the channel communication.
Nested Schema : serviceRequests-contacts-item-response
Type: object
Show Source
  • Title: Access Level
    Maximum Length: 30
    The service request access level granted to the contact.
  • Title: Account Name
    Read Only: true
    Maximum Length: 900
    The primary account of the service request contact.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the party associated with the contact.
  • Title: Phone
    Read Only: true
    The formatted phone number of the party associated with the contact.
  • Title: Name
    Maximum Length: 360
    The name of a service request contact.
  • Title: Contact Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the contact associated with the service request.
  • Title: Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred contact method of the party associated with the contact.
  • Title: Contact Type
    Maximum Length: 30
    The service request contact type such as Customer or Partner.
  • Title: Unique Name
    Maximum Length: 900
    The unique party name associated with the contact.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Can Delete
    Read Only: true
    Indicates if the contact has been deleted.
  • Title: Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates whether the contact of the service request does not want to be contacted. The default value is false.
  • Title: Formatted Address
    Read Only: true
    The formatted address of the service request contact.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The job title of the service request contact.
  • 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 record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The application login id of the user who last updated the contacts object associated with the service request.
  • Links
  • Title: Member ID
    The unique identifier of the contact.
  • Title: Party ID
    The unique party identifier of the contact.
  • Title: Person ID
    The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
  • Title: Primary
    Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.
  • Title: Relationship Type Code
    Maximum Length: 30
    The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
  • Title: Service Request ID
    The unique identifier of the associated service request.
  • Title: Service Request Number
    Maximum Length: 30
    The public unique number of the a service request.
  • Title: Can Update
    Read Only: true
    Indicates if the contact has been updated.
Nested Schema : serviceRequests-messages-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
  • Channel Communications
    Title: Channel Communications
    The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
  • Title: Channel
    The unique identifier of the channel.
  • Title: Channel Type
    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 Resource
    This field is reserved for internal use only.
  • 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 e-mail address of the person who created the service request message.
  • Title: Created by Party ID
    Read Only: true
    Maximum Length: 80
    The unique identifier of the party of the user 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 if the message has been deleted.
  • 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 session login associated with the user who last updated the message.
  • Links
  • Title: Message Content
    The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the 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
    Indicates the message expanding state.
  • Title: Message ID
    The unique identifier of the service request message.
  • Title: Last Updated Date
    The last updated date of the message 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 update 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 update 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 code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD.
  • 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: Notification Processing Status Code
    Maximum Length: 30
    The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.
  • Title: Notification Retry Count
    The number of times the system tried to send the SR message notification.
  • 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 Code
    Maximum Length: 30
    Default Value: SVC_SR_MESSAGES
    This field is reserved for internal use only.
  • Title: Original System
    Maximum Length: 255
    The 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 service request message.
  • Title: Posted By
    Read Only: true
    Maximum Length: 360
    The Party name of the user who the 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 public unique identifier of the person posting the message on the service request.
  • 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 code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .
  • Title: Reply to Message ID
    Read Only: true
    The unique identifier of the message that is being replied to by the agent.
  • 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 latest 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 message was created from a private social post.
  • Title: Source Code
    Maximum Length: 30
    The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.
  • 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 public unique number of the a service request.
  • 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 code indicating 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 used to send an email response to a customer.
  • Title: Thread Count
    Read Only: true
    The number of threads in a service request message.
  • Title: Thread Hierarchy Level
    Read Only: true
    The level of the thread in the message hierarchy.
  • Title: Thread Identifier
    Read Only: true
    The unique ID of the service request message thread.
  • Title: Thread Last Updated Date
    Read Only: true
    The date when the message 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 if the message has been updated.
  • Title: Visibility Code
    Maximum Length: 30
    The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
Show Source
Nested Schema : Channel Communications
Type: array
Title: Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : serviceRequests-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 : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-response
Type: object
Show Source
Nested Schema : serviceRequests-messages-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : serviceRequests-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, an account name would be the inbound mailbox for support like support@abc.com.
  • 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 is 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 and 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 message.
  • 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 is being communicated with.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.
  • 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 Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
  • Title: Person ID
    The unique identifier of the person who is a contact on the service request.
  • 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. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
  • Title: ID
    Read Only: true
    The unique identifier of the channel communication.
Nested Schema : serviceRequests-resourceMembers-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who added the resource as a member of the service request.
  • 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 if the resource member has been deleted.
  • 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 application login associated with the user who last updated the service request resource member.
  • Links
  • Title: Member ID
    A unique identifier service request resource member record.
  • Title: Service Request Team Member Resource ID
    The unique identifier of the individual resource added as service request resource member.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_SVC_RESOURCE
    The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .
  • Title: Assigned To
    Indicates if 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 individual resource added as 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
    Indicates the formatted address of the service request resource member.
  • Title: Phone
    Read Only: true
    The formatted phone number of the resource member.
  • Title: Name
    Maximum Length: 360
    The name of the individual resource added as service request resource member.
  • Title: Resource Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the service request team member.
  • Title: Service Request ID
    The unique identifier of the service request that the resource is associated with.
  • Title: Service Request Number
    Maximum Length: 30
    The public unique identifier of the service request number.
  • Title: Can Update
    Read Only: true
    Indicates if the resource member has been updated.
  • Title: User GUID
    Read Only: true
    Maximum Length: 64
    A globally unique identifier of the resource added as the service request resource member.
  • Title: User ID
    Read Only: true
    The user identifier of the resource added as the service request resource member.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    The user name of the resource member.
Nested Schema : serviceRequests-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 150
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates whether an action is designed to operate on multiple object instances selected by an end user.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the action is smart suggest enabled.
  • Title: System Action
    Maximum Length: 1
    System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique identifier of the smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : serviceRequests-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : serviceRequests-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : serviceRequests-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    The value assigned to the value property of a name-value pair.
Nested Schema : serviceRequests-srInteractionReferences-item-response
Type: object
Show Source
Nested Schema : serviceRequests-srMilestone-item-response
Type: object
Show Source
Nested Schema : Milestone Codes
Type: array
Title: Milestone Codes
The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
Show Source
Nested Schema : serviceRequests-srMilestone-SrMilestoneHistory-item-response
Type: object
Show Source
Nested Schema : serviceRequests-srReferences-item-response
Type: object
Show Source
  • Title: Article ID
    Maximum Length: 64
    The unique identifier of the Oracle Knowledge Cloud Service article.
  • Title: Article Locale
    Maximum Length: 10
    The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the service request reference.
  • Title: Creation Date
    Read Only: true
    The date and time when the service request reference was created.
  • Title: Can Delete
    Read Only: true
    Indicates if the reference has been deleted.
  • Title: Document ID
    Read Only: true
    Maximum Length: 50
    The identifier of the document 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 service request reference 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
    The unique identifier of the object referencing the service request (SR), or referenced by the SR, such as Note, Defect, or another SR.
  • Title: Object Type
    Maximum Length: 30
    The code indicating the type of the object that the service request reference is associated with such as Note, Article, Defect, Other SR. A list of accepted values is defined in the lookup ORA_SVC_SR_REF_OBJECT_TYPE_CD.
  • Title: Reference ID
    Read Only: true
    The unique identifier of the service request reference record.
  • Title: Relation Type
    Maximum Length: 30
    The type of relationship.
  • Title: Resolution Code
    Maximum Length: 30
    The code indicating the resolution code of the service request. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. A list of accepted values is defined in the lookup ORA_SVC_SR_RESOLUTION_CD.
  • 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 to which the reference is associated.
  • Title: Service Request Number
    Maximum Length: 30
    The public unique identifier of the service request.
  • Title: Title
    Maximum Length: 1000
    The title of the article. This attribute is valid only when ArticleId is populated.
  • Title: Can Update
    Read Only: true
    Indicates if the reference has been updated.
Nested Schema : serviceRequests-srTags-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get information on a particular a service request by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002
 

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 12 Aug 2016 10:55:33 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"SrId": 300100089890770
"SrNumber": "SR0000002002"
"Title": "REST API - Automated Test Script- created time - 2016/06/05 11:28:03"
"ProblemDescription": null
"SeverityCd": "ORA_SVC_SEV3"
"AssigneeResourceId": null
"AssigneePartyId": null
"AssigneePersonName": null
"AssigneeEmailAddress": null
"CreatedBy": "autoapicsm2"
"CreationDate": "2016-06-05T11:28:04-07:00"
"LastUpdateDate": "2016-06-05T11:28:04-07:00"
"LastUpdateLogin": "348D01EFFABE54DBE05393D0F00AEE8E"
"LastUpdatedBy": "autoapicsm2"
"LastUpdatedByDisplayName": "autoapicsm2 svc"
"AccountPartyId": null
"AccountPartyUniqueName": null
"PartnerAccountPartyId": null
"PartnerAccountPartyName": null
"PartnerAccountPartyUniqueName": null
"OwnerTypeCd": "ORA_SVC_CUSTOMER"
"PrimaryContactPartyId": null
"PrimaryContactPartyUniqueName": null
"PrimaryContactFormattedPhoneNumber": null
"CategoryId": null
"ClosedDate": null
"CorpCurrencyCode": null
"CurcyConvRateType": null
"CurrencyCode": null
"OpenDate": "2016-06-05T11:28:04-07:00"
"ReportedByPartyId": 300100077629336
"ReportedByPartyUniqueName": "autoapicsm2 svc"
"ProblemCd": null
"ProdGroupId": null
"ProdGroupName": null
"InventoryItemId": null
"InventoryOrgId": null
"ProductItemOrgId": null
"ProductItemDescription": null
"ProductItemNumber": null
"AssetId": null
"AssetSerialNumber": null
"QueueId": null
"LastReopenDate": null
"LastResolvedDate": null
"ResolutionCd": null
"SourceCd": null
"ChannelTypeCd": null
"StatusCd": "ORA_SVC_NEW"
"InternalPriorityCd": null
"LanguageCd": null
"StatusTypeCd": "ORA_SVC_NEW"
"SrCreatedBy": "autoapicsm2"
"QueueName": null
"CriticalFlag": false
"OriginalSystemReference": "SR0000002002"
"CategoryName": null
"SrLastUpdateDate": "2016-06-05T11:28:04-07:00"
"SrLastUpdateLogin": "348D01EFFABE54DBE05393D0F00AEE8E"
"SrLastUpdatedBy": "autoapicsm2"
"RecordSet": null
"links": 
[
28]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002"
"name": "serviceRequests"
"kind": "item"
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000177040000000A737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
-
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002"
"name": "serviceRequests"
"kind": "item"
}
-
2:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/SearchFilterLookupPVO"
"name": "SearchFilterLookupPVO"
"kind": "collection"
}
-
3:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/ResourcePickerLOV"
"name": "ResourcePickerLOV"
"kind": "collection"
}
-
4:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/PartnerAccountLOV"
"name": "PartnerAccountLOV"
"kind": "collection"
}
-
5:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002002/lov/QueueVO"
"name": "QueueVO"
"kind": "collection"
}
-
. . .
-
}
Back to Top