Jump to

• Request
• Response

Get all individual compensation plans

get

/hcmRestApi/resources/11.13.18.05/eligiblePlansLOV

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 all individual compensation plans that match the specified primary key criteria.
    Finder Variables
    • PlanId; integer; Unique identifier of the individual compensation plan.
  • findByWord Finds all eligible individual compensation plans that match the specified criteria.
    Finder Variables
    • ActionId; integer; Unique identifier of the action.
    • AssignmentId; integer; Unique identifier of the assignment
    • EffectiveDate; string; Effective date to be used.
    • FilterAttributes; string; Attributes used to filter the individual compensation plan, such as PlanName.
    • LegalEntityId; integer; Unique identifier of the legal entity.
    • PersonId; integer; Unique identifier of the person.
    • SearchTerms; string; User-entered term in the individual compensation plan field, such as Bonus.
• 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:
  

  • ActionId; integer; Unique identifier of the action.
  • ActionName; string; Name of the action, such as Hire or Promote.
  • AssignmentId; integer; Unique identifier for the assignment.
  • AssignmentNumber; string; Assignment number for the specified assignment.
  • EffectiveDate; string; Date used to find the eligible plans in effect.
  • EndDate; string; Date after which new allocations aren't allowed.
  • EndDateText; string; Time to delay the end date beyond the projected hire date.
  • InsertAccessCode; string; When people can make allocations for the specified access level, such as always or during a specified period.
  • LegalEntityId; integer; Unique identifier for the legal entity
  • PeriodType; string; Attribute used to indicate whether new proposal is allowed. Valid values are INSERT or Null
  • PersonId; integer; Unique identifier for the person.
  • PlanId; integer; Unique identifier for the individual compensation plan.
  • PlanName; string; Name of the plan, such as Spot Award.
  • PlanSecurityEnabledFlag; boolean; Indicates whether the plan should be restricted to some actions or available for all actions.The default value is All actions.
  • StartDate; string; Date to start allowing new allocations.
  • StartDateText; string; Time to delay the start date beyond the projected hire date.
• 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 : eligiblePlansLOV

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object eligiblePlansLOV-item-response

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

Type: object

Show Source

• ActionId: integer (int64)
  Read Only: true

  Unique identifier of the action.
• ActionName: string
  Read Only: true

  Maximum Length: 320

  Name of the action, such as Hire or Promote.
• AssignmentId: integer (int64)
  Read Only: true

  Unique identifier for the assignment.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 50

  Assignment number for the specified assignment.
• EffectiveDate: string (date)
  Read Only: true

  Date used to find the eligible plans in effect.
• EndDate: string (date)
  Read Only: true

  Date after which new allocations aren't allowed.
• EndDateText: string
  Read Only: true

  Maximum Length: 30

  Time to delay the end date beyond the projected hire date.
• InsertAccessCode: string
  Read Only: true

  Maximum Length: 30

  When people can make allocations for the specified access level, such as always or during a specified period.
• LegalEntityId: integer (int64)
  Read Only: true

  Unique identifier for the legal entity
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodType: string
  Read Only: true

  Maximum Length: 30

  Attribute used to indicate whether new proposal is allowed. Valid values are INSERT or Null
• PersonId: integer (int64)
  Read Only: true

  Unique identifier for the person.
• PlanId: integer (int64)
  Read Only: true

  Unique identifier for the individual compensation plan.
• PlanName: string
  Read Only: true

  Maximum Length: 80

  Name of the plan, such as Spot Award.
• PlanSecurityEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the plan should be restricted to some actions or available for all actions.The default value is All actions.
• StartDate: string (date)
  Read Only: true

  Date to start allowing new allocations.
• StartDateText: string
  Read Only: true

  Maximum Length: 30

  Time to delay the start date beyond the projected hire date.

{
    "type":"object",
    "properties":{
        "PlanSecurityEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the plan should be restricted to some actions or available for all actions.The default value is All actions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "maxLength":30,
            "type":"string",
            "description":"Attribute used to indicate whether new proposal is allowed. Valid values are INSERT or Null",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsertAccessCode":{
            "maxLength":30,
            "type":"string",
            "description":"When people can make allocations for the specified access level, such as always or during a specified period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier for the individual compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the plan, such as Spot Award.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date after which new allocations aren't allowed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date to start allowing new allocations.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateText":{
            "maxLength":30,
            "type":"string",
            "description":"Time to delay the start date beyond the projected hire date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionName":{
            "maxLength":320,
            "type":"string",
            "description":"Name of the action, such as Hire or Promote.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Unique identifier of the action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDateText":{
            "maxLength":30,
            "type":"string",
            "description":"Time to delay the end date beyond the projected hire date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier for the legal entity",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Assignment number for the specified assignment.",
            "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"
            }
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date used to find the eligible plans in effect.",
            "format":"date",
            "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