Jump to

• Request
• Response

Get all profile type sections

get

/hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV

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 the profile type sections that match the specified primary key criteria.
    Finder Variables
    • SectionId; integer; System-generated primary key for the profile type section.
  • findByPersonAccessAndSource Finds all the sections that match the given security access level for a person and must be subscribed by providing the subscriber code.
    Finder Variables
    • PersonId; integer; Unique identifier for a person.
    • SubscriberCode; string; Code representing the subscriber of the content section. Sample values are IRC for recruiting, CONN for connections, and CDEV for career development.
  • findByPersonId Finds the list of sections that are available for a given person identifier.
    Finder Variables
    • ContentTypeId; integer; System-generated primary key of the content type.
    • PersonId; integer; System-generated primary key of the Person.
  • findByPersonSecurityAccess Find the section, which matches the given security access level for the provided person.
    Finder Variables
    • PersonId; integer; Unique identifier for a person.
    • SecurityAccessLevel; string; Code representing the access level for the content section.
  • findByProfileTypeId Finds all the content sections that are configured for a given profile type.
    Finder Variables
    • ProfileTypeId; integer; Unique identifier for the profile type.
  • findBySubscriberCodeOrProfileType Finds all the sections that were added to a profile and must be subscribed by providing the subscriber code or the provide profile type identifiers.
    Finder Variables
    • ProfileId; integer; Unique identifier of the profile.
    • ProfileTypeId; integer; Unique identifier for the profile type.
    • SubscriberCode; string; Unique identifier of the content section subscriber.
  • findSectionByPersonId Finds all the sections added to a person's profile.
    Finder Variables
    • PersonId; integer; Unique identifier for the person.
  • findSectionForRAC Finds all the sections added to a person's profile and subscribed by Recruiting.
    Finder Variables
    • PersonId; integer; System-generated primary key of the Person.
  • findSectionToAdd Finds all the sections that aren't yet added to a person's profile.
    Finder Variables
    • PersonId; integer; Unique identifier for the person.
  • findSectionsForPrintProfile Finds all the content sections that are available in person profile and has report access.
    Finder Variables
    • PersonId; integer; Unique identifier for a person.
  • findTalentRatingByManageAccess Finds all the talent rating sections for which the user has access to create, update, and view for a person.
    Finder Variables
    • PersonId; integer; System-generated primary key of the Person.
  • findTalentRatingByViewAccess Finds all the talent rating sections for which the user has only view access for a person.
    Finder Variables
    • PersonId; integer; System-generated primary key of the Person.
  • findTemplateSections Finds all the person profile type content sections configured as a template in the system.
    Finder Variables
• 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:
  

  • ApprovalRequiredFlag; boolean; 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; System-generated primary key of the content type.
  • DefaultFlag; boolean; 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; Description of the profile type section.
  • DffContextName; string; Name of the descriptive flexfield context of the content section.
  • LinkedinEnabledFlag; boolean; 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
  • ManageSectionAccessFlag; boolean; 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; Name of the profile type section.
  • PersonSectionItemCount; integer; Count of the profile items available on person's profile for a content section.
  • ProfileSectionId; integer; Unique identifier of the content section associated with the profile.
  • ProfileTypeId; integer; 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; Count of the related profile items available on a profile for a content section.
  • SectionContext; string; Section Context of the profile type section.
  • SectionId; integer; System-generated primary key of the profile type section.
  • SubscriberCode; string; Code representing the subscriber of the content section. Sample values are IRC for recruiting, CONN for connections, CDEV for career development.
  • TemplateFlag; boolean; 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.
• 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 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 : profileTypeSectionsLOV

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/profileTypeSectionsLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object profileTypeSectionsLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/profileTypeSectionsLOV-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 : profileTypeSectionsLOV-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "SectionContext":{
            "maxLength":300,
            "type":"string",
            "description":"Section Context of the profile type section.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RelatedItemCount":{
            "type":"integer",
            "description":"Count of the related profile items available on a profile for a content section.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the profile type section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrder":{
            "type":"integer",
            "description":"Display order of the profile type sections.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ContentTypeId":{
            "type":"integer",
            "description":"System-generated primary key of the content type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManageSectionAccessFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileTypeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProfileSectionId":{
            "type":"integer",
            "description":"Unique identifier of the content section associated with the profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the profile type section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the subscriber of the content section. Sample values are IRC for recruiting, CONN for connections, CDEV for career development.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalRequiredFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedinEnabledFlag":{
            "maxLength":120,
            "type":"boolean",
            "description":"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",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonSectionItemCount":{
            "type":"integer",
            "description":"Count of the profile items available on person's profile for a content section.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"System-generated primary key of the profile type section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "DffContextName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the descriptive flexfield context of the content section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

Back to Top