Get a profile type section
get
/hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV/{profileTypeSectionsLOVUniqID}
Request
Path Parameters
-
profileTypeSectionsLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Profile Type Sections List of Values resource and used to uniquely identify an instance of Profile Type Sections List of Values. The client should not generate the hash key value. Instead, the client should query on the Profile Type Sections List of Values collection resource in order to navigate to a specific instance of Profile Type Sections List of Values to get the hash key.
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 : profileTypeSectionsLOV-item-response
Type:
Show Source
object
-
ApprovalRequiredFlag: boolean
Read Only:
true
Maximum Length:30
Indicates whether approval is required while adding, updating, or deleting the content section from the profile. If false, then the approval isn't required for the content section. If true, then approvals will be enabled for the content section. The default value is false. -
ContentTypeId: integer
(int64)
Read Only:
true
System-generated primary key of the content type. -
DefaultFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a content section is presented on a person's talent profile without being explicitly added. Section default settings can be changed by administrators. -
Description: string
Read Only:
true
Maximum Length:4000
Description of the profile type section. -
DffContextName: string
Read Only:
true
Maximum Length:255
Name of the descriptive flexfield context of the content section. -
DisplayOrder: integer
Read Only:
true
Display order of the profile type sections. -
LinkedinEnabledFlag: boolean
Read Only:
true
Maximum Length:120
Indicates whether LinkedIn is enabled for the content sections. If false, then the LinkedIn import is disabled for the content section. If true, then LinkedIn import will be enabled for the content section. The default value is false -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManageSectionAccessFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the assigned role has manage access to the content section. If true, then the user can manage the content section. If false, then the user can't manage the content section. The default value is false. -
Name: string
Read Only:
true
Maximum Length:240
Name of the profile type section. -
PersonSectionItemCount: integer
(int64)
Read Only:
true
Count of the profile items available on person's profile for a content section. -
ProfileSectionId: integer
Read Only:
true
Unique identifier of the content section associated with the profile. -
ProfileTypeId: integer
(int64)
Read Only:
true
Unique identifier for the profile type. Valid values are 1 for Person Profile, 2 for Job Profile, 3 for Position Profile, 4 for Organization Profile, 11 for Prerequisite, and 10 for Requisition Profile. -
RelatedItemCount: integer
(int64)
Read Only:
true
Count of the related profile items available on a profile for a content section. -
SectionContext: string
Read Only:
true
Maximum Length:300
Section Context of the profile type section. -
SectionId: integer
(int64)
Read Only:
true
System-generated primary key of the profile type section. -
SubscriberCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code representing the subscriber of the content section. Sample values are IRC for recruiting, CONN for connections, CDEV for career development. -
TemplateFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the profile type content section is a template. If true, the content section is a template and can be used to define similar content type sections. If false, the content section is defined for use within the talent profile to analyze skills and qualifications.
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.