Get all talent pool security profiles

get

/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : talentPoolSecurityProfiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : talentPoolSecurityProfiles-item-response
Type: object
Show Source
  • Business Units
    Title: Business Units
    The businessUnits resource provides a way to secure talent pools by business unit.
  • Read Only: true
    Count of business units added to the talent pool security profile.
  • Read Only: true
    Maximum Length: 64
    Name of the user who created the talent pool security profile.
  • Read Only: true
    Date the talent pool security profile was created.
  • Read Only: true
    Count of departments added to the talent pool security profile.
  • Departments
    Title: Departments
    The department resource provides a way to secure talent pools by department.
  • 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.
  • Job Families
    Title: Job Families
    The jobFamilies resource provides a way to secure talent pools by jobFamilies.
  • Read Only: true
    Count of job families added to the talent pool security profile.
  • Read Only: true
    Date the talent pool security profile was last updated.
  • Read Only: true
    Maximum Length: 64
    Name of the user who last updated the talent pool security profile.
  • Read Only: true
    Maximum Length: 32
    Session login identifier associated with the user who last updated the talent profile security row.
  • Links
  • Title: Name
    Maximum Length: 240
    Name of the talent pool security profile.
  • Unique identifier of the talent pool security profile.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : talentPoolSecurityProfiles-businessUnits-item-response
Type: object
Show Source
Nested Schema : talentPoolSecurityProfiles-departments-item-response
Type: object
Show Source
Nested Schema : talentPoolSecurityProfiles-jobFamilies-item-response
Type: object
Show Source
Back to Top