Jump to

• Request
• Response

Get a talent pool security profile

get

/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}

Request

Path Parameters

• PoolSecurityProfileId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 Top

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.

Body ()

Root Schema : talentPoolSecurityProfiles-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the talent pool security profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitsCount":{
            "type":"integer",
            "description":"Count of business units added to the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PoolSecurityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecureByJobFamilyFlag":{
            "title":"Secure by Job Family",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecureByOwnerOnlyFlag":{
            "title":"View by Ownership",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the talent pool security profile.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecureByBusinessUnitFlag":{
            "title":"Secure by Business Unit",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "businessUnits":{
            "title":"Business Units",
            "type":"array",
            "description":"The businessUnits resource provides a way to secure talent pools by business unit.",
            "items":{
                "$ref":"#/components/schemas/talentPoolSecurityProfiles-businessUnits-item-response"
            }
        },
        "ViewAllPublicPoolsFlag":{
            "title":"View All Public Talent Pools",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DepartmentCount":{
            "type":"integer",
            "description":"Count of departments added to the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JobFamiliesCount":{
            "type":"integer",
            "description":"Count of job families added to the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SecureByDepartmentFlag":{
            "title":"Secure by Department",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the talent pool security profile is secured by department or not. Valid values are True and False. The default value is False.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ViewAllFlag":{
            "title":"View All",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "jobFamilies":{
            "title":"Job Families",
            "type":"array",
            "description":"The jobFamilies resource provides a way to secure talent pools by jobFamilies.",
            "items":{
                "$ref":"#/components/schemas/talentPoolSecurityProfiles-jobFamilies-item-response"
            }
        },
        "departments":{
            "title":"Departments",
            "type":"array",
            "description":"The department resource provides a way to secure talent pools by department.",
            "items":{
                "$ref":"#/components/schemas/talentPoolSecurityProfiles-departments-item-response"
            }
        },
        "EnabledFlag":{
            "title":"Enable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the talent pool security profile is enabled or not. Valid values are True and False. The default value is True.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the talent pool security profile was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login identifier associated with the user who last updated the talent profile security row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Business Units

Type: array

Title: Business Units

The businessUnits resource provides a way to secure talent pools by business unit.

Show Source

• Array of: object talentPoolSecurityProfiles-businessUnits-item-response

{
    "title":"Business Units",
    "type":"array",
    "description":"The businessUnits resource provides a way to secure talent pools by business unit.",
    "items":{
        "$ref":"#/components/schemas/talentPoolSecurityProfiles-businessUnits-item-response"
    }
}

Nested Schema : Departments

Type: array

Title: Departments

The department resource provides a way to secure talent pools by department.

Show Source

• Array of: object talentPoolSecurityProfiles-departments-item-response

{
    "title":"Departments",
    "type":"array",
    "description":"The department resource provides a way to secure talent pools by department.",
    "items":{
        "$ref":"#/components/schemas/talentPoolSecurityProfiles-departments-item-response"
    }
}

Nested Schema : Job Families

Type: array

Title: Job Families

The jobFamilies resource provides a way to secure talent pools by jobFamilies.

Show Source

• Array of: object talentPoolSecurityProfiles-jobFamilies-item-response

{
    "title":"Job Families",
    "type":"array",
    "description":"The jobFamilies resource provides a way to secure talent pools by jobFamilies.",
    "items":{
        "$ref":"#/components/schemas/talentPoolSecurityProfiles-jobFamilies-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : talentPoolSecurityProfiles-businessUnits-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the business unit on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Active",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the business unit associated with the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the business unit was selected on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who selected the business unit on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PoolSecurityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the business unit associated with the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit on the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PoolSecProfBusUnitId":{
            "type":"integer",
            "description":"Unique identifier for the business unit that's part of a talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the business unit was updated on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login identifier associated with the user who last updated the business unit row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that was selected on the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : talentPoolSecurityProfiles-departments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the department on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the department associated with the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the department was selected on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who selected the department on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PoolSecurityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the department associated with the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PoolSecProfDepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the department that's part of a talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier of the department on the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the department was updated on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login identifier associated with the user who last updated the department row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Department",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the department that was selected on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : talentPoolSecurityProfiles-jobFamilies-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the job family on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the job family was selected on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job family that was selected on the talent pool security profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who selected the job family on the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Unique identifier of the job family on the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "PoolSecurityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the job family associated with the talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PoolSecProfJobFamilyId":{
            "type":"integer",
            "description":"Unique identifier for the Job family unit that's part of a talent pool security profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the job family was updated on the talent pool security profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login identifier associated with the user who last updated the row of the job family.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the job family associated with the talent pool security profile.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

businessUnits

Operation: /hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits

Parameters:

• PoolSecurityProfileId: $request.path.PoolSecurityProfileId

The businessUnits resource provides a way to secure talent pools by business unit.

departments

Operation: /hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments

Parameters:

• PoolSecurityProfileId: $request.path.PoolSecurityProfileId

The department resource provides a way to secure talent pools by department.

jobFamilies

Operation: /hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies

Parameters:

• PoolSecurityProfileId: $request.path.PoolSecurityProfileId

The jobFamilies resource provides a way to secure talent pools by jobFamilies.

Back to Top