Update a referral in opportunity marketplace.
patch
/hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals/{ReferralId}
Request
Path Parameters
-
ReferralId(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.
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : recruitingMyJobReferrals-item-response
Type:
Show Source
object
-
CandidateNumber: string
Read Only:
true
Maximum Length:30
Candidate number of the referred candidate in opportunity marketplace. -
CandidatePersonId: integer
(int64)
Read Only:
true
Candidate person ID of the referred candidate in opportunity marketplace. -
CandidateTypeCode: string
Read Only:
true
Maximum Length:30
Candidate type of the referred candidate in opportunity marketplace. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the referral in opportunity marketplace. -
DisplayName: string
Read Only:
true
Maximum Length:240
Display name of the referral in opportunity marketplace. -
ExternalPublishJobStatus: string
Read Only:
true
Maximum Length:30
External status of the referred job in opportunity marketplace. -
IntPublishJobStatus: string
Read Only:
true
Maximum Length:30
Internal status of the referred job in opportunity marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Read Only:
true
Maximum Length:240
List name of the referral in opportunity marketplace. -
Message: string
Read Only:
true
Maximum Length:1000
Message entered by the referrer in opportunity marketplace. -
Notes: string
Read Only:
true
Maximum Length:1000
Notes entered by the referrer in opportunity marketplace. -
PublicStatus: string
Read Only:
true
Maximum Length:240
Public status of the referral in opportunity marketplace. -
Rating: number
Read Only:
true
Rating of the referral in opportunity marketplace. -
ReferralId: integer
(int64)
Read Only:
true
Referral ID in opportunity marketplace. -
ReferralTypeCode: string
Read Only:
true
Maximum Length:80
Referral type in opportunity marketplace. -
ReferrerPersonId: integer
(int64)
Read Only:
true
Person ID of the referrer in opportunity marketplace. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID of the referred job in opportunity marketplace. -
RequisitionNumber: string
Read Only:
true
Maximum Length:240
Requisition unique number in opportunity marketplace. - ShareId: integer (int64)
-
Status: string
Read Only:
true
Maximum Length:19
Status of the referral in opportunity marketplace. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID of the referral in opportunity marketplace. -
Title: string
Read Only:
true
Maximum Length:240
Title of the referral in opportunity marketplace.
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.