Create a job family
post
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts
Request
Path Parameters
-
questionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Questions resource and used to uniquely identify an instance of Questions. The client should not generate the hash key value. Instead, the client should query on the Questions collection resource in order to navigate to a specific instance of Questions to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
Root Schema : schema
Type:
Show Source
object
-
JobFamilyId: integer
(int64)
Title:
Job Family Id
Surrogate identifier of the job family defined as a context to the question. -
JobFamilyName: string
Title:
Job Family Name
Maximum Length:240
Name of the job family context defined for the question.
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 : questions-jobFamilyContexts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the job family context for the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the job family context for the question was created. -
JobFamilyId: integer
(int64)
Title:
Job Family Id
Surrogate identifier of the job family defined as a context to the question. -
JobFamilyName: string
Title:
Job Family Name
Maximum Length:240
Name of the job family context defined for the question. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the job family context for the question was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the job family context for the question. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionContextId: integer
(int64)
Title:
Question Context Id
Read Only:true
Surrogate identifier for the job family context for a question.
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
- JobFamiliesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: JobFamilyName; Target Attribute: JobFamilyName
- Display Attribute: JobFamilyName