Get a content library item LOV
get
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}
Request
Path Parameters
-
recruitingContentLibraryItemsLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recruiting Content Library Items LOV resource and used to uniquely identify an instance of Recruiting Content Library Items LOV. The client should not generate the hash key value. Instead, the client should query on the Recruiting Content Library Items LOV collection resource in order to navigate to a specific instance of Recruiting Content Library Items LOV 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 : recruitingContentLibraryItemsLOV-item-response
Type:
Show Source
object
-
DescriptionCode: string
Read Only:
true
Maximum Length:30
Description code in content library items LOV. -
descriptions: array
Recruiting Content Library Items Descriptions List of Values
Title:
Recruiting Content Library Items Descriptions List of Values
The recruitingContentLibraryItemsLOVdescriptions resource provides the list of values for the descriptions for a given recruiting content library item. -
DescriptionTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each description type in the content library items LOV. -
ItemDescriptionId: integer
Read Only:
true
Item description ID in content library items LOV. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:240
Name in content library items LOV. -
VisibilityCode: string
Read Only:
true
Maximum Length:30
Visibility code of the content library item.
Nested Schema : Recruiting Content Library Items Descriptions List of Values
Type:
array
Title:
Recruiting Content Library Items Descriptions List of Values
The recruitingContentLibraryItemsLOVdescriptions resource provides the list of values for the descriptions for a given recruiting content library item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingContentLibraryItemsLOV-descriptions-item-response
Type:
Show Source
object
-
Description: string
(byte)
Read Only:
true
Description content of the description. -
DescriptionVersionId: integer
(int64)
Read Only:
true
Unique identifier of the description version. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Qualifications: string
(byte)
Read Only:
true
Qualifications content of the description. -
Responsibilities: string
(byte)
Read Only:
true
Responsibilities content of the description. -
ShortDescription: string
(byte)
Read Only:
true
Short description content of the description.
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
- descriptions
-
Parameters:
- recruitingContentLibraryItemsLOVUniqID:
$request.path.recruitingContentLibraryItemsLOVUniqID
The recruitingContentLibraryItemsLOVdescriptions resource provides the list of values for the descriptions for a given recruiting content library item. - recruitingContentLibraryItemsLOVUniqID: