Create a service request reference
post
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences
Request
Path Parameters
-
SrId(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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the referenced article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the knowledge management article. -
HelpfulFlag: boolean
Title:
Helpful
Maximum Length:1
Indicates whether the service request reference was helpful. -
LinkedFlag: boolean
Title:
Linked
Maximum Length:1
Indicates whether the reference is linked with the service request. -
ObjectId: integer
(int64)
Title:
Object ID
Indicates whether the object is referenced to the service request. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The object type of the reference object. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The relationship type between the service request and the referenced object. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
Indicates whether the referenced object helps in resolving the service request. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the referenced object.
Response
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 : internalServiceRequests-srReferences-item-response
Type:
Show Source
object
-
ArticleId: string
Title:
Article ID
Maximum Length:64
The unique identifier of the referenced article. -
ArticleLocale: string
Title:
Article Locale
Maximum Length:10
The locale of the knowledge management article. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the reference to the service request. -
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 whether the user has access to delete the record. -
DocumentId: string
Title:
Document ID
Read Only:true
Maximum Length:50
The unique document identifier 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 record 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
Indicates whether the object is referenced to the service request. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The object type of the reference object. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the current reference record. -
RelationTypeCd: string
Title:
Relation Type
Maximum Length:30
The relationship type between the service request and the referenced object. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
Indicates whether the referenced object helps in resolving the service request. - SharedFlag: boolean
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
Subject: string
Title:
Title
Maximum Length:1000
The title of the referenced object. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record
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 following properties are defined on the LOV link relation:- Source Attribute: ResolutionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: