REST API for Oracle Fusion Cloud HCM

Get all eligibility profiles

get

/hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV

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 an eligibility profile by profile ID where the profile ID is blank.
  Finder Variables
  - EligyPrflId; integer; Finds an eligibility profile that matches the specified profile ID.
- findByEligyPrflId Finds an eligibility profile by ID where the eligibility profile ID is blank.
  Finder Variables
  - EligyPrflId; integer; Finds an eligibility profile that matches the eligibility profile ID.
- findByName Finds an eligibility profile by name where the name is blank.
  Finder Variables
  - Name; string; Finds an eligibility profile that matches the specified name.
- findByProfileType Finds an eligibility profile by profile type where the profile type is blank.
  Finder Variables
  - ProfileType; string; Finds an eligibility profile that matches the specified profile type.
- findByWord Finds all eligibility profiles.
  Finder Variables
  - FilterAttributes; string; Finds an eligibility profile based on one or more filter attributes provided.
  - SearchTerms; string; Finds an eligibility profile based on the search term provided.
  - StartsWithFlag; string; Finds an eligibility profile based on a search term that starts with the entered value.
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:
- AsmtToUseCd; string; Determines the assignment that the eligibility process evaluates for the person based on the organization level.
- BnftCagrPrtnCd; string; Determines the type of objects the participant profile can be associated with, such as benefits offerings and rates, compensation plans, checklist tasks, goal plans or mass goal assignments, or performance documents. Selecting Global makes the profile available to multiple business process usages.
- Description; string; Describes the eligibility profile.
- EligyPrflId; integer; Indicates a unique eligibility profile.
- Name; string; The name of the eligibility profile.
- ProfileType; string; Determines the eligibility of the participant's spouse, family members, or other individuals who qualify as dependents. Otherwise, the person is a participant. All other profiles are participant profiles.
- StatCd; string; The current state of an eligibility profile. Possible values are active or inactive.
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.

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.

Root Schema : eligibilityProfilesLOV

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/eligibilityProfilesLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object eligibilityProfilesLOV-item-response

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

Type: object

Show Source

AsmtToUseCd: string

Title: Assignment to Use

Read Only: true

Maximum Length: 30

Default Value: ANE

Determines the assignment that the eligibility process evaluates for the person based on the organization level.
BnftCagrPrtnCd: string

Title: Profile Usage

Read Only: true

Maximum Length: 30

Default Value: BNFT

Determines the type of objects the participant profile can be associated with, such as benefits offerings and rates, compensation plans, checklist tasks, goal plans or mass goal assignments, or performance documents. Selecting Global makes the profile available to multiple business process usages.
Description: string

Title: Description

Read Only: true

Maximum Length: 2000

Describes the eligibility profile.
EligyPrflId: integer (int64)

Read Only: true

Indicates a unique eligibility profile.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Title: Name

Read Only: true

Maximum Length: 240

The name of the eligibility profile.
ProfileType: string

Title: Profile Type

Read Only: true

Maximum Length: 15

Default Value: PRTP

Determines the eligibility of the participant's spouse, family members, or other individuals who qualify as dependents. Otherwise, the person is a participant. All other profiles are participant profiles.
StatCd: string

Title: Status

Read Only: true

Maximum Length: 30

Default Value: A

The current state of an eligibility profile. Possible values are active or inactive.

{
    "type":"object",
    "properties":{
        "EligyPrflId":{
            "type":"integer",
            "description":"Indicates a unique eligibility profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileType":{
            "title":"Profile Type",
            "maxLength":15,
            "type":"string",
            "description":"Determines the eligibility of the participant's spouse, family members, or other individuals who qualify as dependents. Otherwise, the person is a participant. All other profiles are participant profiles.",
            "nullable":false,
            "readOnly":true,
            "default":"PRTP",
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Describes the eligibility profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AsmtToUseCd":{
            "title":"Assignment to Use",
            "maxLength":30,
            "type":"string",
            "description":"Determines the assignment that the eligibility process evaluates for the person based on the organization level.",
            "nullable":false,
            "readOnly":true,
            "default":"ANE",
            "x-queryable":true
        },
        "StatCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The current state of an eligibility profile. Possible values are active or inactive.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BnftCagrPrtnCd":{
            "title":"Profile Usage",
            "maxLength":30,
            "type":"string",
            "description":"Determines the type of objects the participant profile can be associated with, such as benefits offerings and rates, compensation plans, checklist tasks, goal plans or mass goal assignments, or performance documents. Selecting Global makes the profile available to multiple business process usages.",
            "nullable":false,
            "readOnly":true,
            "default":"BNFT",
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the eligibility profile.",
            "nullable":false,
            "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."
        }
    }
}