Get all talent pool security profiles
get
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds talent pool security profiles.
Finder Variables- PoolSecurityProfileId; integer; Unique identifier for a talent pool security profile.
- PrimaryKey Finds talent pool security profiles.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BusinessUnitsCount; integer; Count of business units added to the talent pool security profile.
- CreatedBy; string; Name of the user who created the talent pool security profile.
- CreationDate; string; Date the talent pool security profile was created.
- DepartmentCount; integer; Count of departments added to the talent pool security profile.
- EnabledFlag; boolean; Indicates whether the talent pool security profile is enabled or not. Valid values are True and False. The default value is True.
- JobFamiliesCount; integer; Count of job families added to the talent pool security profile.
- LastUpdateDate; string; Date the talent pool security profile was last updated.
- LastUpdateLogin; string; Session login identifier associated with the user who last updated the talent profile security row.
- LastUpdatedBy; string; Name of the user who last updated the talent pool security profile.
- Name; string; Name of the talent pool security profile.
- PoolSecurityProfileId; integer; Unique identifier of the talent pool security profile.
- SecureByBusinessUnitFlag; boolean; Indicates whether the talent pool security profile is secured by business unit or not. Valid values are True and False. The default value is False.
- SecureByDepartmentFlag; boolean; Indicates whether the talent pool security profile is secured by department or not. Valid values are True and False. The default value is False.
- SecureByJobFamilyFlag; boolean; Indicates whether the talent pool security profile is secured by job family or not. Valid values are True and False. The default value is False.
- SecureByOwnerOnlyFlag; boolean; Indicates whether the talent pool security profile is secured by pool owner or not. Valid values are True and False. The default value is False.
- ViewAllFlag; boolean; Indicates whether the talent pool security profile provides view all access to pools or not. Valid values are True and False. The default value is False.
- ViewAllPublicPoolsFlag; boolean; Indicates whether the talent pool security profile provides view all access to public pools or not. Valid values are True and False. The default value is False.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : talentPoolSecurityProfiles
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPoolSecurityProfiles-item-response
Type:
Show Source
object
-
businessUnits: array
Business Units
Title:
Business Units
The businessUnits resource provides a way to secure talent pools by business unit. -
BusinessUnitsCount: integer
Read Only:
true
Count of business units added to the talent pool security profile. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the talent pool security profile. -
CreationDate: string
(date-time)
Read Only:
true
Date the talent pool security profile was created. -
DepartmentCount: integer
Read Only:
true
Count of departments added to the talent pool security profile. -
departments: array
Departments
Title:
Departments
The department resource provides a way to secure talent pools by department. -
EnabledFlag: boolean
Title:
Enable
Maximum Length:1
Indicates whether the talent pool security profile is enabled or not. Valid values are True and False. The default value is True. -
jobFamilies: array
Job Families
Title:
Job Families
The jobFamilies resource provides a way to secure talent pools by jobFamilies. -
JobFamiliesCount: integer
Read Only:
true
Count of job families added to the talent pool security profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the talent pool security profile was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the talent pool security profile. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login identifier associated with the user who last updated the talent profile security row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
Name of the talent pool security profile. -
PoolSecurityProfileId: integer
(int64)
Unique identifier of the talent pool security profile.
-
SecureByBusinessUnitFlag: boolean
Title:
Secure by Business Unit
Maximum Length:1
Indicates whether the talent pool security profile is secured by business unit or not. Valid values are True and False. The default value is False. -
SecureByDepartmentFlag: boolean
Title:
Secure by Department
Maximum Length:1
Indicates whether the talent pool security profile is secured by department or not. Valid values are True and False. The default value is False. -
SecureByJobFamilyFlag: boolean
Title:
Secure by Job Family
Maximum Length:1
Indicates whether the talent pool security profile is secured by job family or not. Valid values are True and False. The default value is False. -
SecureByOwnerOnlyFlag: boolean
Title:
View by Ownership
Maximum Length:1
Indicates whether the talent pool security profile is secured by pool owner or not. Valid values are True and False. The default value is False. -
ViewAllFlag: boolean
Title:
View All
Maximum Length:1
Indicates whether the talent pool security profile provides view all access to pools or not. Valid values are True and False. The default value is False. -
ViewAllPublicPoolsFlag: boolean
Title:
View All Public Talent Pools
Maximum Length:1
Indicates whether the talent pool security profile provides view all access to public pools or not. Valid values are True and False. The default value is False.
Nested Schema : Business Units
Type:
array
Title:
Business Units
The businessUnits resource provides a way to secure talent pools by business unit.
Show Source
Nested Schema : Departments
Type:
array
Title:
Departments
The department resource provides a way to secure talent pools by department.
Show Source
Nested Schema : Job Families
Type:
array
Title:
Job Families
The jobFamilies resource provides a way to secure talent pools by jobFamilies.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPoolSecurityProfiles-businessUnits-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit on the talent pool security profile.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who selected the business unit on the talent pool security profile. -
CreationDate: string
(date-time)
Read Only:
true
Date the business unit was selected on the talent pool security profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the business unit was updated on the talent pool security profile. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the business unit on the talent pool security profile. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login identifier associated with the user who last updated the business unit row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit that was selected on the talent pool security profile. -
PoolSecProfBusUnitId: integer
(int64)
Unique identifier for the business unit that's part of a talent pool security profile.
-
PoolSecurityProfileId: integer
(int64)
Unique identifier of the business unit associated with the talent pool security profile.
-
Status: string
Title:
Active
Read Only:true
Maximum Length:30
Status of the business unit associated with the talent pool security profile.
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.
Nested Schema : talentPoolSecurityProfiles-departments-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who selected the department on the talent pool security profile. -
CreationDate: string
(date-time)
Read Only:
true
Date the department was selected on the talent pool security profile. -
DepartmentId: integer
(int64)
Unique identifier of the department on the talent pool security profile.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date the department was updated on the talent pool security profile. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the department on the talent pool security profile. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login identifier associated with the user who last updated the department row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Department
Read Only:true
Maximum Length:240
Name of the department that was selected on the talent pool security profile. -
PoolSecProfDepartmentId: integer
(int64)
Unique identifier for the department that's part of a talent pool security profile.
-
PoolSecurityProfileId: integer
(int64)
Unique identifier of the department associated with the talent pool security profile.
-
Status: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the department associated with the talent pool security profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPoolSecurityProfiles-jobFamilies-item-response
Type:
Show Source
object
-
ActiveStatus: string
Read Only:
true
Maximum Length:30
Status of the job family associated with the talent pool security profile. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who selected the job family on the talent pool security profile. -
CreationDate: string
(date-time)
Read Only:
true
Date the job family was selected on the talent pool security profile. -
JobFamilyId: integer
(int64)
Unique identifier of the job family on the talent pool security profile.
-
JobFamilyName: string
Title:
Job Family
Read Only:true
Maximum Length:240
Name of the job family that was selected on the talent pool security profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the job family was updated on the talent pool security profile. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the job family on the talent pool security profile. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login identifier associated with the user who last updated the row of the job family. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoolSecProfJobFamilyId: integer
(int64)
Unique identifier for the Job family unit that's part of a talent pool security profile.
-
PoolSecurityProfileId: integer
(int64)
Unique identifier of the job family associated with the talent pool security profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source