Create a career of interest
post
/hcmRestApi/resources/11.13.18.05/careerInterests
Request
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
-
AssignedByPersonId: integer
(int64)
Title:
Added By
Unique identifier of the person who assigned the career of interest to an employee. -
CareerInterestId: integer
(int64)
Unique identifier for the career of interest.
-
ModelProfileId: integer
(int64)
Title:
Job
Unique identifier for the job model profile corresponding to the career of interest. -
PersonId: integer
(int64)
Unique identifier for the person associated with the career of interest.
-
PrivateCode: string
Title:
Private
Maximum Length:30
Default Value:N
Indicates whether the career of interest is private or not. Possible values are Y, N, or Null
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 : careerInterests-item-response
Type:
Show Source
object
-
AssignedByPersonId: integer
(int64)
Title:
Added By
Unique identifier of the person who assigned the career of interest to an employee. -
CareerInterestId: integer
(int64)
Unique identifier for the career of interest.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the career of interest. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the career of interest was created. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the user who created the career of interest. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the career of interest was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the career of interest. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelProfileCode: string
Title:
Profile Code
Read Only:true
Maximum Length:30
Code for the job model profile corresponding to the career of interest. -
ModelProfileId: integer
(int64)
Title:
Job
Unique identifier for the job model profile corresponding to the career of interest. -
ModelProfileName: string
Title:
Name
Read Only:true
Maximum Length:4000
Name of the job model profile corresponding to the career of interest. -
PersonId: integer
(int64)
Unique identifier for the person associated with the career of interest.
-
PrivateCode: string
Title:
Private
Maximum Length:30
Default Value:N
Indicates whether the career of interest is private or not. Possible values are Y, N, or Null -
Summary: string
Title:
Description
Read Only:true
Maximum Length:4000
Summary of the career of interest.
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.