Get a service request reference
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}
Request
Path Parameters
-
ReferenceId(required): integer(int64)
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=
-
SrNumber(required): string
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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : serviceRequests-srReferences-item-response
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the Oracle Knowledge Cloud Service article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the document, such as en_US. This attribute is valid only when ArticleId is populated. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service request reference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service request reference was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the reference has been deleted. -
DocumentId: string
Title:
Document ID
Read Only:true
Maximum Length:50
The identifier of the document associated with the referenced article. -
HelpfulFlag: boolean
Title:
Helpful
Maximum Length:1
Indicates whether the service request reference was helpful. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service request reference was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service request reference. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login ID of the user who last updated the service request reference. -
LinkedFlag: boolean
Title:
Linked
Maximum Length:1
Indicates whether the reference is linked with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
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. -
ObjectTypeCd: string
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. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the service request reference record. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The type of relationship. -
ResolutionCd: string
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. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request to which the reference is associated. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique identifier of the service request. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the article. This attribute is valid only when ArticleId is populated. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the reference has been updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ResolutionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_REF_RESOLUTION_CD
The list of values for the service request resolution codes. For example, Satisfied, Not_Satisfied, Returned_Product, New_Purchase, Unknown, and so on. - finder:
Examples
The following example shows how to get information of a specific service request reference 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/SR0000007002/child/srReferences/300100090543767 HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 15 Nov 2016 14:45:39 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.
{ "ReferenceId": 300100090543767, "CreationDate": "2016-11-15T06:35:44-08:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2016-11-15T06:35:44-08:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "41438BCB97E343F5E0535CC0F20AC895", "SrId": 300100090532774, "ObjectId": null, "ArticleId": "21", "ObjectTypeCd": "ORA_SVC_ARTICLE", "RelationTypeCd": "SR", "Subject": "Testing", "ArticleLocale": "en_US", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/srReferences/300100090543767", "name": "srReferences", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/srReferences/300100090543767", "name": "srReferences", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002", "name": "serviceRequests", "kind": "item" } ], }